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