X-Git-Url: https://www.ginac.de/ginac.git//ginac.git?p=ginac.git;a=blobdiff_plain;f=ginac%2Fmatrix.cpp;h=872b8e006012c3a4ecf6279cf315ed8c34e5f793;hp=bacacad8889a4199c7a07576470903f6586277e7;hb=0086f1a95402fafa6333b987e3d38c72e5f402bc;hpb=24fe247f9ed16114a765a01c593fec5c4a2f591c diff --git a/ginac/matrix.cpp b/ginac/matrix.cpp index bacacad8..872b8e00 100644 --- a/ginac/matrix.cpp +++ b/ginac/matrix.cpp @@ -3,7 +3,7 @@ * Implementation of symbolic matrices */ /* - * GiNaC Copyright (C) 1999 Johannes Gutenberg University Mainz, Germany + * GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -21,223 +21,507 @@ */ #include +#include #include #include "matrix.h" +#include "numeric.h" +#include "lst.h" +#include "idx.h" +#include "indexed.h" +#include "power.h" +#include "symbol.h" +#include "normal.h" +#include "print.h" +#include "archive.h" +#include "utils.h" #include "debugmsg.h" namespace GiNaC { +GINAC_IMPLEMENT_REGISTERED_CLASS(matrix, basic) + ////////// -// default constructor, destructor, copy constructor, assignment operator -// and helpers: +// default ctor, dtor, copy ctor, assignment operator and helpers: ////////// -// public - /** Default ctor. Initializes to 1 x 1-dimensional zero-matrix. */ -matrix::matrix() - : basic(TINFO_matrix), row(1), col(1) +matrix::matrix() : inherited(TINFO_matrix), row(1), col(1) { - debugmsg("matrix default constructor",LOGLEVEL_CONSTRUCT); - m.push_back(exZERO()); + debugmsg("matrix default ctor",LOGLEVEL_CONSTRUCT); + m.push_back(_ex0()); } -matrix::~matrix() +void matrix::copy(const matrix & other) { - debugmsg("matrix destructor",LOGLEVEL_DESTRUCT); + inherited::copy(other); + row = other.row; + col = other.col; + m = other.m; // STL's vector copying invoked here } -matrix::matrix(matrix const & other) -{ - debugmsg("matrix copy constructor",LOGLEVEL_CONSTRUCT); - copy(other); -} +DEFAULT_DESTROY(matrix) -matrix const & matrix::operator=(matrix const & other) +////////// +// other ctors +////////// + +// public + +/** Very common ctor. Initializes to r x c-dimensional zero-matrix. + * + * @param r number of rows + * @param c number of cols */ +matrix::matrix(unsigned r, unsigned c) + : inherited(TINFO_matrix), row(r), col(c) { - debugmsg("matrix operator=",LOGLEVEL_ASSIGNMENT); - if (this != &other) { - destroy(1); - copy(other); - } - return *this; + debugmsg("matrix ctor from unsigned,unsigned",LOGLEVEL_CONSTRUCT); + m.resize(r*c, _ex0()); } // protected -void matrix::copy(matrix const & other) +/** Ctor from representation, for internal use only. */ +matrix::matrix(unsigned r, unsigned c, const exvector & m2) + : inherited(TINFO_matrix), row(r), col(c), m(m2) { - basic::copy(other); - row=other.row; - col=other.col; - m=other.m; // use STL's vector copying + debugmsg("matrix ctor from unsigned,unsigned,exvector",LOGLEVEL_CONSTRUCT); } -void matrix::destroy(bool call_parent) +/** Construct matrix from (flat) list of elements. If the list has fewer + * elements than the matrix, the remaining matrix elements are set to zero. + * If the list has more elements than the matrix, the excessive elements are + * thrown away. */ +matrix::matrix(unsigned r, unsigned c, const lst & l) + : inherited(TINFO_matrix), row(r), col(c) { - if (call_parent) basic::destroy(call_parent); + debugmsg("matrix ctor from unsigned,unsigned,lst",LOGLEVEL_CONSTRUCT); + m.resize(r*c, _ex0()); + + for (unsigned i=0; i= r) + break; // matrix smaller than list: throw away excessive elements + m[y*c+x] = l.op(i); + } } ////////// -// other constructors +// archiving ////////// -// public - -/** Very common ctor. Initializes to r x c-dimensional zero-matrix. - * - * @param r number of rows - * @param c number of cols */ -matrix::matrix(int r, int c) - : basic(TINFO_matrix), row(r), col(c) +matrix::matrix(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst) { - debugmsg("matrix constructor from int,int",LOGLEVEL_CONSTRUCT); - m.resize(r*c, exZERO()); + debugmsg("matrix ctor from archive_node", LOGLEVEL_CONSTRUCT); + if (!(n.find_unsigned("row", row)) || !(n.find_unsigned("col", col))) + throw (std::runtime_error("unknown matrix dimensions in archive")); + m.reserve(row * col); + for (unsigned int i=0; true; i++) { + ex e; + if (n.find_ex("m", e, sym_lst, i)) + m.push_back(e); + else + break; + } } -// protected - -/** Ctor from representation, for internal use only. */ -matrix::matrix(int r, int c, vector const & m2) - : basic(TINFO_matrix), row(r), col(c), m(m2) +void matrix::archive(archive_node &n) const { - debugmsg("matrix constructor from int,int,vector",LOGLEVEL_CONSTRUCT); + inherited::archive(n); + n.add_unsigned("row", row); + n.add_unsigned("col", col); + exvector::const_iterator i = m.begin(), iend = m.end(); + while (i != iend) { + n.add_ex("m", *i); + ++i; + } } +DEFAULT_UNARCHIVE(matrix) + ////////// // functions overriding virtual functions from bases classes ////////// // public -basic * matrix::duplicate() const +void matrix::print(const print_context & c, unsigned level) const { - debugmsg("matrix duplicate",LOGLEVEL_DUPLICATE); - return new matrix(*this); + debugmsg("matrix print", LOGLEVEL_PRINT); + + if (is_of_type(c, print_tree)) { + + inherited::print(c, level); + + } else { + + c.s << "["; + for (unsigned y=0; y tmp(row*col); - for (int i=0; i=0); + GINAC_ASSERT(i::const_iterator r=m.begin(); r!=m.end(); ++r) { - if ((*r).has(other)) return true; - } - return false; + exvector tmp(row*col); + for (unsigned i=0; i m2(row*col); - --level; - for (int r=0; rsetflag(status_flags::dynallocated | - status_flags::evaluated ); -} - -/** evaluate matrix numerically entry by entry. */ + debugmsg("matrix eval",LOGLEVEL_MEMBER_FUNCTION); + + // check if we have to do anything at all + if ((level==1)&&(flags & status_flags::evaluated)) + return *this; + + // emergency break + if (level == -max_recursion_level) + throw (std::runtime_error("matrix::eval(): recursion limit exceeded")); + + // eval() entry by entry + exvector m2(row*col); + --level; + for (unsigned r=0; rsetflag(status_flags::dynallocated | + status_flags::evaluated ); +} + +/** Evaluate matrix numerically entry by entry. */ ex matrix::evalf(int level) const { - debugmsg("matrix evalf",LOGLEVEL_MEMBER_FUNCTION); - - // check if we have to do anything at all - if (level==1) { - return *this; - } - - // emergency break - if (level == -max_recursion_level) { - throw (std::runtime_error("matrix::evalf(): recursion limit exceeded")); - } - - // evalf() entry by entry - vector m2(row*col); - --level; - for (int r=0; rbasic::subs(ls, lr, no_pattern); } // protected -int matrix::compare_same_type(basic const & other) const -{ - GINAC_ASSERT(is_exactly_of_type(other, matrix)); - matrix const & o=static_cast(const_cast(other)); - - // compare number of rows - if (row != o.rows()) { - return row < o.rows() ? -1 : 1; - } - - // compare number of columns - if (col != o.cols()) { - return col < o.cols() ? -1 : 1; - } - - // equal number of rows and columns, compare individual elements - int cmpval; - for (int r=0; r matrices are equal; - return 0; +int matrix::compare_same_type(const basic & other) const +{ + GINAC_ASSERT(is_exactly_of_type(other, matrix)); + const matrix & o = static_cast(const_cast(other)); + + // compare number of rows + if (row != o.rows()) + return row < o.rows() ? -1 : 1; + + // compare number of columns + if (col != o.cols()) + return col < o.cols() ? -1 : 1; + + // equal number of rows and columns, compare individual elements + int cmpval; + for (unsigned r=0; r matrices are equal; + return 0; +} + +/** Automatic symbolic evaluation of an indexed matrix. */ +ex matrix::eval_indexed(const basic & i) const +{ + GINAC_ASSERT(is_of_type(i, indexed)); + GINAC_ASSERT(is_ex_of_type(i.op(0), matrix)); + + bool all_indices_unsigned = static_cast(i).all_index_values_are(info_flags::nonnegint); + + // Check indices + if (i.nops() == 2) { + + // One index, must be one-dimensional vector + if (row != 1 && col != 1) + throw (std::runtime_error("matrix::eval_indexed(): vector must have exactly 1 index")); + + const idx & i1 = ex_to_idx(i.op(1)); + + if (col == 1) { + + // Column vector + if (!i1.get_dim().is_equal(row)) + throw (std::runtime_error("matrix::eval_indexed(): dimension of index must match number of vector elements")); + + // Index numeric -> return vector element + if (all_indices_unsigned) { + unsigned n1 = ex_to_numeric(i1.get_value()).to_int(); + if (n1 >= row) + throw (std::runtime_error("matrix::eval_indexed(): value of index exceeds number of vector elements")); + return (*this)(n1, 0); + } + + } else { + + // Row vector + if (!i1.get_dim().is_equal(col)) + throw (std::runtime_error("matrix::eval_indexed(): dimension of index must match number of vector elements")); + + // Index numeric -> return vector element + if (all_indices_unsigned) { + unsigned n1 = ex_to_numeric(i1.get_value()).to_int(); + if (n1 >= col) + throw (std::runtime_error("matrix::eval_indexed(): value of index exceeds number of vector elements")); + return (*this)(0, n1); + } + } + + } else if (i.nops() == 3) { + + // Two indices + const idx & i1 = ex_to_idx(i.op(1)); + const idx & i2 = ex_to_idx(i.op(2)); + + if (!i1.get_dim().is_equal(row)) + throw (std::runtime_error("matrix::eval_indexed(): dimension of first index must match number of rows")); + if (!i2.get_dim().is_equal(col)) + throw (std::runtime_error("matrix::eval_indexed(): dimension of second index must match number of columns")); + + // Pair of dummy indices -> compute trace + if (is_dummy_pair(i1, i2)) + return trace(); + + // Both indices numeric -> return matrix element + if (all_indices_unsigned) { + unsigned n1 = ex_to_numeric(i1.get_value()).to_int(), n2 = ex_to_numeric(i2.get_value()).to_int(); + if (n1 >= row) + throw (std::runtime_error("matrix::eval_indexed(): value of first index exceeds number of rows")); + if (n2 >= col) + throw (std::runtime_error("matrix::eval_indexed(): value of second index exceeds number of columns")); + return (*this)(n1, n2); + } + + } else + throw (std::runtime_error("matrix::eval_indexed(): matrix must have exactly 2 indices")); + + return i.hold(); +} + +/** Sum of two indexed matrices. */ +ex matrix::add_indexed(const ex & self, const ex & other) const +{ + GINAC_ASSERT(is_ex_of_type(self, indexed)); + GINAC_ASSERT(is_ex_of_type(self.op(0), matrix)); + GINAC_ASSERT(is_ex_of_type(other, indexed)); + GINAC_ASSERT(self.nops() == 2 || self.nops() == 3); + + // Only add two matrices + if (is_ex_of_type(other.op(0), matrix)) { + GINAC_ASSERT(other.nops() == 2 || other.nops() == 3); + + const matrix &self_matrix = ex_to_matrix(self.op(0)); + const matrix &other_matrix = ex_to_matrix(other.op(0)); + + if (self.nops() == 2 && other.nops() == 2) { // vector + vector + + if (self_matrix.row == other_matrix.row) + return indexed(self_matrix.add(other_matrix), self.op(1)); + else if (self_matrix.row == other_matrix.col) + return indexed(self_matrix.add(other_matrix.transpose()), self.op(1)); + + } else if (self.nops() == 3 && other.nops() == 3) { // matrix + matrix + + if (self.op(1).is_equal(other.op(1)) && self.op(2).is_equal(other.op(2))) + return indexed(self_matrix.add(other_matrix), self.op(1), self.op(2)); + else if (self.op(1).is_equal(other.op(2)) && self.op(2).is_equal(other.op(1))) + return indexed(self_matrix.add(other_matrix.transpose()), self.op(1), self.op(2)); + + } + } + + // Don't know what to do, return unevaluated sum + return self + other; +} + +/** Product of an indexed matrix with a number. */ +ex matrix::scalar_mul_indexed(const ex & self, const numeric & other) const +{ + GINAC_ASSERT(is_ex_of_type(self, indexed)); + GINAC_ASSERT(is_ex_of_type(self.op(0), matrix)); + GINAC_ASSERT(self.nops() == 2 || self.nops() == 3); + + const matrix &self_matrix = ex_to_matrix(self.op(0)); + + if (self.nops() == 2) + return indexed(self_matrix.mul(other), self.op(1)); + else // self.nops() == 3 + return indexed(self_matrix.mul(other), self.op(1), self.op(2)); +} + +/** Contraction of an indexed matrix with something else. */ +bool matrix::contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const +{ + GINAC_ASSERT(is_ex_of_type(*self, indexed)); + GINAC_ASSERT(is_ex_of_type(*other, indexed)); + GINAC_ASSERT(self->nops() == 2 || self->nops() == 3); + GINAC_ASSERT(is_ex_of_type(self->op(0), matrix)); + + // Only contract with other matrices + if (!is_ex_of_type(other->op(0), matrix)) + return false; + + GINAC_ASSERT(other->nops() == 2 || other->nops() == 3); + + const matrix &self_matrix = ex_to_matrix(self->op(0)); + const matrix &other_matrix = ex_to_matrix(other->op(0)); + + if (self->nops() == 2) { + unsigned self_dim = (self_matrix.col == 1) ? self_matrix.row : self_matrix.col; + + if (other->nops() == 2) { // vector * vector (scalar product) + unsigned other_dim = (other_matrix.col == 1) ? other_matrix.row : other_matrix.col; + + if (self_matrix.col == 1) { + if (other_matrix.col == 1) { + // Column vector * column vector, transpose first vector + *self = self_matrix.transpose().mul(other_matrix)(0, 0); + } else { + // Column vector * row vector, swap factors + *self = other_matrix.mul(self_matrix)(0, 0); + } + } else { + if (other_matrix.col == 1) { + // Row vector * column vector, perfect + *self = self_matrix.mul(other_matrix)(0, 0); + } else { + // Row vector * row vector, transpose second vector + *self = self_matrix.mul(other_matrix.transpose())(0, 0); + } + } + *other = _ex1(); + return true; + + } else { // vector * matrix + + // B_i * A_ij = (B*A)_j (B is row vector) + if (is_dummy_pair(self->op(1), other->op(1))) { + if (self_matrix.row == 1) + *self = indexed(self_matrix.mul(other_matrix), other->op(2)); + else + *self = indexed(self_matrix.transpose().mul(other_matrix), other->op(2)); + *other = _ex1(); + return true; + } + + // B_j * A_ij = (A*B)_i (B is column vector) + if (is_dummy_pair(self->op(1), other->op(2))) { + if (self_matrix.col == 1) + *self = indexed(other_matrix.mul(self_matrix), other->op(1)); + else + *self = indexed(other_matrix.mul(self_matrix.transpose()), other->op(1)); + *other = _ex1(); + return true; + } + } + + } else if (other->nops() == 3) { // matrix * matrix + + // A_ij * B_jk = (A*B)_ik + if (is_dummy_pair(self->op(2), other->op(1))) { + *self = indexed(self_matrix.mul(other_matrix), self->op(1), other->op(2)); + *other = _ex1(); + return true; + } + + // A_ij * B_kj = (A*Btrans)_ik + if (is_dummy_pair(self->op(2), other->op(2))) { + *self = indexed(self_matrix.mul(other_matrix.transpose()), self->op(1), other->op(1)); + *other = _ex1(); + return true; + } + + // A_ji * B_jk = (Atrans*B)_ik + if (is_dummy_pair(self->op(1), other->op(1))) { + *self = indexed(self_matrix.transpose().mul(other_matrix), self->op(2), other->op(2)); + *other = _ex1(); + return true; + } + + // A_ji * B_kj = (B*A)_ki + if (is_dummy_pair(self->op(1), other->op(2))) { + *self = indexed(other_matrix.mul(self_matrix), other->op(1), self->op(2)); + *other = _ex1(); + return true; + } + } + + return false; } + ////////// // non-virtual functions in this class ////////// @@ -247,316 +531,384 @@ int matrix::compare_same_type(basic const & other) const /** Sum of matrices. * * @exception logic_error (incompatible matrices) */ -matrix matrix::add(matrix const & other) const -{ - if (col != other.col || row != other.row) { - throw (std::logic_error("matrix::add(): incompatible matrices")); - } - - vector sum(this->m); - vector::iterator i; - vector::const_iterator ci; - for (i=sum.begin(), ci=other.m.begin(); - i!=sum.end(); - ++i, ++ci) { - (*i) += (*ci); - } - return matrix(row,col,sum); +matrix matrix::add(const matrix & other) const +{ + if (col != other.col || row != other.row) + throw std::logic_error("matrix::add(): incompatible matrices"); + + exvector sum(this->m); + exvector::iterator i; + exvector::const_iterator ci; + for (i=sum.begin(), ci=other.m.begin(); i!=sum.end(); ++i, ++ci) + (*i) += (*ci); + + return matrix(row,col,sum); } + /** Difference of matrices. * * @exception logic_error (incompatible matrices) */ -matrix matrix::sub(matrix const & other) const -{ - if (col != other.col || row != other.row) { - throw (std::logic_error("matrix::sub(): incompatible matrices")); - } - - vector dif(this->m); - vector::iterator i; - vector::const_iterator ci; - for (i=dif.begin(), ci=other.m.begin(); - i!=dif.end(); - ++i, ++ci) { - (*i) -= (*ci); - } - return matrix(row,col,dif); +matrix matrix::sub(const matrix & other) const +{ + if (col != other.col || row != other.row) + throw std::logic_error("matrix::sub(): incompatible matrices"); + + exvector dif(this->m); + exvector::iterator i; + exvector::const_iterator ci; + for (i=dif.begin(), ci=other.m.begin(); i!=dif.end(); ++i, ++ci) + (*i) -= (*ci); + + return matrix(row,col,dif); } + /** Product of matrices. * * @exception logic_error (incompatible matrices) */ -matrix matrix::mul(matrix const & other) const -{ - if (col != other.row) { - throw (std::logic_error("matrix::mul(): incompatible matrices")); - } - - vector prod(row*other.col); - for (int i=0; icols() != other.rows()) + throw std::logic_error("matrix::mul(): incompatible matrices"); + + exvector prod(this->rows()*other.cols()); + + for (unsigned r1=0; r1rows(); ++r1) { + for (unsigned c=0; ccols(); ++c) { + if (m[r1*col+c].is_zero()) + continue; + for (unsigned r2=0; r2inverse(); + } else { + k = ex_to_numeric(expn); + prod = *this; + } + matrix result(row,col); + for (unsigned r=0; r=row || co<0 || co>=col) { - throw (std::range_error("matrix::operator(): index out of range")); - } - - return m[ro*col+co]; + if (ro>=row || co>=col) + throw (std::range_error("matrix::operator(): index out of range")); + + return m[ro*col+co]; } -/** Set individual elements manually. + +/** operator() to access elements for writing. * + * @param ro row of element + * @param co column of element * @exception range_error (index out of range) */ -matrix & matrix::set(int ro, int co, ex value) +ex & matrix::operator() (unsigned ro, unsigned co) { - if (ro<0 || ro>=row || co<0 || co>=col) { - throw (std::range_error("matrix::set(): index out of range")); - } - - ensure_if_modifiable(); - m[ro*col+co]=value; - return *this; + if (ro>=row || co>=col) + throw (std::range_error("matrix::operator(): index out of range")); + + ensure_if_modifiable(); + clearflag(status_flags::hash_calculated); + return m[ro*col+co]; } + /** Transposed of an m x n matrix, producing a new n x m matrix object that * represents the transposed. */ matrix matrix::transpose(void) const { - vector trans(col*row); - - for (int r=0; r -int permutation_sign(vector s) -{ - if (s.size() < 2) - return 0; - int sigma=1; - for (typename vector::iterator i=s.begin(); i!=s.end()-1; ++i) { - for (typename vector::iterator j=i+1; j!=s.end(); ++j) { - if (*i == *j) - return 0; - if (*i > *j) { - iter_swap(i,j); - sigma = -sigma; - } - } - } - return sigma; -} - -/** Determinant built by application of the full permutation group. This - * routine is only called internally by matrix::determinant(). */ -ex determinant_symbolic_perm(const matrix & M) -{ - GINAC_ASSERT(M.rows()==M.cols()); // cannot happen, just in case... - - if (M.rows()==1) { // speed things up - return M(0,0); - } - - ex det; - ex term; - vector sigma(M.cols()); - for (int i=0; icols()*this->rows()); + + for (unsigned r=0; rcols(); ++r) + for (unsigned c=0; crows(); ++c) + trans[r*this->rows()+c] = m[c*this->cols()+r]; + + return matrix(this->cols(),this->rows(),trans); +} /** Determinant of square matrix. This routine doesn't actually calculate the * determinant, it only implements some heuristics about which algorithm to - * call. When the parameter for normalization is explicitly turned off this - * method does not normalize its result at the end, which might imply that - * the symbolic 2x2 matrix [[a/(a-b),1],[b/(a-b),1]] is not immediatly - * recognized to be unity. (This is Mathematica's default behaviour, it - * should be used with care.) + * run. If all the elements of the matrix are elements of an integral domain + * the determinant is also in that integral domain and the result is expanded + * only. If one or more elements are from a quotient field the determinant is + * usually also in that quotient field and the result is normalized before it + * is returned. This implies that the determinant of the symbolic 2x2 matrix + * [[a/(a-b),1],[b/(a-b),1]] is returned as unity. (In this respect, it + * behaves like MapleV and unlike Mathematica.) * - * @param normalized may be set to false if no normalization of the - * result is desired (i.e. to force Mathematica behavior, Maple - * does normalize the result). + * @param algo allows to chose an algorithm * @return the determinant as a new expression - * @exception logic_error (matrix not square) */ -ex matrix::determinant(bool normalized) const -{ - if (row != col) { - throw (std::logic_error("matrix::determinant(): matrix not square")); - } - - // check, if there are non-numeric entries in the matrix: - for (vector::const_iterator r=m.begin(); r!=m.end(); ++r) { - if (!(*r).info(info_flags::numeric)) { - if (normalized) { - return determinant_symbolic_minor(*this).normal(); - } else { - return determinant_symbolic_perm(*this); - } - } - } - // if it turns out that all elements are numeric - return determinant_numeric(*this); -} - -/** Trace of a matrix. + * @exception logic_error (matrix not square) + * @see determinant_algo */ +ex matrix::determinant(unsigned algo) const +{ + if (row!=col) + throw (std::logic_error("matrix::determinant(): matrix not square")); + GINAC_ASSERT(row*col==m.capacity()); + + // Gather some statistical information about this matrix: + bool numeric_flag = true; + bool normal_flag = false; + unsigned sparse_count = 0; // counts non-zero elements + for (exvector::const_iterator r=m.begin(); r!=m.end(); ++r) { + lst srl; // symbol replacement list + ex rtest = (*r).to_rational(srl); + if (!rtest.is_zero()) + ++sparse_count; + if (!rtest.info(info_flags::numeric)) + numeric_flag = false; + if (!rtest.info(info_flags::crational_polynomial) && + rtest.info(info_flags::rational_function)) + normal_flag = true; + } + + // Here is the heuristics in case this routine has to decide: + if (algo == determinant_algo::automatic) { + // Minor expansion is generally a good guess: + algo = determinant_algo::laplace; + // Does anybody know when a matrix is really sparse? + // Maybe <~row/2.236 nonzero elements average in a row? + if (row>3 && 5*sparse_count<=row*col) + algo = determinant_algo::bareiss; + // Purely numeric matrix can be handled by Gauss elimination. + // This overrides any prior decisions. + if (numeric_flag) + algo = determinant_algo::gauss; + } + + // Trap the trivial case here, since some algorithms don't like it + if (this->row==1) { + // for consistency with non-trivial determinants... + if (normal_flag) + return m[0].normal(); + else + return m[0].expand(); + } + + // Compute the determinant + switch(algo) { + case determinant_algo::gauss: { + ex det = 1; + matrix tmp(*this); + int sign = tmp.gauss_elimination(true); + for (unsigned d=0; d uintpair; + std::vector c_zeros; // number of zeros in column + for (unsigned c=0; c pre_sort; + for (std::vector::iterator i=c_zeros.begin(); i!=c_zeros.end(); ++i) + pre_sort.push_back(i->second); + std::vector pre_sort_test(pre_sort); // permutation_sign() modifies the vector so we make a copy here + int sign = permutation_sign(pre_sort_test.begin(), pre_sort_test.end()); + exvector result(row*col); // represents sorted matrix + unsigned c = 0; + for (std::vector::iterator i=pre_sort.begin(); + i!=pre_sort.end(); + ++i,++c) { + for (unsigned r=0; rmul(B); + c = B.trace()/ex(i+1); + poly -= c*power(lambda,row-i-1); + } + if (row%2) + return -poly; + else + return poly; + } + + matrix M(*this); + for (unsigned r=0; rsolve(vars,identity); + } catch (const std::runtime_error & e) { + if (e.what()==std::string("matrix::solve(): inconsistent linear system")) + throw (std::runtime_error("matrix::inverse(): singular matrix")); + else + throw; + } + return sol; +} + + +/** Solve a linear system consisting of a m x n matrix and a m x p right hand + * side by applying an elimination scheme to the augmented matrix. * - * @param vars n x p matrix + * @param vars n x p matrix, all elements must be symbols * @param rhs m x p matrix + * @return n x p solution matrix * @exception logic_error (incompatible matrices) - * @exception runtime_error (singular matrix) */ -matrix matrix::fraction_free_elim(matrix const & vars, - matrix const & rhs) const -{ - if ((row != rhs.row) || (col != vars.row) || (rhs.col != vars.col)) { - throw (std::logic_error("matrix::solve(): incompatible matrices")); - } - - matrix a(*this); // make a copy of the matrix - matrix b(rhs); // make a copy of the rhs vector - - // given an m x n matrix a, reduce it to upper echelon form - int m=a.row; - int n=a.col; - int sign=1; - ex divisor=1; - int r=1; - - // eliminate below row r, with pivot in column k - for (int k=1; (k<=n)&&(r<=m); ++k) { - // find a nonzero pivot - int p; - for (p=r; (p<=m)&&(a.ffe_get(p,k).is_equal(exZERO())); ++p) {} - // pivot is in row p - if (p<=m) { - if (p!=r) { - // switch rows p and r - for (int j=k; j<=n; ++j) { - a.ffe_swap(p,j,r,j); - } - b.ffe_swap(p,1,r,1); - // keep track of sign changes due to row exchange - sign=-sign; - } - for (int i=r+1; i<=m; ++i) { - for (int j=k+1; j<=n; ++j) { - a.ffe_set(i,j,(a.ffe_get(r,k)*a.ffe_get(i,j) - -a.ffe_get(r,j)*a.ffe_get(i,k))/divisor); - a.ffe_set(i,j,a.ffe_get(i,j).normal() /*.normal() */ ); - } - b.ffe_set(i,1,(a.ffe_get(r,k)*b.ffe_get(i,1) - -b.ffe_get(r,1)*a.ffe_get(i,k))/divisor); - b.ffe_set(i,1,b.ffe_get(i,1).normal() /*.normal() */ ); - a.ffe_set(i,k,0); - } - divisor=a.ffe_get(r,k); - r++; - } - } - // optionally compute the determinant for square or augmented matrices - // if (r==m+1) { det=sign*divisor; } else { det=0; } - - /* - for (int r=1; r<=m; ++r) { - for (int c=1; c<=n; ++c) { - cout << a.ffe_get(r,c) << "\t"; - } - cout << " | " << b.ffe_get(r,1) << endl; - } - */ - -#ifdef DO_GINAC_ASSERT - // test if we really have an upper echelon matrix - int zero_in_last_row=-1; - for (int r=1; r<=m; ++r) { - int zero_in_this_row=0; - for (int c=1; c<=n; ++c) { - if (a.ffe_get(r,c).is_equal(exZERO())) { - zero_in_this_row++; - } else { - break; - } - } - GINAC_ASSERT((zero_in_this_row>zero_in_last_row)||(zero_in_this_row=n)); - zero_in_last_row=zero_in_this_row; - } -#endif // def DO_GINAC_ASSERT - - // assemble solution - matrix sol(n,1); - int last_assigned_sol=n+1; - for (int r=m; r>0; --r) { - int first_non_zero=1; - while ((first_non_zero<=n)&&(a.ffe_get(r,first_non_zero).is_zero())) { - first_non_zero++; - } - if (first_non_zero>n) { - // row consists only of zeroes, corresponding rhs must be 0 as well - if (!b.ffe_get(r,1).is_zero()) { - throw (std::runtime_error("matrix::fraction_free_elim(): singular matrix")); - } - } else { - // assign solutions for vars between first_non_zero+1 and - // last_assigned_sol-1: free parameters - for (int c=first_non_zero+1; c<=last_assigned_sol-1; ++c) { - sol.ffe_set(c,1,vars.ffe_get(c,1)); - } - ex e=b.ffe_get(r,1); - for (int c=first_non_zero+1; c<=n; ++c) { - e=e-a.ffe_get(r,c)*sol.ffe_get(c,1); - } - sol.ffe_set(first_non_zero,1, - (e/a.ffe_get(r,first_non_zero)).normal()); - last_assigned_sol=first_non_zero; - } - } - // assign solutions for vars between 1 and - // last_assigned_sol-1: free parameters - for (int c=1; c<=last_assigned_sol-1; ++c) { - sol.ffe_set(c,1,vars.ffe_get(c,1)); - } - - /* - for (int c=1; c<=n; ++c) { - cout << vars.ffe_get(c,1) << "->" << sol.ffe_get(c,1) << endl; - } - */ - -#ifdef DO_GINAC_ASSERT - // test solution with echelon matrix - for (int r=1; r<=m; ++r) { - ex e=0; - for (int c=1; c<=n; ++c) { - e=e+a.ffe_get(r,c)*sol.ffe_get(c,1); - } - if (!(e-b.ffe_get(r,1)).normal().is_zero()) { - cout << "e=" << e; - cout << "b.ffe_get(" << r<<",1)=" << b.ffe_get(r,1) << endl; - cout << "diff=" << (e-b.ffe_get(r,1)).normal() << endl; - } - GINAC_ASSERT((e-b.ffe_get(r,1)).normal().is_zero()); - } - - // test solution with original matrix - for (int r=1; r<=m; ++r) { - ex e=0; - for (int c=1; c<=n; ++c) { - e=e+ffe_get(r,c)*sol.ffe_get(c,1); - } - try { - if (!(e-rhs.ffe_get(r,1)).normal().is_zero()) { - cout << "e=" << e << endl; - e.printtree(cout); - ex en=e.normal(); - cout << "e.normal()=" << en << endl; - en.printtree(cout); - cout << "rhs.ffe_get(" << r<<",1)=" << rhs.ffe_get(r,1) << endl; - cout << "diff=" << (e-rhs.ffe_get(r,1)).normal() << endl; - } - } catch (...) { - ex xxx=e-rhs.ffe_get(r,1); - cerr << "xxx=" << xxx << endl << endl; - } - GINAC_ASSERT((e-rhs.ffe_get(r,1)).normal().is_zero()); - } -#endif // def DO_GINAC_ASSERT - - return sol; -} - -/** Solve simultaneous set of equations. */ -matrix matrix::solve(matrix const & v) const -{ - if (!(row == col && col == v.row)) { - throw (std::logic_error("matrix::solve(): incompatible matrices")); - } - - // build the extended matrix of *this with v attached to the right - matrix tmp(row,col+v.col); - for (int r=0; r sol(v.row*v.col); - for (int c=0; c=0; --r) { - sol[r*v.col+c] = tmp[r*tmp.col+c]; - for (int i=r+1; irows(); + const unsigned n = this->cols(); + const unsigned p = rhs.cols(); + + // syntax checks + if ((rhs.rows() != m) || (vars.rows() != n) || (vars.col != p)) + throw (std::logic_error("matrix::solve(): incompatible matrices")); + for (unsigned ro=0; rom[r*n+c]; + for (unsigned c=0; c=0; --r) { + unsigned fnz = 1; // first non-zero in row + while ((fnz<=n) && (aug.m[r*(n+p)+(fnz-1)].is_zero())) + ++fnz; + if (fnz>n) { + // row consists only of zeros, corresponding rhs must be 0, too + if (!aug.m[r*(n+p)+n+co].is_zero()) { + throw (std::runtime_error("matrix::solve(): inconsistent linear system")); + } + } else { + // assign solutions for vars between fnz+1 and + // last_assigned_sol-1: free parameters + for (unsigned c=fnz; ccols(); + if (n==1) + return m[0].expand(); + if (n==2) + return (m[0]*m[3]-m[2]*m[1]).expand(); + if (n==3) + return (m[0]*m[4]*m[8]-m[0]*m[5]*m[7]- + m[1]*m[3]*m[8]+m[2]*m[3]*m[7]+ + m[1]*m[5]*m[6]-m[2]*m[4]*m[6]).expand(); + + // This algorithm can best be understood by looking at a naive + // implementation of Laplace-expansion, like this one: + // ex det; + // matrix minorM(this->rows()-1,this->cols()-1); + // for (unsigned r1=0; r1rows(); ++r1) { + // // shortcut if element(r1,0) vanishes + // if (m[r1*col].is_zero()) + // continue; + // // assemble the minor matrix + // for (unsigned r=0; r Pkey; + Pkey.reserve(n); + // key for minor determinant (a subpartition of Pkey) + std::vector Mkey; + Mkey.reserve(n-1); + // we store our subminors in maps, keys being the rows they arise from + typedef std::map,class ex> Rmap; + typedef std::map,class ex>::value_type Rmap_value; + Rmap A; + Rmap B; + ex det; + // initialize A with last column: + for (unsigned r=0; r=0; --c) { + Pkey.erase(Pkey.begin(),Pkey.end()); // don't change capacity + Mkey.erase(Mkey.begin(),Mkey.end()); + for (unsigned i=0; i0; --fc) { + ++Pkey[fc-1]; + if (Pkey[fc-1]0) + for (unsigned j=fc; jrows(); + const unsigned n = this->cols(); + GINAC_ASSERT(!det || n==m); + int sign = 1; + + unsigned r0 = 0; + for (unsigned r1=0; (r1=0) { + if (indx > 0) + sign = -sign; + for (unsigned r2=r0+1; r2m[r2*n+r1].is_zero()) { + // yes, there is something to do in this row + ex piv = this->m[r2*n+r1] / this->m[r0*n+r1]; + for (unsigned c=r1+1; cm[r2*n+c] -= piv * this->m[r0*n+c]; + if (!this->m[r2*n+c].info(info_flags::numeric)) + this->m[r2*n+c] = this->m[r2*n+c].normal(); + } + } + // fill up left hand side with zeros + for (unsigned c=0; c<=r1; ++c) + this->m[r2*n+c] = _ex0(); + } + if (det) { + // save space by deleting no longer needed elements + for (unsigned c=r0+1; cm[r0*n+c] = _ex0(); + } + ++r0; + } + } + + return sign; } -////////// -// global constants -////////// -const matrix some_matrix; -type_info const & typeid_matrix=typeid(some_matrix); +/** Perform the steps of division free elimination to bring the m x n matrix + * into an upper echelon form. + * + * @param det may be set to true to save a lot of space if one is only + * interested in the diagonal elements (i.e. for calculating determinants). + * The others are set to zero in this case. + * @return sign is 1 if an even number of rows was swapped, -1 if an odd + * number of rows was swapped and 0 if the matrix is singular. */ +int matrix::division_free_elimination(const bool det) +{ + ensure_if_modifiable(); + const unsigned m = this->rows(); + const unsigned n = this->cols(); + GINAC_ASSERT(!det || n==m); + int sign = 1; + + unsigned r0 = 0; + for (unsigned r1=0; (r1=0) { + if (indx>0) + sign = -sign; + for (unsigned r2=r0+1; r2m[r2*n+c] = (this->m[r0*n+r1]*this->m[r2*n+c] - this->m[r2*n+r1]*this->m[r0*n+c]).expand(); + // fill up left hand side with zeros + for (unsigned c=0; c<=r1; ++c) + this->m[r2*n+c] = _ex0(); + } + if (det) { + // save space by deleting no longer needed elements + for (unsigned c=r0+1; cm[r0*n+c] = _ex0(); + } + ++r0; + } + } + + return sign; +} + + +/** Perform the steps of Bareiss' one-step fraction free elimination to bring + * the matrix into an upper echelon form. Fraction free elimination means + * that divide is used straightforwardly, without computing GCDs first. This + * is possible, since we know the divisor at each step. + * + * @param det may be set to true to save a lot of space if one is only + * interested in the last element (i.e. for calculating determinants). The + * others are set to zero in this case. + * @return sign is 1 if an even number of rows was swapped, -1 if an odd + * number of rows was swapped and 0 if the matrix is singular. */ +int matrix::fraction_free_elimination(const bool det) +{ + // Method: + // (single-step fraction free elimination scheme, already known to Jordan) + // + // Usual division-free elimination sets m[0](r,c) = m(r,c) and then sets + // m[k+1](r,c) = m[k](k,k) * m[k](r,c) - m[k](r,k) * m[k](k,c). + // + // Bareiss (fraction-free) elimination in addition divides that element + // by m[k-1](k-1,k-1) for k>1, where it can be shown by means of the + // Sylvester determinant that this really divides m[k+1](r,c). + // + // We also allow rational functions where the original prove still holds. + // However, we must care for numerator and denominator separately and + // "manually" work in the integral domains because of subtle cancellations + // (see below). This blows up the bookkeeping a bit and the formula has + // to be modified to expand like this (N{x} stands for numerator of x, + // D{x} for denominator of x): + // 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)} + // -N{m[k](r,k)}*N{m[k](k,c)}*D{m[k](k,k)}*D{m[k](r,c)} + // 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)} + // where for k>1 we now divide N{m[k+1](r,c)} by + // N{m[k-1](k-1,k-1)} + // and D{m[k+1](r,c)} by + // D{m[k-1](k-1,k-1)}. + + ensure_if_modifiable(); + const unsigned m = this->rows(); + const unsigned n = this->cols(); + GINAC_ASSERT(!det || n==m); + int sign = 1; + if (m==1) + return 1; + ex divisor_n = 1; + ex divisor_d = 1; + ex dividend_n; + ex dividend_d; + + // We populate temporary matrices to subsequently operate on. There is + // one holding numerators and another holding denominators of entries. + // This is a must since the evaluator (or even earlier mul's constructor) + // might cancel some trivial element which causes divide() to fail. The + // elements are normalized first (yes, even though this algorithm doesn't + // need GCDs) since the elements of *this might be unnormalized, which + // makes things more complicated than they need to be. + matrix tmp_n(*this); + matrix tmp_d(m,n); // for denominators, if needed + lst srl; // symbol replacement list + exvector::iterator it = this->m.begin(); + exvector::iterator tmp_n_it = tmp_n.m.begin(); + exvector::iterator tmp_d_it = tmp_d.m.begin(); + for (; it!= this->m.end(); ++it, ++tmp_n_it, ++tmp_d_it) { + (*tmp_n_it) = (*it).normal().to_rational(srl); + (*tmp_d_it) = (*tmp_n_it).denom(); + (*tmp_n_it) = (*tmp_n_it).numer(); + } + + unsigned r0 = 0; + for (unsigned r1=0; (r1=0) { + if (indx>0) { + sign = -sign; + // tmp_n's rows r0 and indx were swapped, do the same in tmp_d: + for (unsigned c=r1; cm.begin(); + tmp_n_it = tmp_n.m.begin(); + tmp_d_it = tmp_d.m.begin(); + for (; it!= this->m.end(); ++it, ++tmp_n_it, ++tmp_d_it) + (*it) = ((*tmp_n_it)/(*tmp_d_it)).subs(srl); + + return sign; +} + + +/** Partial pivoting method for matrix elimination schemes. + * Usual pivoting (symbolic==false) returns the index to the element with the + * largest absolute value in column ro and swaps the current row with the one + * where the element was found. With (symbolic==true) it does the same thing + * with the first non-zero element. + * + * @param ro is the row from where to begin + * @param co is the column to be inspected + * @param symbolic signal if we want the first non-zero element to be pivoted + * (true) or the one with the largest absolute value (false). + * @return 0 if no interchange occured, -1 if all are zero (usually signaling + * a degeneracy) and positive integer k means that rows ro and k were swapped. + */ +int matrix::pivot(unsigned ro, unsigned co, bool symbolic) +{ + unsigned k = ro; + if (symbolic) { + // search first non-zero element in column co beginning at row ro + while ((km[k*col+co].expand().is_zero())) + ++k; + } else { + // search largest element in column co beginning at row ro + GINAC_ASSERT(is_ex_of_type(this->m[k*col+co],numeric)); + unsigned kmax = k+1; + numeric mmax = abs(ex_to_numeric(m[kmax*col+co])); + while (kmaxm[kmax*col+co],numeric)); + numeric tmp = ex_to_numeric(this->m[kmax*col+co]); + if (abs(tmp) > mmax) { + mmax = tmp; + k = kmax; + } + ++kmax; + } + if (!mmax.is_zero()) + k = kmax; + } + if (k==row) + // all elements in column co below row ro vanish + return -1; + if (k==ro) + // matrix needs no pivoting + return 0; + // matrix needs pivoting, so swap rows k and ro + ensure_if_modifiable(); + for (unsigned c=0; cm[k*col+c].swap(this->m[ro*col+c]); + + return k; +} + +ex lst_to_matrix(const lst & l) +{ + // Find number of rows and columns + unsigned rows = l.nops(), cols = 0, i, j; + for (i=0; i cols) + cols = l.op(i).nops(); + + // Allocate and fill matrix + matrix &m = *new matrix(rows, cols); + m.setflag(status_flags::dynallocated); + for (i=0; i j) + m(i, j) = l.op(i).op(j); + else + m(i, j) = _ex0(); + return m; +} + +ex diag_matrix(const lst & l) +{ + unsigned dim = l.nops(); + + matrix &m = *new matrix(dim, dim); + m.setflag(status_flags::dynallocated); + for (unsigned i=0; i