ginac/matrix.cpp

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