ginac/matrix.cpp

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