3 * Interface to symbolic matrices */
6 * GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
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.
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.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 #ifndef __GINAC_MATRIX_H__
24 #define __GINAC_MATRIX_H__
32 /** Symbolic matrices. */
33 class matrix : public basic
35 GINAC_DECLARE_REGISTERED_CLASS(matrix, basic)
39 matrix(unsigned r, unsigned c);
40 matrix(unsigned r, unsigned c, const exvector & m2);
41 matrix(unsigned r, unsigned c, const lst & l);
43 // functions overriding virtual functions from bases classes
45 void print(const print_context & c, unsigned level = 0) const;
46 unsigned nops() const;
49 ex expand(unsigned options=0) const;
50 bool has(const ex & other) const;
51 ex eval(int level=0) const;
52 ex evalf(int level=0) const;
53 ex subs(const lst & ls, const lst & lr) const;
54 ex eval_indexed(const basic & i) const;
55 ex add_indexed(const ex & self, const ex & other) const;
56 ex scalar_mul_indexed(const ex & self, const numeric & other) const;
57 bool contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const;
59 unsigned return_type(void) const { return return_types::noncommutative; };
60 // new virtual functions which can be overridden by derived classes
63 // non-virtual functions in this class
65 unsigned rows(void) const /// Get number of rows.
67 unsigned cols(void) const /// Get number of columns.
69 matrix add(const matrix & other) const;
70 matrix sub(const matrix & other) const;
71 matrix mul(const matrix & other) const;
72 matrix mul(const numeric & other) const;
73 const ex & operator() (unsigned ro, unsigned co) const;
74 matrix & set(unsigned ro, unsigned co, ex value);
75 matrix transpose(void) const;
76 ex determinant(unsigned algo = determinant_algo::automatic) const;
78 ex charpoly(const symbol & lambda) const;
79 matrix inverse(void) const;
80 matrix solve(const matrix & vars, const matrix & rhs,
81 unsigned algo = solve_algo::automatic) const;
83 ex determinant_minor(void) const;
84 int gauss_elimination(const bool det = false);
85 int division_free_elimination(const bool det = false);
86 int fraction_free_elimination(const bool det = false);
87 int pivot(unsigned ro, unsigned co, bool symbolic = true);
91 unsigned row; ///< number of rows
92 unsigned col; ///< number of columns
93 exvector m; ///< representation (cols indexed first)
94 static unsigned precedence;
98 // wrapper functions around member functions
100 inline unsigned nops(const matrix & m)
103 inline ex expand(const matrix & m, unsigned options = 0)
104 { return m.expand(options); }
106 inline bool has(const matrix & m, const ex & other)
107 { return m.has(other); }
109 inline ex eval(const matrix & m, int level = 0)
110 { return m.eval(level); }
112 inline ex evalf(const matrix & m, int level = 0)
113 { return m.evalf(level); }
115 inline unsigned rows(const matrix & m)
118 inline unsigned cols(const matrix & m)
121 inline matrix transpose(const matrix & m)
122 { return m.transpose(); }
124 inline ex determinant(const matrix & m, unsigned options = determinant_algo::automatic)
125 { return m.determinant(options); }
127 inline ex trace(const matrix & m)
128 { return m.trace(); }
130 inline ex charpoly(const matrix & m, const symbol & lambda)
131 { return m.charpoly(lambda); }
133 inline matrix inverse(const matrix & m)
134 { return m.inverse(); }
137 inline const matrix &ex_to_matrix(const ex &e)
139 return static_cast<const matrix &>(*e.bp);
142 /** Convert list of lists to matrix. */
143 extern ex lst_to_matrix(const lst & l);
145 /** Convert list of diagonal elements to matrix. */
146 extern ex diag_matrix(const lst & l);
150 #endif // ndef __GINAC_MATRIX_H__