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