- clarify comment about counterintuitive sorting for Laplace.
[ginac.git] / ginac / matrix.cpp
1 /** @file matrix.cpp
2  *
3  *  Implementation of symbolic matrices */
4
5 /*
6  *  GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
7  *
8  *  This program is free software; you can redistribute it and/or modify
9  *  it under the terms of the GNU General Public License as published by
10  *  the Free Software Foundation; either version 2 of the License, or
11  *  (at your option) any later version.
12  *
13  *  This program is distributed in the hope that it will be useful,
14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  *  GNU General Public License for more details.
17  *
18  *  You should have received a copy of the GNU General Public License
19  *  along with this program; if not, write to the Free Software
20  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21  */
22
23 #include <algorithm>
24 #include <map>
25 #include <stdexcept>
26
27 #include "matrix.h"
28 #include "numeric.h"
29 #include "lst.h"
30 #include "idx.h"
31 #include "indexed.h"
32 #include "power.h"
33 #include "symbol.h"
34 #include "normal.h"
35 #include "print.h"
36 #include "archive.h"
37 #include "utils.h"
38 #include "debugmsg.h"
39
40 namespace GiNaC {
41
42 GINAC_IMPLEMENT_REGISTERED_CLASS(matrix, basic)
43
44 //////////
45 // default ctor, dtor, copy ctor, assignment operator and helpers:
46 //////////
47
48 /** Default ctor.  Initializes to 1 x 1-dimensional zero-matrix. */
49 matrix::matrix() : inherited(TINFO_matrix), row(1), col(1)
50 {
51         debugmsg("matrix default ctor",LOGLEVEL_CONSTRUCT);
52         m.push_back(_ex0());
53 }
54
55 void matrix::copy(const matrix & other)
56 {
57         inherited::copy(other);
58         row = other.row;
59         col = other.col;
60         m = other.m;  // STL's vector copying invoked here
61 }
62
63 DEFAULT_DESTROY(matrix)
64
65 //////////
66 // other ctors
67 //////////
68
69 // public
70
71 /** Very common ctor.  Initializes to r x c-dimensional zero-matrix.
72  *
73  *  @param r number of rows
74  *  @param c number of cols */
75 matrix::matrix(unsigned r, unsigned c)
76   : inherited(TINFO_matrix), row(r), col(c)
77 {
78         debugmsg("matrix ctor from unsigned,unsigned",LOGLEVEL_CONSTRUCT);
79         m.resize(r*c, _ex0());
80 }
81
82 // protected
83
84 /** Ctor from representation, for internal use only. */
85 matrix::matrix(unsigned r, unsigned c, const exvector & m2)
86   : inherited(TINFO_matrix), row(r), col(c), m(m2)
87 {
88         debugmsg("matrix ctor from unsigned,unsigned,exvector",LOGLEVEL_CONSTRUCT);
89 }
90
91 /** Construct matrix from (flat) list of elements. If the list has fewer
92  *  elements than the matrix, the remaining matrix elements are set to zero.
93  *  If the list has more elements than the matrix, the excessive elements are
94  *  thrown away. */
95 matrix::matrix(unsigned r, unsigned c, const lst & l)
96   : inherited(TINFO_matrix), row(r), col(c)
97 {
98         debugmsg("matrix ctor from unsigned,unsigned,lst",LOGLEVEL_CONSTRUCT);
99         m.resize(r*c, _ex0());
100
101         for (unsigned i=0; i<l.nops(); i++) {
102                 unsigned x = i % c;
103                 unsigned y = i / c;
104                 if (y >= r)
105                         break; // matrix smaller than list: throw away excessive elements
106                 m[y*c+x] = l.op(i);
107         }
108 }
109
110 //////////
111 // archiving
112 //////////
113
114 matrix::matrix(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
115 {
116         debugmsg("matrix ctor from archive_node", LOGLEVEL_CONSTRUCT);
117         if (!(n.find_unsigned("row", row)) || !(n.find_unsigned("col", col)))
118                 throw (std::runtime_error("unknown matrix dimensions in archive"));
119         m.reserve(row * col);
120         for (unsigned int i=0; true; i++) {
121                 ex e;
122                 if (n.find_ex("m", e, sym_lst, i))
123                         m.push_back(e);
124                 else
125                         break;
126         }
127 }
128
129 void matrix::archive(archive_node &n) const
130 {
131         inherited::archive(n);
132         n.add_unsigned("row", row);
133         n.add_unsigned("col", col);
134         exvector::const_iterator i = m.begin(), iend = m.end();
135         while (i != iend) {
136                 n.add_ex("m", *i);
137                 ++i;
138         }
139 }
140
141 DEFAULT_UNARCHIVE(matrix)
142
143 //////////
144 // functions overriding virtual functions from base classes
145 //////////
146
147 // public
148
149 void matrix::print(const print_context & c, unsigned level) const
150 {
151         debugmsg("matrix print", LOGLEVEL_PRINT);
152
153         if (is_a<print_tree>(c)) {
154
155                 inherited::print(c, level);
156
157         } else {
158
159                 c.s << "[";
160                 for (unsigned y=0; y<row-1; ++y) {
161                         c.s << "[";
162                         for (unsigned x=0; x<col-1; ++x) {
163                                 m[y*col+x].print(c);
164                                 c.s << ",";
165                         }
166                         m[col*(y+1)-1].print(c);
167                         c.s << "],";
168                 }
169                 c.s << "[";
170                 for (unsigned x=0; x<col-1; ++x) {
171                         m[(row-1)*col+x].print(c);
172                         c.s << ",";
173                 }
174                 m[row*col-1].print(c);
175                 c.s << "]]";
176
177         }
178 }
179
180 /** nops is defined to be rows x columns. */
181 unsigned matrix::nops() const
182 {
183         return row*col;
184 }
185
186 /** returns matrix entry at position (i/col, i%col). */
187 ex matrix::op(int i) const
188 {
189         return m[i];
190 }
191
192 /** returns matrix entry at position (i/col, i%col). */
193 ex & matrix::let_op(int i)
194 {
195         GINAC_ASSERT(i>=0);
196         GINAC_ASSERT(i<nops());
197         
198         return m[i];
199 }
200
201 /** Evaluate matrix entry by entry. */
202 ex matrix::eval(int level) const
203 {
204         debugmsg("matrix eval",LOGLEVEL_MEMBER_FUNCTION);
205         
206         // check if we have to do anything at all
207         if ((level==1)&&(flags & status_flags::evaluated))
208                 return *this;
209         
210         // emergency break
211         if (level == -max_recursion_level)
212                 throw (std::runtime_error("matrix::eval(): recursion limit exceeded"));
213         
214         // eval() entry by entry
215         exvector m2(row*col);
216         --level;
217         for (unsigned r=0; r<row; ++r)
218                 for (unsigned c=0; c<col; ++c)
219                         m2[r*col+c] = m[r*col+c].eval(level);
220         
221         return (new matrix(row, col, m2))->setflag(status_flags::dynallocated |
222                                                                                            status_flags::evaluated );
223 }
224
225 ex matrix::subs(const lst & ls, const lst & lr, bool no_pattern) const
226 {
227         exvector m2(row * col);
228         for (unsigned r=0; r<row; ++r)
229                 for (unsigned c=0; c<col; ++c)
230                         m2[r*col+c] = m[r*col+c].subs(ls, lr, no_pattern);
231
232         return matrix(row, col, m2).basic::subs(ls, lr, no_pattern);
233 }
234
235 // protected
236
237 int matrix::compare_same_type(const basic & other) const
238 {
239         GINAC_ASSERT(is_exactly_a<matrix>(other));
240         const matrix &o = static_cast<const matrix &>(other);
241         
242         // compare number of rows
243         if (row != o.rows())
244                 return row < o.rows() ? -1 : 1;
245         
246         // compare number of columns
247         if (col != o.cols())
248                 return col < o.cols() ? -1 : 1;
249         
250         // equal number of rows and columns, compare individual elements
251         int cmpval;
252         for (unsigned r=0; r<row; ++r) {
253                 for (unsigned c=0; c<col; ++c) {
254                         cmpval = ((*this)(r,c)).compare(o(r,c));
255                         if (cmpval!=0) return cmpval;
256                 }
257         }
258         // all elements are equal => matrices are equal;
259         return 0;
260 }
261
262 bool matrix::match_same_type(const basic & other) const
263 {
264         GINAC_ASSERT(is_exactly_a<matrix>(other));
265         const matrix & o = static_cast<const matrix &>(other);
266         
267         // The number of rows and columns must be the same. This is necessary to
268         // prevent a 2x3 matrix from matching a 3x2 one.
269         return row == o.rows() && col == o.cols();
270 }
271
272 /** Automatic symbolic evaluation of an indexed matrix. */
273 ex matrix::eval_indexed(const basic & i) const
274 {
275         GINAC_ASSERT(is_a<indexed>(i));
276         GINAC_ASSERT(is_a<matrix>(i.op(0)));
277
278         bool all_indices_unsigned = static_cast<const indexed &>(i).all_index_values_are(info_flags::nonnegint);
279
280         // Check indices
281         if (i.nops() == 2) {
282
283                 // One index, must be one-dimensional vector
284                 if (row != 1 && col != 1)
285                         throw (std::runtime_error("matrix::eval_indexed(): vector must have exactly 1 index"));
286
287                 const idx & i1 = ex_to<idx>(i.op(1));
288
289                 if (col == 1) {
290
291                         // Column vector
292                         if (!i1.get_dim().is_equal(row))
293                                 throw (std::runtime_error("matrix::eval_indexed(): dimension of index must match number of vector elements"));
294
295                         // Index numeric -> return vector element
296                         if (all_indices_unsigned) {
297                                 unsigned n1 = ex_to<numeric>(i1.get_value()).to_int();
298                                 if (n1 >= row)
299                                         throw (std::runtime_error("matrix::eval_indexed(): value of index exceeds number of vector elements"));
300                                 return (*this)(n1, 0);
301                         }
302
303                 } else {
304
305                         // Row vector
306                         if (!i1.get_dim().is_equal(col))
307                                 throw (std::runtime_error("matrix::eval_indexed(): dimension of index must match number of vector elements"));
308
309                         // Index numeric -> return vector element
310                         if (all_indices_unsigned) {
311                                 unsigned n1 = ex_to<numeric>(i1.get_value()).to_int();
312                                 if (n1 >= col)
313                                         throw (std::runtime_error("matrix::eval_indexed(): value of index exceeds number of vector elements"));
314                                 return (*this)(0, n1);
315                         }
316                 }
317
318         } else if (i.nops() == 3) {
319
320                 // Two indices
321                 const idx & i1 = ex_to<idx>(i.op(1));
322                 const idx & i2 = ex_to<idx>(i.op(2));
323
324                 if (!i1.get_dim().is_equal(row))
325                         throw (std::runtime_error("matrix::eval_indexed(): dimension of first index must match number of rows"));
326                 if (!i2.get_dim().is_equal(col))
327                         throw (std::runtime_error("matrix::eval_indexed(): dimension of second index must match number of columns"));
328
329                 // Pair of dummy indices -> compute trace
330                 if (is_dummy_pair(i1, i2))
331                         return trace();
332
333                 // Both indices numeric -> return matrix element
334                 if (all_indices_unsigned) {
335                         unsigned n1 = ex_to<numeric>(i1.get_value()).to_int(), n2 = ex_to<numeric>(i2.get_value()).to_int();
336                         if (n1 >= row)
337                                 throw (std::runtime_error("matrix::eval_indexed(): value of first index exceeds number of rows"));
338                         if (n2 >= col)
339                                 throw (std::runtime_error("matrix::eval_indexed(): value of second index exceeds number of columns"));
340                         return (*this)(n1, n2);
341                 }
342
343         } else
344                 throw (std::runtime_error("matrix::eval_indexed(): matrix must have exactly 2 indices"));
345
346         return i.hold();
347 }
348
349 /** Sum of two indexed matrices. */
350 ex matrix::add_indexed(const ex & self, const ex & other) const
351 {
352         GINAC_ASSERT(is_a<indexed>(self));
353         GINAC_ASSERT(is_a<matrix>(self.op(0)));
354         GINAC_ASSERT(is_a<indexed>(other));
355         GINAC_ASSERT(self.nops() == 2 || self.nops() == 3);
356
357         // Only add two matrices
358         if (is_ex_of_type(other.op(0), matrix)) {
359                 GINAC_ASSERT(other.nops() == 2 || other.nops() == 3);
360
361                 const matrix &self_matrix = ex_to<matrix>(self.op(0));
362                 const matrix &other_matrix = ex_to<matrix>(other.op(0));
363
364                 if (self.nops() == 2 && other.nops() == 2) { // vector + vector
365
366                         if (self_matrix.row == other_matrix.row)
367                                 return indexed(self_matrix.add(other_matrix), self.op(1));
368                         else if (self_matrix.row == other_matrix.col)
369                                 return indexed(self_matrix.add(other_matrix.transpose()), self.op(1));
370
371                 } else if (self.nops() == 3 && other.nops() == 3) { // matrix + matrix
372
373                         if (self.op(1).is_equal(other.op(1)) && self.op(2).is_equal(other.op(2)))
374                                 return indexed(self_matrix.add(other_matrix), self.op(1), self.op(2));
375                         else if (self.op(1).is_equal(other.op(2)) && self.op(2).is_equal(other.op(1)))
376                                 return indexed(self_matrix.add(other_matrix.transpose()), self.op(1), self.op(2));
377
378                 }
379         }
380
381         // Don't know what to do, return unevaluated sum
382         return self + other;
383 }
384
385 /** Product of an indexed matrix with a number. */
386 ex matrix::scalar_mul_indexed(const ex & self, const numeric & other) const
387 {
388         GINAC_ASSERT(is_a<indexed>(self));
389         GINAC_ASSERT(is_a<matrix>(self.op(0)));
390         GINAC_ASSERT(self.nops() == 2 || self.nops() == 3);
391
392         const matrix &self_matrix = ex_to<matrix>(self.op(0));
393
394         if (self.nops() == 2)
395                 return indexed(self_matrix.mul(other), self.op(1));
396         else // self.nops() == 3
397                 return indexed(self_matrix.mul(other), self.op(1), self.op(2));
398 }
399
400 /** Contraction of an indexed matrix with something else. */
401 bool matrix::contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const
402 {
403         GINAC_ASSERT(is_a<indexed>(*self));
404         GINAC_ASSERT(is_a<indexed>(*other));
405         GINAC_ASSERT(self->nops() == 2 || self->nops() == 3);
406         GINAC_ASSERT(is_a<matrix>(self->op(0)));
407
408         // Only contract with other matrices
409         if (!is_ex_of_type(other->op(0), matrix))
410                 return false;
411
412         GINAC_ASSERT(other->nops() == 2 || other->nops() == 3);
413
414         const matrix &self_matrix = ex_to<matrix>(self->op(0));
415         const matrix &other_matrix = ex_to<matrix>(other->op(0));
416
417         if (self->nops() == 2) {
418
419                 if (other->nops() == 2) { // vector * vector (scalar product)
420
421                         if (self_matrix.col == 1) {
422                                 if (other_matrix.col == 1) {
423                                         // Column vector * column vector, transpose first vector
424                                         *self = self_matrix.transpose().mul(other_matrix)(0, 0);
425                                 } else {
426                                         // Column vector * row vector, swap factors
427                                         *self = other_matrix.mul(self_matrix)(0, 0);
428                                 }
429                         } else {
430                                 if (other_matrix.col == 1) {
431                                         // Row vector * column vector, perfect
432                                         *self = self_matrix.mul(other_matrix)(0, 0);
433                                 } else {
434                                         // Row vector * row vector, transpose second vector
435                                         *self = self_matrix.mul(other_matrix.transpose())(0, 0);
436                                 }
437                         }
438                         *other = _ex1();
439                         return true;
440
441                 } else { // vector * matrix
442
443                         // B_i * A_ij = (B*A)_j (B is row vector)
444                         if (is_dummy_pair(self->op(1), other->op(1))) {
445                                 if (self_matrix.row == 1)
446                                         *self = indexed(self_matrix.mul(other_matrix), other->op(2));
447                                 else
448                                         *self = indexed(self_matrix.transpose().mul(other_matrix), other->op(2));
449                                 *other = _ex1();
450                                 return true;
451                         }
452
453                         // B_j * A_ij = (A*B)_i (B is column vector)
454                         if (is_dummy_pair(self->op(1), other->op(2))) {
455                                 if (self_matrix.col == 1)
456                                         *self = indexed(other_matrix.mul(self_matrix), other->op(1));
457                                 else
458                                         *self = indexed(other_matrix.mul(self_matrix.transpose()), other->op(1));
459                                 *other = _ex1();
460                                 return true;
461                         }
462                 }
463
464         } else if (other->nops() == 3) { // matrix * matrix
465
466                 // A_ij * B_jk = (A*B)_ik
467                 if (is_dummy_pair(self->op(2), other->op(1))) {
468                         *self = indexed(self_matrix.mul(other_matrix), self->op(1), other->op(2));
469                         *other = _ex1();
470                         return true;
471                 }
472
473                 // A_ij * B_kj = (A*Btrans)_ik
474                 if (is_dummy_pair(self->op(2), other->op(2))) {
475                         *self = indexed(self_matrix.mul(other_matrix.transpose()), self->op(1), other->op(1));
476                         *other = _ex1();
477                         return true;
478                 }
479
480                 // A_ji * B_jk = (Atrans*B)_ik
481                 if (is_dummy_pair(self->op(1), other->op(1))) {
482                         *self = indexed(self_matrix.transpose().mul(other_matrix), self->op(2), other->op(2));
483                         *other = _ex1();
484                         return true;
485                 }
486
487                 // A_ji * B_kj = (B*A)_ki
488                 if (is_dummy_pair(self->op(1), other->op(2))) {
489                         *self = indexed(other_matrix.mul(self_matrix), other->op(1), self->op(2));
490                         *other = _ex1();
491                         return true;
492                 }
493         }
494
495         return false;
496 }
497
498
499 //////////
500 // non-virtual functions in this class
501 //////////
502
503 // public
504
505 /** Sum of matrices.
506  *
507  *  @exception logic_error (incompatible matrices) */
508 matrix matrix::add(const matrix & other) const
509 {
510         if (col != other.col || row != other.row)
511                 throw std::logic_error("matrix::add(): incompatible matrices");
512         
513         exvector sum(this->m);
514         exvector::iterator i = sum.begin(), end = sum.end();
515         exvector::const_iterator ci = other.m.begin();
516         while (i != end)
517                 *i++ += *ci++;
518         
519         return matrix(row,col,sum);
520 }
521
522
523 /** Difference of matrices.
524  *
525  *  @exception logic_error (incompatible matrices) */
526 matrix matrix::sub(const matrix & other) const
527 {
528         if (col != other.col || row != other.row)
529                 throw std::logic_error("matrix::sub(): incompatible matrices");
530         
531         exvector dif(this->m);
532         exvector::iterator i = dif.begin(), end = dif.end();
533         exvector::const_iterator ci = other.m.begin();
534         while (i != end)
535                 *i++ -= *ci++;
536         
537         return matrix(row,col,dif);
538 }
539
540
541 /** Product of matrices.
542  *
543  *  @exception logic_error (incompatible matrices) */
544 matrix matrix::mul(const matrix & other) const
545 {
546         if (this->cols() != other.rows())
547                 throw std::logic_error("matrix::mul(): incompatible matrices");
548         
549         exvector prod(this->rows()*other.cols());
550         
551         for (unsigned r1=0; r1<this->rows(); ++r1) {
552                 for (unsigned c=0; c<this->cols(); ++c) {
553                         if (m[r1*col+c].is_zero())
554                                 continue;
555                         for (unsigned r2=0; r2<other.cols(); ++r2)
556                                 prod[r1*other.col+r2] += (m[r1*col+c] * other.m[c*other.col+r2]).expand();
557                 }
558         }
559         return matrix(row, other.col, prod);
560 }
561
562
563 /** Product of matrix and scalar. */
564 matrix matrix::mul(const numeric & other) const
565 {
566         exvector prod(row * col);
567
568         for (unsigned r=0; r<row; ++r)
569                 for (unsigned c=0; c<col; ++c)
570                         prod[r*col+c] = m[r*col+c] * other;
571
572         return matrix(row, col, prod);
573 }
574
575
576 /** Product of matrix and scalar expression. */
577 matrix matrix::mul_scalar(const ex & other) const
578 {
579         if (other.return_type() != return_types::commutative)
580                 throw std::runtime_error("matrix::mul_scalar(): non-commutative scalar");
581
582         exvector prod(row * col);
583
584         for (unsigned r=0; r<row; ++r)
585                 for (unsigned c=0; c<col; ++c)
586                         prod[r*col+c] = m[r*col+c] * other;
587
588         return matrix(row, col, prod);
589 }
590
591
592 /** Power of a matrix.  Currently handles integer exponents only. */
593 matrix matrix::pow(const ex & expn) const
594 {
595         if (col!=row)
596                 throw (std::logic_error("matrix::pow(): matrix not square"));
597         
598         if (is_ex_exactly_of_type(expn, numeric)) {
599                 // Integer cases are computed by successive multiplication, using the
600                 // obvious shortcut of storing temporaries, like A^4 == (A*A)*(A*A).
601                 if (expn.info(info_flags::integer)) {
602                         numeric b = ex_to<numeric>(expn);
603                         matrix A(row,col);
604                         if (expn.info(info_flags::negative)) {
605                                 b *= -1;
606                                 A = this->inverse();
607                         } else {
608                                 A = *this;
609                         }
610                         matrix C(row,col);
611                         for (unsigned r=0; r<row; ++r)
612                                 C(r,r) = _ex1();
613                         // This loop computes the representation of b in base 2 from right
614                         // to left and multiplies the factors whenever needed.  Note
615                         // that this is not entirely optimal but close to optimal and
616                         // "better" algorithms are much harder to implement.  (See Knuth,
617                         // TAoCP2, section "Evaluation of Powers" for a good discussion.)
618                         while (b!=1) {
619                                 if (b.is_odd()) {
620                                         C = C.mul(A);
621                                         b -= 1;
622                                 }
623                                 b *= _num1_2();  // b /= 2, still integer.
624                                 A = A.mul(A);
625                         }
626                         return A.mul(C);
627                 }
628         }
629         throw (std::runtime_error("matrix::pow(): don't know how to handle exponent"));
630 }
631
632
633 /** operator() to access elements for reading.
634  *
635  *  @param ro row of element
636  *  @param co column of element
637  *  @exception range_error (index out of range) */
638 const ex & matrix::operator() (unsigned ro, unsigned co) const
639 {
640         if (ro>=row || co>=col)
641                 throw (std::range_error("matrix::operator(): index out of range"));
642
643         return m[ro*col+co];
644 }
645
646
647 /** operator() to access elements for writing.
648  *
649  *  @param ro row of element
650  *  @param co column of element
651  *  @exception range_error (index out of range) */
652 ex & matrix::operator() (unsigned ro, unsigned co)
653 {
654         if (ro>=row || co>=col)
655                 throw (std::range_error("matrix::operator(): index out of range"));
656
657         ensure_if_modifiable();
658         return m[ro*col+co];
659 }
660
661
662 /** Transposed of an m x n matrix, producing a new n x m matrix object that
663  *  represents the transposed. */
664 matrix matrix::transpose(void) const
665 {
666         exvector trans(this->cols()*this->rows());
667         
668         for (unsigned r=0; r<this->cols(); ++r)
669                 for (unsigned c=0; c<this->rows(); ++c)
670                         trans[r*this->rows()+c] = m[c*this->cols()+r];
671         
672         return matrix(this->cols(),this->rows(),trans);
673 }
674
675 /** Determinant of square matrix.  This routine doesn't actually calculate the
676  *  determinant, it only implements some heuristics about which algorithm to
677  *  run.  If all the elements of the matrix are elements of an integral domain
678  *  the determinant is also in that integral domain and the result is expanded
679  *  only.  If one or more elements are from a quotient field the determinant is
680  *  usually also in that quotient field and the result is normalized before it
681  *  is returned.  This implies that the determinant of the symbolic 2x2 matrix
682  *  [[a/(a-b),1],[b/(a-b),1]] is returned as unity.  (In this respect, it
683  *  behaves like MapleV and unlike Mathematica.)
684  *
685  *  @param     algo allows to chose an algorithm
686  *  @return    the determinant as a new expression
687  *  @exception logic_error (matrix not square)
688  *  @see       determinant_algo */
689 ex matrix::determinant(unsigned algo) const
690 {
691         if (row!=col)
692                 throw (std::logic_error("matrix::determinant(): matrix not square"));
693         GINAC_ASSERT(row*col==m.capacity());
694         
695         // Gather some statistical information about this matrix:
696         bool numeric_flag = true;
697         bool normal_flag = false;
698         unsigned sparse_count = 0;  // counts non-zero elements
699         exvector::const_iterator r = m.begin(), rend = m.end();
700         while (r != rend) {
701                 lst srl;  // symbol replacement list
702                 ex rtest = r->to_rational(srl);
703                 if (!rtest.is_zero())
704                         ++sparse_count;
705                 if (!rtest.info(info_flags::numeric))
706                         numeric_flag = false;
707                 if (!rtest.info(info_flags::crational_polynomial) &&
708                          rtest.info(info_flags::rational_function))
709                         normal_flag = true;
710                 ++r;
711         }
712         
713         // Here is the heuristics in case this routine has to decide:
714         if (algo == determinant_algo::automatic) {
715                 // Minor expansion is generally a good guess:
716                 algo = determinant_algo::laplace;
717                 // Does anybody know when a matrix is really sparse?
718                 // Maybe <~row/2.236 nonzero elements average in a row?
719                 if (row>3 && 5*sparse_count<=row*col)
720                         algo = determinant_algo::bareiss;
721                 // Purely numeric matrix can be handled by Gauss elimination.
722                 // This overrides any prior decisions.
723                 if (numeric_flag)
724                         algo = determinant_algo::gauss;
725         }
726         
727         // Trap the trivial case here, since some algorithms don't like it
728         if (this->row==1) {
729                 // for consistency with non-trivial determinants...
730                 if (normal_flag)
731                         return m[0].normal();
732                 else
733                         return m[0].expand();
734         }
735         
736         // Compute the determinant
737         switch(algo) {
738                 case determinant_algo::gauss: {
739                         ex det = 1;
740                         matrix tmp(*this);
741                         int sign = tmp.gauss_elimination(true);
742                         for (unsigned d=0; d<row; ++d)
743                                 det *= tmp.m[d*col+d];
744                         if (normal_flag)
745                                 return (sign*det).normal();
746                         else
747                                 return (sign*det).normal().expand();
748                 }
749                 case determinant_algo::bareiss: {
750                         matrix tmp(*this);
751                         int sign;
752                         sign = tmp.fraction_free_elimination(true);
753                         if (normal_flag)
754                                 return (sign*tmp.m[row*col-1]).normal();
755                         else
756                                 return (sign*tmp.m[row*col-1]).expand();
757                 }
758                 case determinant_algo::divfree: {
759                         matrix tmp(*this);
760                         int sign;
761                         sign = tmp.division_free_elimination(true);
762                         if (sign==0)
763                                 return _ex0();
764                         ex det = tmp.m[row*col-1];
765                         // factor out accumulated bogus slag
766                         for (unsigned d=0; d<row-2; ++d)
767                                 for (unsigned j=0; j<row-d-2; ++j)
768                                         det = (det/tmp.m[d*col+d]).normal();
769                         return (sign*det);
770                 }
771                 case determinant_algo::laplace:
772                 default: {
773                         // This is the minor expansion scheme.  We always develop such
774                         // that the smallest minors (i.e, the trivial 1x1 ones) are on the
775                         // rightmost column.  For this to be efficient, empirical tests
776                         // have shown that the emptiest columns (i.e. the ones with most
777                         // zeros) should be the ones on the right hand side -- although
778                         // this might seem counter-intuitive (and in contradiction to some
779                         // literature like the FORM manual).  Please go ahead and test it
780                         // if you don't believe me!  Therefore we presort the columns of
781                         // the matrix:
782                         typedef std::pair<unsigned,unsigned> uintpair;
783                         std::vector<uintpair> c_zeros;  // number of zeros in column
784                         for (unsigned c=0; c<col; ++c) {
785                                 unsigned acc = 0;
786                                 for (unsigned r=0; r<row; ++r)
787                                         if (m[r*col+c].is_zero())
788                                                 ++acc;
789                                 c_zeros.push_back(uintpair(acc,c));
790                         }
791                         sort(c_zeros.begin(),c_zeros.end());
792                         std::vector<unsigned> pre_sort;
793                         for (std::vector<uintpair>::const_iterator i=c_zeros.begin(); i!=c_zeros.end(); ++i)
794                                 pre_sort.push_back(i->second);
795                         std::vector<unsigned> pre_sort_test(pre_sort); // permutation_sign() modifies the vector so we make a copy here
796                         int sign = permutation_sign(pre_sort_test.begin(), pre_sort_test.end());
797                         exvector result(row*col);  // represents sorted matrix
798                         unsigned c = 0;
799                         for (std::vector<unsigned>::const_iterator i=pre_sort.begin();
800                                  i!=pre_sort.end();
801                                  ++i,++c) {
802                                 for (unsigned r=0; r<row; ++r)
803                                         result[r*col+c] = m[r*col+(*i)];
804                         }
805                         
806                         if (normal_flag)
807                                 return (sign*matrix(row,col,result).determinant_minor()).normal();
808                         else
809                                 return sign*matrix(row,col,result).determinant_minor();
810                 }
811         }
812 }
813
814
815 /** Trace of a matrix.  The result is normalized if it is in some quotient
816  *  field and expanded only otherwise.  This implies that the trace of the
817  *  symbolic 2x2 matrix [[a/(a-b),x],[y,b/(b-a)]] is recognized to be unity.
818  *
819  *  @return    the sum of diagonal elements
820  *  @exception logic_error (matrix not square) */
821 ex matrix::trace(void) const
822 {
823         if (row != col)
824                 throw (std::logic_error("matrix::trace(): matrix not square"));
825         
826         ex tr;
827         for (unsigned r=0; r<col; ++r)
828                 tr += m[r*col+r];
829         
830         if (tr.info(info_flags::rational_function) &&
831                 !tr.info(info_flags::crational_polynomial))
832                 return tr.normal();
833         else
834                 return tr.expand();
835 }
836
837
838 /** Characteristic Polynomial.  Following mathematica notation the
839  *  characteristic polynomial of a matrix M is defined as the determiant of
840  *  (M - lambda * 1) where 1 stands for the unit matrix of the same dimension
841  *  as M.  Note that some CASs define it with a sign inside the determinant
842  *  which gives rise to an overall sign if the dimension is odd.  This method
843  *  returns the characteristic polynomial collected in powers of lambda as a
844  *  new expression.
845  *
846  *  @return    characteristic polynomial as new expression
847  *  @exception logic_error (matrix not square)
848  *  @see       matrix::determinant() */
849 ex matrix::charpoly(const symbol & lambda) const
850 {
851         if (row != col)
852                 throw (std::logic_error("matrix::charpoly(): matrix not square"));
853         
854         bool numeric_flag = true;
855         exvector::const_iterator r = m.begin(), rend = m.end();
856         while (r!=rend && numeric_flag==true) {
857                 if (!r->info(info_flags::numeric))
858                         numeric_flag = false;
859                 ++r;
860         }
861         
862         // The pure numeric case is traditionally rather common.  Hence, it is
863         // trapped and we use Leverrier's algorithm which goes as row^3 for
864         // every coefficient.  The expensive part is the matrix multiplication.
865         if (numeric_flag) {
866                 matrix B(*this);
867                 ex c = B.trace();
868                 ex poly = power(lambda,row)-c*power(lambda,row-1);
869                 for (unsigned i=1; i<row; ++i) {
870                         for (unsigned j=0; j<row; ++j)
871                                 B.m[j*col+j] -= c;
872                         B = this->mul(B);
873                         c = B.trace()/ex(i+1);
874                         poly -= c*power(lambda,row-i-1);
875                 }
876                 if (row%2)
877                         return -poly;
878                 else
879                         return poly;
880         }
881         
882         matrix M(*this);
883         for (unsigned r=0; r<col; ++r)
884                 M.m[r*col+r] -= lambda;
885         
886         return M.determinant().collect(lambda);
887 }
888
889
890 /** Inverse of this matrix.
891  *
892  *  @return    the inverted matrix
893  *  @exception logic_error (matrix not square)
894  *  @exception runtime_error (singular matrix) */
895 matrix matrix::inverse(void) const
896 {
897         if (row != col)
898                 throw (std::logic_error("matrix::inverse(): matrix not square"));
899         
900         // This routine actually doesn't do anything fancy at all.  We compute the
901         // inverse of the matrix A by solving the system A * A^{-1} == Id.
902         
903         // First populate the identity matrix supposed to become the right hand side.
904         matrix identity(row,col);
905         for (unsigned i=0; i<row; ++i)
906                 identity(i,i) = _ex1();
907         
908         // Populate a dummy matrix of variables, just because of compatibility with
909         // matrix::solve() which wants this (for compatibility with under-determined
910         // systems of equations).
911         matrix vars(row,col);
912         for (unsigned r=0; r<row; ++r)
913                 for (unsigned c=0; c<col; ++c)
914                         vars(r,c) = symbol();
915         
916         matrix sol(row,col);
917         try {
918                 sol = this->solve(vars,identity);
919         } catch (const std::runtime_error & e) {
920             if (e.what()==std::string("matrix::solve(): inconsistent linear system"))
921                         throw (std::runtime_error("matrix::inverse(): singular matrix"));
922                 else
923                         throw;
924         }
925         return sol;
926 }
927
928
929 /** Solve a linear system consisting of a m x n matrix and a m x p right hand
930  *  side by applying an elimination scheme to the augmented matrix.
931  *
932  *  @param vars n x p matrix, all elements must be symbols 
933  *  @param rhs m x p matrix
934  *  @return n x p solution matrix
935  *  @exception logic_error (incompatible matrices)
936  *  @exception invalid_argument (1st argument must be matrix of symbols)
937  *  @exception runtime_error (inconsistent linear system)
938  *  @see       solve_algo */
939 matrix matrix::solve(const matrix & vars,
940                                          const matrix & rhs,
941                                          unsigned algo) const
942 {
943         const unsigned m = this->rows();
944         const unsigned n = this->cols();
945         const unsigned p = rhs.cols();
946         
947         // syntax checks    
948         if ((rhs.rows() != m) || (vars.rows() != n) || (vars.col != p))
949                 throw (std::logic_error("matrix::solve(): incompatible matrices"));
950         for (unsigned ro=0; ro<n; ++ro)
951                 for (unsigned co=0; co<p; ++co)
952                         if (!vars(ro,co).info(info_flags::symbol))
953                                 throw (std::invalid_argument("matrix::solve(): 1st argument must be matrix of symbols"));
954         
955         // build the augmented matrix of *this with rhs attached to the right
956         matrix aug(m,n+p);
957         for (unsigned r=0; r<m; ++r) {
958                 for (unsigned c=0; c<n; ++c)
959                         aug.m[r*(n+p)+c] = this->m[r*n+c];
960                 for (unsigned c=0; c<p; ++c)
961                         aug.m[r*(n+p)+c+n] = rhs.m[r*p+c];
962         }
963         
964         // Gather some statistical information about the augmented matrix:
965         bool numeric_flag = true;
966         exvector::const_iterator r = aug.m.begin(), rend = aug.m.end();
967         while (r!=rend && numeric_flag==true) {
968                 if (!r->info(info_flags::numeric))
969                         numeric_flag = false;
970                 ++r;
971         }
972         
973         // Here is the heuristics in case this routine has to decide:
974         if (algo == solve_algo::automatic) {
975                 // Bareiss (fraction-free) elimination is generally a good guess:
976                 algo = solve_algo::bareiss;
977                 // For m<3, Bareiss elimination is equivalent to division free
978                 // elimination but has more logistic overhead
979                 if (m<3)
980                         algo = solve_algo::divfree;
981                 // This overrides any prior decisions.
982                 if (numeric_flag)
983                         algo = solve_algo::gauss;
984         }
985         
986         // Eliminate the augmented matrix:
987         switch(algo) {
988                 case solve_algo::gauss:
989                         aug.gauss_elimination();
990                         break;
991                 case solve_algo::divfree:
992                         aug.division_free_elimination();
993                         break;
994                 case solve_algo::bareiss:
995                 default:
996                         aug.fraction_free_elimination();
997         }
998         
999         // assemble the solution matrix:
1000         matrix sol(n,p);
1001         for (unsigned co=0; co<p; ++co) {
1002                 unsigned last_assigned_sol = n+1;
1003                 for (int r=m-1; r>=0; --r) {
1004                         unsigned fnz = 1;    // first non-zero in row
1005                         while ((fnz<=n) && (aug.m[r*(n+p)+(fnz-1)].is_zero()))
1006                                 ++fnz;
1007                         if (fnz>n) {
1008                                 // row consists only of zeros, corresponding rhs must be 0, too
1009                                 if (!aug.m[r*(n+p)+n+co].is_zero()) {
1010                                         throw (std::runtime_error("matrix::solve(): inconsistent linear system"));
1011                                 }
1012                         } else {
1013                                 // assign solutions for vars between fnz+1 and
1014                                 // last_assigned_sol-1: free parameters
1015                                 for (unsigned c=fnz; c<last_assigned_sol-1; ++c)
1016                                         sol(c,co) = vars.m[c*p+co];
1017                                 ex e = aug.m[r*(n+p)+n+co];
1018                                 for (unsigned c=fnz; c<n; ++c)
1019                                         e -= aug.m[r*(n+p)+c]*sol.m[c*p+co];
1020                                 sol(fnz-1,co) = (e/(aug.m[r*(n+p)+(fnz-1)])).normal();
1021                                 last_assigned_sol = fnz;
1022                         }
1023                 }
1024                 // assign solutions for vars between 1 and
1025                 // last_assigned_sol-1: free parameters
1026                 for (unsigned ro=0; ro<last_assigned_sol-1; ++ro)
1027                         sol(ro,co) = vars(ro,co);
1028         }
1029         
1030         return sol;
1031 }
1032
1033
1034 // protected
1035
1036 /** Recursive determinant for small matrices having at least one symbolic
1037  *  entry.  The basic algorithm, known as Laplace-expansion, is enhanced by
1038  *  some bookkeeping to avoid calculation of the same submatrices ("minors")
1039  *  more than once.  According to W.M.Gentleman and S.C.Johnson this algorithm
1040  *  is better than elimination schemes for matrices of sparse multivariate
1041  *  polynomials and also for matrices of dense univariate polynomials if the
1042  *  matrix' dimesion is larger than 7.
1043  *
1044  *  @return the determinant as a new expression (in expanded form)
1045  *  @see matrix::determinant() */
1046 ex matrix::determinant_minor(void) const
1047 {
1048         // for small matrices the algorithm does not make any sense:
1049         const unsigned n = this->cols();
1050         if (n==1)
1051                 return m[0].expand();
1052         if (n==2)
1053                 return (m[0]*m[3]-m[2]*m[1]).expand();
1054         if (n==3)
1055                 return (m[0]*m[4]*m[8]-m[0]*m[5]*m[7]-
1056                         m[1]*m[3]*m[8]+m[2]*m[3]*m[7]+
1057                         m[1]*m[5]*m[6]-m[2]*m[4]*m[6]).expand();
1058         
1059         // This algorithm can best be understood by looking at a naive
1060         // implementation of Laplace-expansion, like this one:
1061         // ex det;
1062         // matrix minorM(this->rows()-1,this->cols()-1);
1063         // for (unsigned r1=0; r1<this->rows(); ++r1) {
1064         //     // shortcut if element(r1,0) vanishes
1065         //     if (m[r1*col].is_zero())
1066         //         continue;
1067         //     // assemble the minor matrix
1068         //     for (unsigned r=0; r<minorM.rows(); ++r) {
1069         //         for (unsigned c=0; c<minorM.cols(); ++c) {
1070         //             if (r<r1)
1071         //                 minorM(r,c) = m[r*col+c+1];
1072         //             else
1073         //                 minorM(r,c) = m[(r+1)*col+c+1];
1074         //         }
1075         //     }
1076         //     // recurse down and care for sign:
1077         //     if (r1%2)
1078         //         det -= m[r1*col] * minorM.determinant_minor();
1079         //     else
1080         //         det += m[r1*col] * minorM.determinant_minor();
1081         // }
1082         // return det.expand();
1083         // What happens is that while proceeding down many of the minors are
1084         // computed more than once.  In particular, there are binomial(n,k)
1085         // kxk minors and each one is computed factorial(n-k) times.  Therefore
1086         // it is reasonable to store the results of the minors.  We proceed from
1087         // right to left.  At each column c we only need to retrieve the minors
1088         // calculated in step c-1.  We therefore only have to store at most 
1089         // 2*binomial(n,n/2) minors.
1090         
1091         // Unique flipper counter for partitioning into minors
1092         std::vector<unsigned> Pkey;
1093         Pkey.reserve(n);
1094         // key for minor determinant (a subpartition of Pkey)
1095         std::vector<unsigned> Mkey;
1096         Mkey.reserve(n-1);
1097         // we store our subminors in maps, keys being the rows they arise from
1098         typedef std::map<std::vector<unsigned>,class ex> Rmap;
1099         typedef std::map<std::vector<unsigned>,class ex>::value_type Rmap_value;
1100         Rmap A;
1101         Rmap B;
1102         ex det;
1103         // initialize A with last column:
1104         for (unsigned r=0; r<n; ++r) {
1105                 Pkey.erase(Pkey.begin(),Pkey.end());
1106                 Pkey.push_back(r);
1107                 A.insert(Rmap_value(Pkey,m[n*(r+1)-1]));
1108         }
1109         // proceed from right to left through matrix
1110         for (int c=n-2; c>=0; --c) {
1111                 Pkey.erase(Pkey.begin(),Pkey.end());  // don't change capacity
1112                 Mkey.erase(Mkey.begin(),Mkey.end());
1113                 for (unsigned i=0; i<n-c; ++i)
1114                         Pkey.push_back(i);
1115                 unsigned fc = 0;  // controls logic for our strange flipper counter
1116                 do {
1117                         det = _ex0();
1118                         for (unsigned r=0; r<n-c; ++r) {
1119                                 // maybe there is nothing to do?
1120                                 if (m[Pkey[r]*n+c].is_zero())
1121                                         continue;
1122                                 // create the sorted key for all possible minors
1123                                 Mkey.erase(Mkey.begin(),Mkey.end());
1124                                 for (unsigned i=0; i<n-c; ++i)
1125                                         if (i!=r)
1126                                                 Mkey.push_back(Pkey[i]);
1127                                 // Fetch the minors and compute the new determinant
1128                                 if (r%2)
1129                                         det -= m[Pkey[r]*n+c]*A[Mkey];
1130                                 else
1131                                         det += m[Pkey[r]*n+c]*A[Mkey];
1132                         }
1133                         // prevent build-up of deep nesting of expressions saves time:
1134                         det = det.expand();
1135                         // store the new determinant at its place in B:
1136                         if (!det.is_zero())
1137                                 B.insert(Rmap_value(Pkey,det));
1138                         // increment our strange flipper counter
1139                         for (fc=n-c; fc>0; --fc) {
1140                                 ++Pkey[fc-1];
1141                                 if (Pkey[fc-1]<fc+c)
1142                                         break;
1143                         }
1144                         if (fc<n-c && fc>0)
1145                                 for (unsigned j=fc; j<n-c; ++j)
1146                                         Pkey[j] = Pkey[j-1]+1;
1147                 } while(fc);
1148                 // next column, so change the role of A and B:
1149                 A = B;
1150                 B.clear();
1151         }
1152         
1153         return det;
1154 }
1155
1156
1157 /** Perform the steps of an ordinary Gaussian elimination to bring the m x n
1158  *  matrix into an upper echelon form.  The algorithm is ok for matrices
1159  *  with numeric coefficients but quite unsuited for symbolic matrices.
1160  *
1161  *  @param det may be set to true to save a lot of space if one is only
1162  *  interested in the diagonal elements (i.e. for calculating determinants).
1163  *  The others are set to zero in this case.
1164  *  @return sign is 1 if an even number of rows was swapped, -1 if an odd
1165  *  number of rows was swapped and 0 if the matrix is singular. */
1166 int matrix::gauss_elimination(const bool det)
1167 {
1168         ensure_if_modifiable();
1169         const unsigned m = this->rows();
1170         const unsigned n = this->cols();
1171         GINAC_ASSERT(!det || n==m);
1172         int sign = 1;
1173         
1174         unsigned r0 = 0;
1175         for (unsigned r1=0; (r1<n-1)&&(r0<m-1); ++r1) {
1176                 int indx = pivot(r0, r1, true);
1177                 if (indx == -1) {
1178                         sign = 0;
1179                         if (det)
1180                                 return 0;  // leaves *this in a messy state
1181                 }
1182                 if (indx>=0) {
1183                         if (indx > 0)
1184                                 sign = -sign;
1185                         for (unsigned r2=r0+1; r2<m; ++r2) {
1186                                 if (!this->m[r2*n+r1].is_zero()) {
1187                                         // yes, there is something to do in this row
1188                                         ex piv = this->m[r2*n+r1] / this->m[r0*n+r1];
1189                                         for (unsigned c=r1+1; c<n; ++c) {
1190                                                 this->m[r2*n+c] -= piv * this->m[r0*n+c];
1191                                                 if (!this->m[r2*n+c].info(info_flags::numeric))
1192                                                         this->m[r2*n+c] = this->m[r2*n+c].normal();
1193                                         }
1194                                 }
1195                                 // fill up left hand side with zeros
1196                                 for (unsigned c=0; c<=r1; ++c)
1197                                         this->m[r2*n+c] = _ex0();
1198                         }
1199                         if (det) {
1200                                 // save space by deleting no longer needed elements
1201                                 for (unsigned c=r0+1; c<n; ++c)
1202                                         this->m[r0*n+c] = _ex0();
1203                         }
1204                         ++r0;
1205                 }
1206         }
1207         
1208         return sign;
1209 }
1210
1211
1212 /** Perform the steps of division free elimination to bring the m x n matrix
1213  *  into an upper echelon form.
1214  *
1215  *  @param det may be set to true to save a lot of space if one is only
1216  *  interested in the diagonal elements (i.e. for calculating determinants).
1217  *  The others are set to zero in this case.
1218  *  @return sign is 1 if an even number of rows was swapped, -1 if an odd
1219  *  number of rows was swapped and 0 if the matrix is singular. */
1220 int matrix::division_free_elimination(const bool det)
1221 {
1222         ensure_if_modifiable();
1223         const unsigned m = this->rows();
1224         const unsigned n = this->cols();
1225         GINAC_ASSERT(!det || n==m);
1226         int sign = 1;
1227         
1228         unsigned r0 = 0;
1229         for (unsigned r1=0; (r1<n-1)&&(r0<m-1); ++r1) {
1230                 int indx = pivot(r0, r1, true);
1231                 if (indx==-1) {
1232                         sign = 0;
1233                         if (det)
1234                                 return 0;  // leaves *this in a messy state
1235                 }
1236                 if (indx>=0) {
1237                         if (indx>0)
1238                                 sign = -sign;
1239                         for (unsigned r2=r0+1; r2<m; ++r2) {
1240                                 for (unsigned c=r1+1; c<n; ++c)
1241                                         this->m[r2*n+c] = (this->m[r0*n+r1]*this->m[r2*n+c] - this->m[r2*n+r1]*this->m[r0*n+c]).expand();
1242                                 // fill up left hand side with zeros
1243                                 for (unsigned c=0; c<=r1; ++c)
1244                                         this->m[r2*n+c] = _ex0();
1245                         }
1246                         if (det) {
1247                                 // save space by deleting no longer needed elements
1248                                 for (unsigned c=r0+1; c<n; ++c)
1249                                         this->m[r0*n+c] = _ex0();
1250                         }
1251                         ++r0;
1252                 }
1253         }
1254         
1255         return sign;
1256 }
1257
1258
1259 /** Perform the steps of Bareiss' one-step fraction free elimination to bring
1260  *  the matrix into an upper echelon form.  Fraction free elimination means
1261  *  that divide is used straightforwardly, without computing GCDs first.  This
1262  *  is possible, since we know the divisor at each step.
1263  *  
1264  *  @param det may be set to true to save a lot of space if one is only
1265  *  interested in the last element (i.e. for calculating determinants). The
1266  *  others are set to zero in this case.
1267  *  @return sign is 1 if an even number of rows was swapped, -1 if an odd
1268  *  number of rows was swapped and 0 if the matrix is singular. */
1269 int matrix::fraction_free_elimination(const bool det)
1270 {
1271         // Method:
1272         // (single-step fraction free elimination scheme, already known to Jordan)
1273         //
1274         // Usual division-free elimination sets m[0](r,c) = m(r,c) and then sets
1275         //     m[k+1](r,c) = m[k](k,k) * m[k](r,c) - m[k](r,k) * m[k](k,c).
1276         //
1277         // Bareiss (fraction-free) elimination in addition divides that element
1278         // by m[k-1](k-1,k-1) for k>1, where it can be shown by means of the
1279         // Sylvester determinant that this really divides m[k+1](r,c).
1280         //
1281         // We also allow rational functions where the original prove still holds.
1282         // However, we must care for numerator and denominator separately and
1283         // "manually" work in the integral domains because of subtle cancellations
1284         // (see below).  This blows up the bookkeeping a bit and the formula has
1285         // to be modified to expand like this (N{x} stands for numerator of x,
1286         // D{x} for denominator of x):
1287         //     N{m[k+1](r,c)} = N{m[k](k,k)}*N{m[k](r,c)}*D{m[k](r,k)}*D{m[k](k,c)}
1288         //                     -N{m[k](r,k)}*N{m[k](k,c)}*D{m[k](k,k)}*D{m[k](r,c)}
1289         //     D{m[k+1](r,c)} = D{m[k](k,k)}*D{m[k](r,c)}*D{m[k](r,k)}*D{m[k](k,c)}
1290         // where for k>1 we now divide N{m[k+1](r,c)} by
1291         //     N{m[k-1](k-1,k-1)}
1292         // and D{m[k+1](r,c)} by
1293         //     D{m[k-1](k-1,k-1)}.
1294         
1295         ensure_if_modifiable();
1296         const unsigned m = this->rows();
1297         const unsigned n = this->cols();
1298         GINAC_ASSERT(!det || n==m);
1299         int sign = 1;
1300         if (m==1)
1301                 return 1;
1302         ex divisor_n = 1;
1303         ex divisor_d = 1;
1304         ex dividend_n;
1305         ex dividend_d;
1306         
1307         // We populate temporary matrices to subsequently operate on.  There is
1308         // one holding numerators and another holding denominators of entries.
1309         // This is a must since the evaluator (or even earlier mul's constructor)
1310         // might cancel some trivial element which causes divide() to fail.  The
1311         // elements are normalized first (yes, even though this algorithm doesn't
1312         // need GCDs) since the elements of *this might be unnormalized, which
1313         // makes things more complicated than they need to be.
1314         matrix tmp_n(*this);
1315         matrix tmp_d(m,n);  // for denominators, if needed
1316         lst srl;  // symbol replacement list
1317         exvector::const_iterator cit = this->m.begin(), citend = this->m.end();
1318         exvector::iterator tmp_n_it = tmp_n.m.begin(), tmp_d_it = tmp_d.m.begin();
1319         while (cit != citend) {
1320                 ex nd = cit->normal().to_rational(srl).numer_denom();
1321                 ++cit;
1322                 *tmp_n_it++ = nd.op(0);
1323                 *tmp_d_it++ = nd.op(1);
1324         }
1325         
1326         unsigned r0 = 0;
1327         for (unsigned r1=0; (r1<n-1)&&(r0<m-1); ++r1) {
1328                 int indx = tmp_n.pivot(r0, r1, true);
1329                 if (indx==-1) {
1330                         sign = 0;
1331                         if (det)
1332                                 return 0;
1333                 }
1334                 if (indx>=0) {
1335                         if (indx>0) {
1336                                 sign = -sign;
1337                                 // tmp_n's rows r0 and indx were swapped, do the same in tmp_d:
1338                                 for (unsigned c=r1; c<n; ++c)
1339                                         tmp_d.m[n*indx+c].swap(tmp_d.m[n*r0+c]);
1340                         }
1341                         for (unsigned r2=r0+1; r2<m; ++r2) {
1342                                 for (unsigned c=r1+1; c<n; ++c) {
1343                                         dividend_n = (tmp_n.m[r0*n+r1]*tmp_n.m[r2*n+c]*
1344                                                       tmp_d.m[r2*n+r1]*tmp_d.m[r0*n+c]
1345                                                      -tmp_n.m[r2*n+r1]*tmp_n.m[r0*n+c]*
1346                                                       tmp_d.m[r0*n+r1]*tmp_d.m[r2*n+c]).expand();
1347                                         dividend_d = (tmp_d.m[r2*n+r1]*tmp_d.m[r0*n+c]*
1348                                                       tmp_d.m[r0*n+r1]*tmp_d.m[r2*n+c]).expand();
1349                                         bool check = divide(dividend_n, divisor_n,
1350                                                             tmp_n.m[r2*n+c], true);
1351                                         check &= divide(dividend_d, divisor_d,
1352                                                         tmp_d.m[r2*n+c], true);
1353                                         GINAC_ASSERT(check);
1354                                 }
1355                                 // fill up left hand side with zeros
1356                                 for (unsigned c=0; c<=r1; ++c)
1357                                         tmp_n.m[r2*n+c] = _ex0();
1358                         }
1359                         if ((r1<n-1)&&(r0<m-1)) {
1360                                 // compute next iteration's divisor
1361                                 divisor_n = tmp_n.m[r0*n+r1].expand();
1362                                 divisor_d = tmp_d.m[r0*n+r1].expand();
1363                                 if (det) {
1364                                         // save space by deleting no longer needed elements
1365                                         for (unsigned c=0; c<n; ++c) {
1366                                                 tmp_n.m[r0*n+c] = _ex0();
1367                                                 tmp_d.m[r0*n+c] = _ex1();
1368                                         }
1369                                 }
1370                         }
1371                         ++r0;
1372                 }
1373         }
1374         // repopulate *this matrix:
1375         exvector::iterator it = this->m.begin(), itend = this->m.end();
1376         tmp_n_it = tmp_n.m.begin();
1377         tmp_d_it = tmp_d.m.begin();
1378         while (it != itend)
1379                 *it++ = ((*tmp_n_it++)/(*tmp_d_it++)).subs(srl);
1380         
1381         return sign;
1382 }
1383
1384
1385 /** Partial pivoting method for matrix elimination schemes.
1386  *  Usual pivoting (symbolic==false) returns the index to the element with the
1387  *  largest absolute value in column ro and swaps the current row with the one
1388  *  where the element was found.  With (symbolic==true) it does the same thing
1389  *  with the first non-zero element.
1390  *
1391  *  @param ro is the row from where to begin
1392  *  @param co is the column to be inspected
1393  *  @param symbolic signal if we want the first non-zero element to be pivoted
1394  *  (true) or the one with the largest absolute value (false).
1395  *  @return 0 if no interchange occured, -1 if all are zero (usually signaling
1396  *  a degeneracy) and positive integer k means that rows ro and k were swapped.
1397  */
1398 int matrix::pivot(unsigned ro, unsigned co, bool symbolic)
1399 {
1400         unsigned k = ro;
1401         if (symbolic) {
1402                 // search first non-zero element in column co beginning at row ro
1403                 while ((k<row) && (this->m[k*col+co].expand().is_zero()))
1404                         ++k;
1405         } else {
1406                 // search largest element in column co beginning at row ro
1407                 GINAC_ASSERT(is_a<numeric>(this->m[k*col+co]));
1408                 unsigned kmax = k+1;
1409                 numeric mmax = abs(ex_to<numeric>(m[kmax*col+co]));
1410                 while (kmax<row) {
1411                         GINAC_ASSERT(is_a<numeric>(this->m[kmax*col+co]));
1412                         numeric tmp = ex_to<numeric>(this->m[kmax*col+co]);
1413                         if (abs(tmp) > mmax) {
1414                                 mmax = tmp;
1415                                 k = kmax;
1416                         }
1417                         ++kmax;
1418                 }
1419                 if (!mmax.is_zero())
1420                         k = kmax;
1421         }
1422         if (k==row)
1423                 // all elements in column co below row ro vanish
1424                 return -1;
1425         if (k==ro)
1426                 // matrix needs no pivoting
1427                 return 0;
1428         // matrix needs pivoting, so swap rows k and ro
1429         ensure_if_modifiable();
1430         for (unsigned c=0; c<col; ++c)
1431                 this->m[k*col+c].swap(this->m[ro*col+c]);
1432         
1433         return k;
1434 }
1435
1436 ex lst_to_matrix(const lst & l)
1437 {
1438         // Find number of rows and columns
1439         unsigned rows = l.nops(), cols = 0, i, j;
1440         for (i=0; i<rows; i++)
1441                 if (l.op(i).nops() > cols)
1442                         cols = l.op(i).nops();
1443
1444         // Allocate and fill matrix
1445         matrix &m = *new matrix(rows, cols);
1446         m.setflag(status_flags::dynallocated);
1447         for (i=0; i<rows; i++)
1448                 for (j=0; j<cols; j++)
1449                         if (l.op(i).nops() > j)
1450                                 m(i, j) = l.op(i).op(j);
1451                         else
1452                                 m(i, j) = _ex0();
1453         return m;
1454 }
1455
1456 ex diag_matrix(const lst & l)
1457 {
1458         unsigned dim = l.nops();
1459
1460         matrix &m = *new matrix(dim, dim);
1461         m.setflag(status_flags::dynallocated);
1462         for (unsigned i=0; i<dim; i++)
1463                 m(i, i) = l.op(i);
1464
1465         return m;
1466 }
1467
1468 } // namespace GiNaC