ginac/matrix.cpp

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