ginac/matrix.cpp

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