ginac/matrix.cpp

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