- As advertised: we are calling the Gamma function tgamma() now!
[ginac.git] / ginac / matrix.cpp
1 /** @file matrix.cpp
2  *
3  *  Implementation of symbolic matrices */
4
5 /*
6  *  GiNaC Copyright (C) 1999-2000 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 "archive.h"
29 #include "utils.h"
30 #include "debugmsg.h"
31 #include "numeric.h"
32
33 #ifndef NO_NAMESPACE_GINAC
34 namespace GiNaC {
35 #endif // ndef NO_NAMESPACE_GINAC
36
37 GINAC_IMPLEMENT_REGISTERED_CLASS(matrix, basic)
38
39 //////////
40 // default constructor, destructor, copy constructor, assignment operator
41 // and helpers:
42 //////////
43
44 // public
45
46 /** Default ctor.  Initializes to 1 x 1-dimensional zero-matrix. */
47 matrix::matrix()
48     : inherited(TINFO_matrix), row(1), col(1)
49 {
50     debugmsg("matrix default constructor",LOGLEVEL_CONSTRUCT);
51     m.push_back(_ex0());
52 }
53
54 matrix::~matrix()
55 {
56     debugmsg("matrix destructor",LOGLEVEL_DESTRUCT);
57 }
58
59 matrix::matrix(const matrix & other)
60 {
61     debugmsg("matrix copy constructor",LOGLEVEL_CONSTRUCT);
62     copy(other);
63 }
64
65 const matrix & matrix::operator=(const matrix & other)
66 {
67     debugmsg("matrix operator=",LOGLEVEL_ASSIGNMENT);
68     if (this != &other) {
69         destroy(1);
70         copy(other);
71     }
72     return *this;
73 }
74
75 // protected
76
77 void matrix::copy(const matrix & other)
78 {
79     inherited::copy(other);
80     row=other.row;
81     col=other.col;
82     m=other.m;  // use STL's vector copying
83 }
84
85 void matrix::destroy(bool call_parent)
86 {
87     if (call_parent) inherited::destroy(call_parent);
88 }
89
90 //////////
91 // other constructors
92 //////////
93
94 // public
95
96 /** Very common ctor.  Initializes to r x c-dimensional zero-matrix.
97  *
98  *  @param r number of rows
99  *  @param c number of cols */
100 matrix::matrix(unsigned r, unsigned c)
101     : inherited(TINFO_matrix), row(r), col(c)
102 {
103     debugmsg("matrix constructor from unsigned,unsigned",LOGLEVEL_CONSTRUCT);
104     m.resize(r*c, _ex0());
105 }
106
107 // protected
108
109 /** Ctor from representation, for internal use only. */
110 matrix::matrix(unsigned r, unsigned c, const exvector & m2)
111     : inherited(TINFO_matrix), row(r), col(c), m(m2)
112 {
113     debugmsg("matrix constructor from unsigned,unsigned,exvector",LOGLEVEL_CONSTRUCT);
114 }
115
116 //////////
117 // archiving
118 //////////
119
120 /** Construct object from archive_node. */
121 matrix::matrix(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
122 {
123     debugmsg("matrix constructor from archive_node", LOGLEVEL_CONSTRUCT);
124     if (!(n.find_unsigned("row", row)) || !(n.find_unsigned("col", col)))
125         throw (std::runtime_error("unknown matrix dimensions in archive"));
126     m.reserve(row * col);
127     for (unsigned int i=0; true; i++) {
128         ex e;
129         if (n.find_ex("m", e, sym_lst, i))
130             m.push_back(e);
131         else
132             break;
133     }
134 }
135
136 /** Unarchive the object. */
137 ex matrix::unarchive(const archive_node &n, const lst &sym_lst)
138 {
139     return (new matrix(n, sym_lst))->setflag(status_flags::dynallocated);
140 }
141
142 /** Archive the object. */
143 void matrix::archive(archive_node &n) const
144 {
145     inherited::archive(n);
146     n.add_unsigned("row", row);
147     n.add_unsigned("col", col);
148     exvector::const_iterator i = m.begin(), iend = m.end();
149     while (i != iend) {
150         n.add_ex("m", *i);
151         i++;
152     }
153 }
154
155 //////////
156 // functions overriding virtual functions from bases classes
157 //////////
158
159 // public
160
161 basic * matrix::duplicate() const
162 {
163     debugmsg("matrix duplicate",LOGLEVEL_DUPLICATE);
164     return new matrix(*this);
165 }
166
167 void matrix::print(ostream & os, unsigned upper_precedence) const
168 {
169     debugmsg("matrix print",LOGLEVEL_PRINT);
170     os << "[[ ";
171     for (unsigned r=0; r<row-1; ++r) {
172         os << "[[";
173         for (unsigned c=0; c<col-1; ++c) {
174             os << m[r*col+c] << ",";
175         }
176         os << m[col*(r+1)-1] << "]], ";
177     }
178     os << "[[";
179     for (unsigned c=0; c<col-1; ++c) {
180         os << m[(row-1)*col+c] << ",";
181     }
182     os << m[row*col-1] << "]] ]]";
183 }
184
185 void matrix::printraw(ostream & os) const
186 {
187     debugmsg("matrix printraw",LOGLEVEL_PRINT);
188     os << "matrix(" << row << "," << col <<",";
189     for (unsigned r=0; r<row-1; ++r) {
190         os << "(";
191         for (unsigned c=0; c<col-1; ++c) {
192             os << m[r*col+c] << ",";
193         }
194         os << m[col*(r-1)-1] << "),";
195     }
196     os << "(";
197     for (unsigned c=0; c<col-1; ++c) {
198         os << m[(row-1)*col+c] << ",";
199     }
200     os << m[row*col-1] << "))";
201 }
202
203 /** nops is defined to be rows x columns. */
204 unsigned matrix::nops() const
205 {
206     return row*col;
207 }
208
209 /** returns matrix entry at position (i/col, i%col). */
210 ex matrix::op(int i) const
211 {
212     return m[i];
213 }
214
215 /** returns matrix entry at position (i/col, i%col). */
216 ex & matrix::let_op(int i)
217 {
218     return m[i];
219 }
220
221 /** expands the elements of a matrix entry by entry. */
222 ex matrix::expand(unsigned options) const
223 {
224     exvector tmp(row*col);
225     for (unsigned i=0; i<row*col; ++i) {
226         tmp[i]=m[i].expand(options);
227     }
228     return matrix(row, col, tmp);
229 }
230
231 /** Search ocurrences.  A matrix 'has' an expression if it is the expression
232  *  itself or one of the elements 'has' it. */
233 bool matrix::has(const ex & other) const
234 {
235     GINAC_ASSERT(other.bp!=0);
236     
237     // tautology: it is the expression itself
238     if (is_equal(*other.bp)) return true;
239     
240     // search all the elements
241     for (exvector::const_iterator r=m.begin(); r!=m.end(); ++r) {
242         if ((*r).has(other)) return true;
243     }
244     return false;
245 }
246
247 /** evaluate matrix entry by entry. */
248 ex matrix::eval(int level) const
249 {
250     debugmsg("matrix eval",LOGLEVEL_MEMBER_FUNCTION);
251     
252     // check if we have to do anything at all
253     if ((level==1)&&(flags & status_flags::evaluated))
254         return *this;
255     
256     // emergency break
257     if (level == -max_recursion_level)
258         throw (std::runtime_error("matrix::eval(): recursion limit exceeded"));
259     
260     // eval() entry by entry
261     exvector m2(row*col);
262     --level;    
263     for (unsigned r=0; r<row; ++r) {
264         for (unsigned c=0; c<col; ++c) {
265             m2[r*col+c] = m[r*col+c].eval(level);
266         }
267     }
268     
269     return (new matrix(row, col, m2))->setflag(status_flags::dynallocated |
270                                                status_flags::evaluated );
271 }
272
273 /** evaluate matrix numerically entry by entry. */
274 ex matrix::evalf(int level) const
275 {
276     debugmsg("matrix evalf",LOGLEVEL_MEMBER_FUNCTION);
277         
278     // check if we have to do anything at all
279     if (level==1)
280         return *this;
281     
282     // emergency break
283     if (level == -max_recursion_level) {
284         throw (std::runtime_error("matrix::evalf(): recursion limit exceeded"));
285     }
286     
287     // evalf() entry by entry
288     exvector m2(row*col);
289     --level;
290     for (unsigned r=0; r<row; ++r) {
291         for (unsigned c=0; c<col; ++c) {
292             m2[r*col+c] = m[r*col+c].evalf(level);
293         }
294     }
295     return matrix(row, col, m2);
296 }
297
298 // protected
299
300 int matrix::compare_same_type(const basic & other) const
301 {
302     GINAC_ASSERT(is_exactly_of_type(other, matrix));
303     const matrix & o = static_cast<matrix &>(const_cast<basic &>(other));
304     
305     // compare number of rows
306     if (row != o.rows())
307         return row < o.rows() ? -1 : 1;
308     
309     // compare number of columns
310     if (col != o.cols())
311         return col < o.cols() ? -1 : 1;
312     
313     // equal number of rows and columns, compare individual elements
314     int cmpval;
315     for (unsigned r=0; r<row; ++r) {
316         for (unsigned c=0; c<col; ++c) {
317             cmpval = ((*this)(r,c)).compare(o(r,c));
318             if (cmpval!=0) return cmpval;
319         }
320     }
321     // all elements are equal => matrices are equal;
322     return 0;
323 }
324
325 //////////
326 // non-virtual functions in this class
327 //////////
328
329 // public
330
331 /** Sum of matrices.
332  *
333  *  @exception logic_error (incompatible matrices) */
334 matrix matrix::add(const matrix & other) const
335 {
336     if (col != other.col || row != other.row)
337         throw (std::logic_error("matrix::add(): incompatible matrices"));
338     
339     exvector sum(this->m);
340     exvector::iterator i;
341     exvector::const_iterator ci;
342     for (i=sum.begin(), ci=other.m.begin();
343          i!=sum.end();
344          ++i, ++ci) {
345         (*i) += (*ci);
346     }
347     return matrix(row,col,sum);
348 }
349
350
351 /** Difference of matrices.
352  *
353  *  @exception logic_error (incompatible matrices) */
354 matrix matrix::sub(const matrix & other) const
355 {
356     if (col != other.col || row != other.row)
357         throw (std::logic_error("matrix::sub(): incompatible matrices"));
358     
359     exvector dif(this->m);
360     exvector::iterator i;
361     exvector::const_iterator ci;
362     for (i=dif.begin(), ci=other.m.begin();
363          i!=dif.end();
364          ++i, ++ci) {
365         (*i) -= (*ci);
366     }
367     return matrix(row,col,dif);
368 }
369
370
371 /** Product of matrices.
372  *
373  *  @exception logic_error (incompatible matrices) */
374 matrix matrix::mul(const matrix & other) const
375 {
376     if (col != other.row)
377         throw (std::logic_error("matrix::mul(): incompatible matrices"));
378     
379     exvector prod(row*other.col);
380     for (unsigned i=0; i<row; ++i) {
381         for (unsigned j=0; j<other.col; ++j) {
382             for (unsigned l=0; l<col; ++l) {
383                 prod[i*other.col+j] += m[i*col+l] * other.m[l*other.col+j];
384             }
385         }
386     }
387     return matrix(row, other.col, prod);
388 }
389
390
391 /** operator() to access elements.
392  *
393  *  @param ro row of element
394  *  @param co column of element 
395  *  @exception range_error (index out of range) */
396 const ex & matrix::operator() (unsigned ro, unsigned co) const
397 {
398     if (ro<0 || ro>=row || co<0 || co>=col)
399         throw (std::range_error("matrix::operator(): index out of range"));
400     
401     return m[ro*col+co];
402 }
403
404
405 /** Set individual elements manually.
406  *
407  *  @exception range_error (index out of range) */
408 matrix & matrix::set(unsigned ro, unsigned co, ex value)
409 {
410     if (ro<0 || ro>=row || co<0 || co>=col)
411         throw (std::range_error("matrix::set(): index out of range"));
412     
413     ensure_if_modifiable();
414     m[ro*col+co] = value;
415     return *this;
416 }
417
418
419 /** Transposed of an m x n matrix, producing a new n x m matrix object that
420  *  represents the transposed. */
421 matrix matrix::transpose(void) const
422 {
423     exvector trans(col*row);
424     
425     for (unsigned r=0; r<col; ++r)
426         for (unsigned c=0; c<row; ++c)
427             trans[r*row+c] = m[c*col+r];
428     
429     return matrix(col,row,trans);
430 }
431
432
433 /** Determinant of square matrix.  This routine doesn't actually calculate the
434  *  determinant, it only implements some heuristics about which algorithm to
435  *  call.  If all the elements of the matrix are elements of an integral domain
436  *  the determinant is also in that integral domain and the result is expanded
437  *  only.  If one or more elements are from a quotient field the determinant is
438  *  usually also in that quotient field and the result is normalized before it
439  *  is returned.  This implies that the determinant of the symbolic 2x2 matrix
440  *  [[a/(a-b),1],[b/(a-b),1]] is returned as unity.  (In this respect, it
441  *  behaves like MapleV and unlike Mathematica.)
442  *
443  *  @return    the determinant as a new expression
444  *  @exception logic_error (matrix not square) */
445 ex matrix::determinant(void) const
446 {
447     if (row!=col)
448         throw (std::logic_error("matrix::determinant(): matrix not square"));
449     GINAC_ASSERT(row*col==m.capacity());
450     if (this->row==1)  // continuation would be pointless
451         return m[0];
452     
453     bool numeric_flag = true;
454     bool normal_flag = false;
455     unsigned sparse_count = 0;  // count non-zero elements
456     for (exvector::const_iterator r=m.begin(); r!=m.end(); ++r) {
457         if (!(*r).is_zero()) {
458             ++sparse_count;
459         }
460         if (!(*r).info(info_flags::numeric)) {
461             numeric_flag = false;
462         }
463         if ((*r).info(info_flags::rational_function) &&
464             !(*r).info(info_flags::crational_polynomial)) {
465             normal_flag = true;
466         }
467     }
468     
469     if (numeric_flag)
470         return determinant_numeric();
471     
472     // Now come the minor expansion schemes.  We always develop such that the
473     // smallest minors (i.e, the trivial 1x1 ones) are on the rightmost column.
474     // For this to be efficient it turns out that the emptiest columns (i.e.
475     // the ones with most zeros) should be the ones on the right hand side.
476     // Therefore we presort the columns of the matrix:
477     typedef pair<unsigned,unsigned> uintpair;  // # of zeros, column
478     vector<uintpair> c_zeros;  // number of zeros in column
479     for (unsigned c=0; c<col; ++c) {
480         unsigned acc = 0;
481         for (unsigned r=0; r<row; ++r)
482             if (m[r*col+c].is_zero())
483                 ++acc;
484         c_zeros.push_back(uintpair(acc,c));
485     }
486     sort(c_zeros.begin(),c_zeros.end());
487     vector<unsigned> pre_sort;  // unfortunately vector<uintpair> can't be used
488                                 // for permutation_sign.
489     for (vector<uintpair>::iterator i=c_zeros.begin(); i!=c_zeros.end(); ++i)
490         pre_sort.push_back(i->second);
491     int sign = permutation_sign(pre_sort);
492     exvector result(row*col);  // represents sorted matrix
493     unsigned c = 0;
494     for (vector<unsigned>::iterator i=pre_sort.begin();
495          i!=pre_sort.end();
496          ++i,++c) {
497         for (unsigned r=0; r<row; ++r)
498             result[r*col+c] = m[r*col+(*i)];
499     }
500     
501     if (0*sparse_count>row*col) {     // MAGIC, maybe 10 some day?
502         if (normal_flag)
503             return sign*matrix(row,col,result).determinant_minor_sparse().normal();
504         return sign*matrix(row,col,result).determinant_minor_sparse();
505     }
506     if (normal_flag)
507         return sign*matrix(row,col,result).determinant_minor_dense().normal();
508     return sign*matrix(row,col,result).determinant_minor_dense();
509 }
510
511
512 /** Trace of a matrix.  The result is normalized if it is in some quotient
513  *  field and expanded only otherwise.  This implies that the trace of the
514  *  symbolic 2x2 matrix [[a/(a-b),x],[y,b/(b-a)]] is recognized to be unity.
515  *
516  *  @return    the sum of diagonal elements
517  *  @exception logic_error (matrix not square) */
518 ex matrix::trace(void) const
519 {
520     if (row != col)
521         throw (std::logic_error("matrix::trace(): matrix not square"));
522     GINAC_ASSERT(row*col==m.capacity());
523     
524     ex tr;
525     for (unsigned r=0; r<col; ++r)
526         tr += m[r*col+r];
527     
528     if (tr.info(info_flags::rational_function) &&
529         !tr.info(info_flags::crational_polynomial))
530         return tr.normal();
531     else
532         return tr.expand();
533 }
534
535
536 /** Characteristic Polynomial.  The characteristic polynomial of a matrix M is
537  *  defined as the determiant of (M - lambda * 1) where 1 stands for the unit
538  *  matrix of the same dimension as M.  This method returns the characteristic
539  *  polynomial as a new expression.
540  *
541  *  @return    characteristic polynomial as new expression
542  *  @exception logic_error (matrix not square)
543  *  @see       matrix::determinant() */
544 ex matrix::charpoly(const ex & lambda) const
545 {
546     if (row != col)
547         throw (std::logic_error("matrix::charpoly(): matrix not square"));
548     
549     matrix M(*this);
550     for (unsigned r=0; r<col; ++r)
551         M.m[r*col+r] -= lambda;
552     
553     return (M.determinant());
554 }
555
556
557 /** Inverse of this matrix.
558  *
559  *  @return    the inverted matrix
560  *  @exception logic_error (matrix not square)
561  *  @exception runtime_error (singular matrix) */
562 matrix matrix::inverse(void) const
563 {
564     if (row != col)
565         throw (std::logic_error("matrix::inverse(): matrix not square"));
566     
567     matrix tmp(row,col);
568     // set tmp to the unit matrix
569     for (unsigned i=0; i<col; ++i)
570         tmp.m[i*col+i] = _ex1();
571
572     // create a copy of this matrix
573     matrix cpy(*this);
574     for (unsigned r1=0; r1<row; ++r1) {
575         int indx = cpy.pivot(r1);
576         if (indx == -1) {
577             throw (std::runtime_error("matrix::inverse(): singular matrix"));
578         }
579         if (indx != 0) {  // swap rows r and indx of matrix tmp
580             for (unsigned i=0; i<col; ++i) {
581                 tmp.m[r1*col+i].swap(tmp.m[indx*col+i]);
582             }
583         }
584         ex a1 = cpy.m[r1*col+r1];
585         for (unsigned c=0; c<col; ++c) {
586             cpy.m[r1*col+c] /= a1;
587             tmp.m[r1*col+c] /= a1;
588         }
589         for (unsigned r2=0; r2<row; ++r2) {
590             if (r2 != r1) {
591                 ex a2 = cpy.m[r2*col+r1];
592                 for (unsigned c=0; c<col; ++c) {
593                     cpy.m[r2*col+c] -= a2 * cpy.m[r1*col+c];
594                     tmp.m[r2*col+c] -= a2 * tmp.m[r1*col+c];
595                 }
596             }
597         }
598     }
599     return tmp;
600 }
601
602
603 // superfluous helper function
604 void matrix::ffe_swap(unsigned r1, unsigned c1, unsigned r2 ,unsigned c2)
605 {
606     ensure_if_modifiable();
607     
608     ex tmp = ffe_get(r1,c1);
609     ffe_set(r1,c1,ffe_get(r2,c2));
610     ffe_set(r2,c2,tmp);
611 }
612
613 // superfluous helper function
614 void matrix::ffe_set(unsigned r, unsigned c, ex e)
615 {
616     set(r-1,c-1,e);
617 }
618
619 // superfluous helper function
620 ex matrix::ffe_get(unsigned r, unsigned c) const
621 {
622     return operator()(r-1,c-1);
623 }
624
625 /** Solve a set of equations for an m x n matrix by fraction-free Gaussian
626  *  elimination.  Based on algorithm 9.1 from 'Algorithms for Computer Algebra'
627  *  by Keith O. Geddes et al.
628  *
629  *  @param vars n x p matrix
630  *  @param rhs m x p matrix
631  *  @exception logic_error (incompatible matrices)
632  *  @exception runtime_error (singular matrix) */
633 matrix matrix::fraction_free_elim(const matrix & vars,
634                                   const matrix & rhs) const
635 {
636     // FIXME: implement a Sasaki-Murao scheme which avoids division at all!
637     if ((row != rhs.row) || (col != vars.row) || (rhs.col != vars.col))
638         throw (std::logic_error("matrix::fraction_free_elim(): incompatible matrices"));
639     
640     matrix a(*this);  // make a copy of the matrix
641     matrix b(rhs);    // make a copy of the rhs vector
642     
643     // given an m x n matrix a, reduce it to upper echelon form
644     unsigned m = a.row;
645     unsigned n = a.col;
646     int sign = 1;
647     ex divisor = 1;
648     unsigned r = 1;
649     
650     // eliminate below row r, with pivot in column k
651     for (unsigned k=1; (k<=n)&&(r<=m); ++k) {
652         // find a nonzero pivot
653         unsigned p;
654         for (p=r; (p<=m)&&(a.ffe_get(p,k).is_equal(_ex0())); ++p) {}
655         // pivot is in row p
656         if (p<=m) {
657             if (p!=r) {
658                 // switch rows p and r
659                 for (unsigned j=k; j<=n; ++j)
660                     a.ffe_swap(p,j,r,j);
661                 b.ffe_swap(p,1,r,1);
662                 // keep track of sign changes due to row exchange
663                 sign = -sign;
664             }
665             for (unsigned i=r+1; i<=m; ++i) {
666                 for (unsigned j=k+1; j<=n; ++j) {
667                     a.ffe_set(i,j,(a.ffe_get(r,k)*a.ffe_get(i,j)
668                                   -a.ffe_get(r,j)*a.ffe_get(i,k))/divisor);
669                     a.ffe_set(i,j,a.ffe_get(i,j).normal() /*.normal() */ );
670                 }
671                 b.ffe_set(i,1,(a.ffe_get(r,k)*b.ffe_get(i,1)
672                               -b.ffe_get(r,1)*a.ffe_get(i,k))/divisor);
673                 b.ffe_set(i,1,b.ffe_get(i,1).normal() /*.normal() */ );
674                 a.ffe_set(i,k,0);
675             }
676             divisor = a.ffe_get(r,k);
677             r++;
678         }
679     }
680     // optionally compute the determinant for square or augmented matrices
681     // if (r==m+1) { det = sign*divisor; } else { det = 0; }
682     
683     /*
684     for (unsigned r=1; r<=m; ++r) {
685         for (unsigned c=1; c<=n; ++c) {
686             cout << a.ffe_get(r,c) << "\t";
687         }
688         cout << " | " <<  b.ffe_get(r,1) << endl;
689     }
690     */
691     
692 #ifdef DO_GINAC_ASSERT
693     // test if we really have an upper echelon matrix
694     int zero_in_last_row = -1;
695     for (unsigned r=1; r<=m; ++r) {
696         int zero_in_this_row=0;
697         for (unsigned c=1; c<=n; ++c) {
698             if (a.ffe_get(r,c).is_equal(_ex0()))
699                zero_in_this_row++;
700             else
701                 break;
702         }
703         GINAC_ASSERT((zero_in_this_row>zero_in_last_row)||(zero_in_this_row=n));
704         zero_in_last_row = zero_in_this_row;
705     }
706 #endif // def DO_GINAC_ASSERT
707     
708     /*
709     cout << "after" << endl;
710     cout << "a=" << a << endl;
711     cout << "b=" << b << endl;
712     */
713     
714     // assemble solution
715     matrix sol(n,1);
716     unsigned last_assigned_sol = n+1;
717     for (unsigned r=m; r>0; --r) {
718         unsigned first_non_zero = 1;
719         while ((first_non_zero<=n)&&(a.ffe_get(r,first_non_zero).is_zero()))
720             first_non_zero++;
721         if (first_non_zero>n) {
722             // row consists only of zeroes, corresponding rhs must be 0 as well
723             if (!b.ffe_get(r,1).is_zero()) {
724                 throw (std::runtime_error("matrix::fraction_free_elim(): singular matrix"));
725             }
726         } else {
727             // assign solutions for vars between first_non_zero+1 and
728             // last_assigned_sol-1: free parameters
729             for (unsigned c=first_non_zero+1; c<=last_assigned_sol-1; ++c) {
730                 sol.ffe_set(c,1,vars.ffe_get(c,1));
731             }
732             ex e = b.ffe_get(r,1);
733             for (unsigned c=first_non_zero+1; c<=n; ++c) {
734                 e=e-a.ffe_get(r,c)*sol.ffe_get(c,1);
735             }
736             sol.ffe_set(first_non_zero,1,
737                         (e/a.ffe_get(r,first_non_zero)).normal());
738             last_assigned_sol = first_non_zero;
739         }
740     }
741     // assign solutions for vars between 1 and
742     // last_assigned_sol-1: free parameters
743     for (unsigned c=1; c<=last_assigned_sol-1; ++c)
744         sol.ffe_set(c,1,vars.ffe_get(c,1));
745     
746 #ifdef DO_GINAC_ASSERT
747     // test solution with echelon matrix
748     for (unsigned r=1; r<=m; ++r) {
749         ex e = 0;
750         for (unsigned c=1; c<=n; ++c)
751             e = e+a.ffe_get(r,c)*sol.ffe_get(c,1);
752         if (!(e-b.ffe_get(r,1)).normal().is_zero()) {
753             cout << "e=" << e;
754             cout << "b.ffe_get(" << r<<",1)=" << b.ffe_get(r,1) << endl;
755             cout << "diff=" << (e-b.ffe_get(r,1)).normal() << endl;
756         }
757         GINAC_ASSERT((e-b.ffe_get(r,1)).normal().is_zero());
758     }
759     
760     // test solution with original matrix
761     for (unsigned r=1; r<=m; ++r) {
762         ex e = 0;
763         for (unsigned c=1; c<=n; ++c)
764             e = e+ffe_get(r,c)*sol.ffe_get(c,1);
765         try {
766             if (!(e-rhs.ffe_get(r,1)).normal().is_zero()) {
767                 cout << "e=" << e << endl;
768                 e.printtree(cout);
769                 ex en = e.normal();
770                 cout << "e.normal()=" << en << endl;
771                 en.printtree(cout);
772                 cout << "rhs.ffe_get(" << r<<",1)=" << rhs.ffe_get(r,1) << endl;
773                 cout << "diff=" << (e-rhs.ffe_get(r,1)).normal() << endl;
774             }
775         } catch (...) {
776             ex xxx = e - rhs.ffe_get(r,1);
777             cerr << "xxx=" << xxx << endl << endl;
778         }
779         GINAC_ASSERT((e-rhs.ffe_get(r,1)).normal().is_zero());
780     }
781 #endif // def DO_GINAC_ASSERT
782     
783     return sol;
784 }
785
786 /** Solve a set of equations for an m x n matrix.
787  *
788  *  @param vars n x p matrix
789  *  @param rhs m x p matrix
790  *  @exception logic_error (incompatible matrices)
791  *  @exception runtime_error (singular matrix) */
792 matrix matrix::solve(const matrix & vars,
793                      const matrix & rhs) const
794 {
795     if ((row != rhs.row) || (col != vars.row) || (rhs.col != vars.col))
796         throw (std::logic_error("matrix::solve(): incompatible matrices"));
797     
798     throw (std::runtime_error("FIXME: need implementation."));
799 }
800
801 /** Old and obsolete interface: */
802 matrix matrix::old_solve(const matrix & v) const
803 {
804     if ((v.row != col) || (col != v.row))
805         throw (std::logic_error("matrix::solve(): incompatible matrices"));
806     
807     // build the augmented matrix of *this with v attached to the right
808     matrix tmp(row,col+v.col);
809     for (unsigned r=0; r<row; ++r) {
810         for (unsigned c=0; c<col; ++c)
811             tmp.m[r*tmp.col+c] = this->m[r*col+c];
812         for (unsigned c=0; c<v.col; ++c)
813             tmp.m[r*tmp.col+c+col] = v.m[r*v.col+c];
814     }
815     // cout << "augmented: " << tmp << endl;
816     tmp.gauss_elimination();
817     // cout << "degaussed: " << tmp << endl;
818     // assemble the solution matrix
819     exvector sol(v.row*v.col);
820     for (unsigned c=0; c<v.col; ++c) {
821         for (unsigned r=row; r>0; --r) {
822             for (unsigned i=r; i<col; ++i)
823                 sol[(r-1)*v.col+c] -= tmp.m[(r-1)*tmp.col+i]*sol[i*v.col+c];
824             sol[(r-1)*v.col+c] += tmp.m[(r-1)*tmp.col+col+c];
825             sol[(r-1)*v.col+c] = (sol[(r-1)*v.col+c]/tmp.m[(r-1)*tmp.col+(r-1)]).normal();
826         }
827     }
828     return matrix(v.row, v.col, sol);
829 }
830
831
832 // protected
833
834 /** Determinant of purely numeric matrix, using pivoting.
835  *
836  *  @see       matrix::determinant() */
837 ex matrix::determinant_numeric(void) const
838 {
839     matrix tmp(*this);
840     ex det = _ex1();
841     ex piv;
842     
843     for (unsigned r1=0; r1<row; ++r1) {
844         int indx = tmp.pivot(r1);
845         if (indx == -1)
846             return _ex0();
847         if (indx != 0)
848             det *= _ex_1();
849         det = det * tmp.m[r1*col+r1];
850         for (unsigned r2=r1+1; r2<row; ++r2) {
851             piv = tmp.m[r2*col+r1] / tmp.m[r1*col+r1];
852             for (unsigned c=r1+1; c<col; c++) {
853                 tmp.m[r2*col+c] -= piv * tmp.m[r1*col+c];
854             }
855         }
856     }
857     
858     return det;
859 }
860
861
862 /*  Leverrier algorithm for large matrices having at least one symbolic entry.
863  *  This routine is only called internally by matrix::determinant(). The
864  *  algorithm is very bad for symbolic matrices since it returns expressions
865  *  that are quite hard to expand. */
866 /*ex matrix::determinant_leverrier(const matrix & M)
867  *{
868  *    GINAC_ASSERT(M.rows()==M.cols());  // cannot happen, just in case...
869  *    
870  *    matrix B(M);
871  *    matrix I(M.row, M.col);
872  *    ex c=B.trace();
873  *    for (unsigned i=1; i<M.row; ++i) {
874  *        for (unsigned j=0; j<M.row; ++j)
875  *            I.m[j*M.col+j] = c;
876  *        B = M.mul(B.sub(I));
877  *        c = B.trace()/ex(i+1);
878  *    }
879  *    if (M.row%2) {
880  *        return c;
881  *    } else {
882  *        return -c;
883  *    }
884  *}*/
885
886
887 ex matrix::determinant_minor_sparse(void) const
888 {
889     // for small matrices the algorithm does not make any sense:
890     if (this->row==1)
891         return m[0];
892     if (this->row==2)
893         return (m[0]*m[3]-m[2]*m[1]).expand();
894     if (this->row==3)
895         return (m[0]*m[4]*m[8]-m[0]*m[5]*m[7]-
896                 m[1]*m[3]*m[8]+m[2]*m[3]*m[7]+
897                 m[1]*m[5]*m[6]-m[2]*m[4]*m[6]).expand();
898     
899     ex det;
900     matrix minorM(this->row-1,this->col-1);
901     for (unsigned r1=0; r1<this->row; ++r1) {
902         // shortcut if element(r1,0) vanishes
903         if (m[r1*col].is_zero())
904             continue;
905         // assemble the minor matrix
906         for (unsigned r=0; r<minorM.rows(); ++r) {
907             for (unsigned c=0; c<minorM.cols(); ++c) {
908                 if (r<r1)
909                     minorM.set(r,c,m[r*col+c+1]);
910                 else
911                     minorM.set(r,c,m[(r+1)*col+c+1]);
912             }
913         }
914         // recurse down and care for sign:
915         if (r1%2)
916             det -= m[r1*col] * minorM.determinant_minor_sparse();
917         else
918             det += m[r1*col] * minorM.determinant_minor_sparse();
919     }
920     return det.expand();
921 }
922
923 /** Recursive determinant for small matrices having at least one symbolic
924  *  entry.  The basic algorithm, known as Laplace-expansion, is enhanced by
925  *  some bookkeeping to avoid calculation of the same submatrices ("minors")
926  *  more than once.  According to W.M.Gentleman and S.C.Johnson this algorithm
927  *  is better than elimination schemes for matrices of sparse multivariate
928  *  polynomials and also for matrices of dense univariate polynomials if the
929  *  matrix' dimesion is larger than 7.
930  *
931  *  @return the determinant as a new expression (in expanded form)
932  *  @see matrix::determinant() */
933 ex matrix::determinant_minor_dense(void) const
934 {
935     // for small matrices the algorithm does not make any sense:
936     if (this->row==1)
937         return m[0];
938     if (this->row==2)
939         return (m[0]*m[3]-m[2]*m[1]).expand();
940     if (this->row==3)
941         return (m[0]*m[4]*m[8]-m[0]*m[5]*m[7]-
942                 m[1]*m[3]*m[8]+m[2]*m[3]*m[7]+
943                 m[1]*m[5]*m[6]-m[2]*m[4]*m[6]).expand();
944     
945     // This algorithm can best be understood by looking at a naive
946     // implementation of Laplace-expansion, like this one:
947     // ex det;
948     // matrix minorM(this->row-1,this->col-1);
949     // for (unsigned r1=0; r1<this->row; ++r1) {
950     //     // shortcut if element(r1,0) vanishes
951     //     if (m[r1*col].is_zero())
952     //         continue;
953     //     // assemble the minor matrix
954     //     for (unsigned r=0; r<minorM.rows(); ++r) {
955     //         for (unsigned c=0; c<minorM.cols(); ++c) {
956     //             if (r<r1)
957     //                 minorM.set(r,c,m[r*col+c+1]);
958     //             else
959     //                 minorM.set(r,c,m[(r+1)*col+c+1]);
960     //         }
961     //     }
962     //     // recurse down and care for sign:
963     //     if (r1%2)
964     //         det -= m[r1*col] * minorM.determinant_minor();
965     //     else
966     //         det += m[r1*col] * minorM.determinant_minor();
967     // }
968     // return det.expand();
969     // What happens is that while proceeding down many of the minors are
970     // computed more than once.  In particular, there are binomial(n,k)
971     // kxk minors and each one is computed factorial(n-k) times.  Therefore
972     // it is reasonable to store the results of the minors.  We proceed from
973     // right to left.  At each column c we only need to retrieve the minors
974     // calculated in step c-1.  We therefore only have to store at most 
975     // 2*binomial(n,n/2) minors.
976     
977     // Unique flipper counter for partitioning into minors
978     vector<unsigned> Pkey;
979     Pkey.reserve(this->col);
980     // key for minor determinant (a subpartition of Pkey)
981     vector<unsigned> Mkey;
982     Mkey.reserve(this->col-1);
983     // we store our subminors in maps, keys being the rows they arise from
984     typedef map<vector<unsigned>,class ex> Rmap;
985     typedef map<vector<unsigned>,class ex>::value_type Rmap_value;
986     Rmap A;
987     Rmap B;
988     ex det;
989     // initialize A with last column:
990     for (unsigned r=0; r<this->col; ++r) {
991         Pkey.erase(Pkey.begin(),Pkey.end());
992         Pkey.push_back(r);
993         A.insert(Rmap_value(Pkey,m[this->col*r+this->col-1]));
994     }
995     // proceed from right to left through matrix
996     for (int c=this->col-2; c>=0; --c) {
997         Pkey.erase(Pkey.begin(),Pkey.end());  // don't change capacity
998         Mkey.erase(Mkey.begin(),Mkey.end());
999         for (unsigned i=0; i<this->col-c; ++i)
1000             Pkey.push_back(i);
1001         unsigned fc = 0;  // controls logic for our strange flipper counter
1002         do {
1003             det = _ex0();
1004             for (unsigned r=0; r<this->col-c; ++r) {
1005                 // maybe there is nothing to do?
1006                 if (m[Pkey[r]*this->col+c].is_zero())
1007                     continue;
1008                 // create the sorted key for all possible minors
1009                 Mkey.erase(Mkey.begin(),Mkey.end());
1010                 for (unsigned i=0; i<this->col-c; ++i)
1011                     if (i!=r)
1012                         Mkey.push_back(Pkey[i]);
1013                 // Fetch the minors and compute the new determinant
1014                 if (r%2)
1015                     det -= m[Pkey[r]*this->col+c]*A[Mkey];
1016                 else
1017                     det += m[Pkey[r]*this->col+c]*A[Mkey];
1018             }
1019             // prevent build-up of deep nesting of expressions saves time:
1020             det = det.expand();
1021             // store the new determinant at its place in B:
1022             if (!det.is_zero())
1023                 B.insert(Rmap_value(Pkey,det));
1024             // increment our strange flipper counter
1025             for (fc=this->col-c; fc>0; --fc) {
1026                 ++Pkey[fc-1];
1027                 if (Pkey[fc-1]<fc+c)
1028                     break;
1029             }
1030             if (fc<this->col-c)
1031                 for (unsigned j=fc; j<this->col-c; ++j)
1032                     Pkey[j] = Pkey[j-1]+1;
1033         } while(fc);
1034         // next column, so change the role of A and B:
1035         A = B;
1036         B.clear();
1037     }
1038     
1039     return det;
1040 }
1041
1042
1043 /*  Determinant using a simple Bareiss elimination scheme.  Suited for
1044  *  sparse matrices.
1045  *
1046  *  @return the determinant as a new expression (in expanded form)
1047  *  @see matrix::determinant() */
1048 ex matrix::determinant_bareiss(void) const
1049 {
1050     matrix M(*this);
1051     int sign = M.fraction_free_elimination();
1052     if (sign)
1053         return sign*M(row-1,col-1);
1054     else
1055         return _ex0();
1056 }
1057
1058
1059 /** Determinant built by application of the full permutation group.  This
1060  *  routine is only called internally by matrix::determinant().
1061  *  NOTE: it is probably inefficient in all cases and may be eliminated. */
1062 ex matrix::determinant_perm(void) const
1063 {
1064     if (rows()==1)  // speed things up
1065         return m[0];
1066     
1067     ex det;
1068     ex term;
1069     vector<unsigned> sigma(col);
1070     for (unsigned i=0; i<col; ++i)
1071         sigma[i]=i;
1072     
1073     do {
1074         term = (*this)(sigma[0],0);
1075         for (unsigned i=1; i<col; ++i)
1076             term *= (*this)(sigma[i],i);
1077         det += permutation_sign(sigma)*term;
1078     } while (next_permutation(sigma.begin(), sigma.end()));
1079     
1080     return det;
1081 }
1082
1083
1084 /** Perform the steps of an ordinary Gaussian elimination to bring the matrix
1085  *  into an upper echelon form.
1086  *
1087  *  @return sign is 1 if an even number of rows was swapped, -1 if an odd
1088  *  number of rows was swapped and 0 if the matrix is singular. */
1089 int matrix::gauss_elimination(void)
1090 {
1091     int sign = 1;
1092     ensure_if_modifiable();
1093     for (unsigned r1=0; r1<row-1; ++r1) {
1094         int indx = pivot(r1);
1095         if (indx == -1)
1096             return 0;  // Note: leaves *this in a messy state.
1097         if (indx > 0)
1098             sign = -sign;
1099         for (unsigned r2=r1+1; r2<row; ++r2) {
1100             for (unsigned c=r1+1; c<col; ++c)
1101                 this->m[r2*col+c] -= this->m[r2*col+r1]*this->m[r1*col+c]/this->m[r1*col+r1];
1102             for (unsigned c=0; c<=r1; ++c)
1103                 this->m[r2*col+c] = _ex0();
1104         }
1105     }
1106     
1107     return sign;
1108 }
1109
1110
1111 /** Perform the steps of division free elimination to bring the matrix
1112  *  into an upper echelon form.
1113  *
1114  *  @return sign is 1 if an even number of rows was swapped, -1 if an odd
1115  *  number of rows was swapped and 0 if the matrix is singular. */
1116 int matrix::division_free_elimination(void)
1117 {
1118     int sign = 1;
1119     ensure_if_modifiable();
1120     for (unsigned r1=0; r1<row-1; ++r1) {
1121         int indx = pivot(r1);
1122         if (indx==-1)
1123             return 0;  // Note: leaves *this in a messy state.
1124         if (indx>0)
1125             sign = -sign;
1126         for (unsigned r2=r1+1; r2<row; ++r2) {
1127             for (unsigned c=r1+1; c<col; ++c)
1128                 this->m[r2*col+c] = this->m[r1*col+r1]*this->m[r2*col+c] - this->m[r2*col+r1]*this->m[r1*col+c];
1129             for (unsigned c=0; c<=r1; ++c)
1130                 this->m[r2*col+c] = _ex0();
1131         }
1132     }
1133     
1134     return sign;
1135 }
1136
1137
1138 /** Perform the steps of Bareiss' one-step fraction free elimination to bring
1139  *  the matrix into an upper echelon form.
1140  *
1141  *  @return sign is 1 if an even number of rows was swapped, -1 if an odd
1142  *  number of rows was swapped and 0 if the matrix is singular. */
1143 int matrix::fraction_free_elimination(void)
1144 {
1145     int sign = 1;
1146     ex divisor = 1;
1147     
1148     ensure_if_modifiable();
1149     for (unsigned r1=0; r1<row-1; ++r1) {
1150         int indx = pivot(r1);
1151         if (indx==-1)
1152             return 0;  // Note: leaves *this in a messy state.
1153         if (indx>0)
1154             sign = -sign;
1155         if (r1>0)
1156             divisor = this->m[(r1-1)*col + (r1-1)];
1157         for (unsigned r2=r1+1; r2<row; ++r2) {
1158             for (unsigned c=r1+1; c<col; ++c)
1159                 this->m[r2*col+c] = ((this->m[r1*col+r1]*this->m[r2*col+c] - this->m[r2*col+r1]*this->m[r1*col+c])/divisor).normal();
1160             for (unsigned c=0; c<=r1; ++c)
1161                 this->m[r2*col+c] = _ex0();
1162         }
1163     }
1164     
1165     return sign;
1166 }
1167
1168
1169 /** Partial pivoting method.
1170  *  Usual pivoting (symbolic==false) returns the index to the element with the
1171  *  largest absolute value in column ro and swaps the current row with the one
1172  *  where the element was found.  With (symbolic==true) it does the same thing
1173  *  with the first non-zero element.
1174  *
1175  *  @param ro is the row to be inspected
1176  *  @param symbolic signal if we want the first non-zero element to be pivoted
1177  *  (true) or the one with the largest absolute value (false).
1178  *  @return 0 if no interchange occured, -1 if all are zero (usually signaling
1179  *  a degeneracy) and positive integer k means that rows ro and k were swapped.
1180  */
1181 int matrix::pivot(unsigned ro, bool symbolic)
1182 {
1183     unsigned k = ro;
1184     
1185     if (symbolic) {  // search first non-zero
1186         for (unsigned r=ro; r<row; ++r) {
1187             if (!m[r*col+ro].is_zero()) {
1188                 k = r;
1189                 break;
1190             }
1191         }
1192     } else {  // search largest
1193         numeric tmp(0);
1194         numeric maxn(-1);
1195         for (unsigned r=ro; r<row; ++r) {
1196             GINAC_ASSERT(is_ex_of_type(m[r*col+ro],numeric));
1197             if ((tmp = abs(ex_to_numeric(m[r*col+ro]))) > maxn &&
1198                 !tmp.is_zero()) {
1199                 maxn = tmp;
1200                 k = r;
1201             }
1202         }
1203     }
1204     if (m[k*col+ro].is_zero())
1205         return -1;
1206     if (k!=ro) {  // swap rows
1207         ensure_if_modifiable();
1208         for (unsigned c=0; c<col; ++c) {
1209             m[k*col+c].swap(m[ro*col+c]);
1210         }
1211         return k;
1212     }
1213     return 0;
1214 }
1215
1216 //////////
1217 // global constants
1218 //////////
1219
1220 const matrix some_matrix;
1221 const type_info & typeid_matrix=typeid(some_matrix);
1222
1223 #ifndef NO_NAMESPACE_GINAC
1224 } // namespace GiNaC
1225 #endif // ndef NO_NAMESPACE_GINAC