a36276f4d332b06f57afdc6747e7a5f54697cf72
[ginac.git] / ginac / matrix.h
1 /** @file matrix.h
2  *
3  *  Interface to symbolic matrices */
4
5 /*
6  *  GiNaC Copyright (C) 1999-2000 Johannes Gutenberg University Mainz, Germany
7  *
8  *  This program is free software; you can redistribute it and/or modify
9  *  it under the terms of the GNU General Public License as published by
10  *  the Free Software Foundation; either version 2 of the License, or
11  *  (at your option) any later version.
12  *
13  *  This program is distributed in the hope that it will be useful,
14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  *  GNU General Public License for more details.
17  *
18  *  You should have received a copy of the GNU General Public License
19  *  along with this program; if not, write to the Free Software
20  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21  */
22
23 #ifndef __GINAC_MATRIX_H__
24 #define __GINAC_MATRIX_H__
25
26 #include <vector>
27 #include "basic.h"
28 #include "ex.h"
29
30 #ifndef NO_NAMESPACE_GINAC
31 namespace GiNaC {
32 #endif // ndef NO_NAMESPACE_GINAC
33
34 /** Symbolic matrices. */
35 class matrix : public basic
36 {
37     GINAC_DECLARE_REGISTERED_CLASS(matrix, basic)
38
39 // friends
40 // (none)
41 // member functions
42
43     // default constructor, destructor, copy constructor, assignment operator
44     // and helpers:
45 public:
46     matrix();
47     ~matrix();
48     matrix(const matrix & other);
49     const matrix & operator=(const matrix & other);
50 protected:
51     void copy(const matrix & other);
52     void destroy(bool call_parent);
53
54     // other constructors
55 public:
56     matrix(unsigned r, unsigned c);
57     matrix(unsigned r, unsigned c, const exvector & m2);
58    
59     // functions overriding virtual functions from bases classes
60 public:
61     basic * duplicate() const;
62     void print(ostream & os, unsigned upper_precedence=0) const;
63     void printraw(ostream & os) const;
64     unsigned nops() const;
65     ex op(int i) const;
66     ex & let_op(int i);
67     ex expand(unsigned options=0) const;
68     bool has(const ex & other) const;
69     ex eval(int level=0) const;
70     ex evalf(int level=0) const;
71     // ex subs(const lst & ls, const lst & lr) const;
72 protected:
73     int compare_same_type(const basic & other) const;
74     unsigned return_type(void) const { return return_types::noncommutative; };
75     // new virtual functions which can be overridden by derived classes
76     // (none)
77     
78     // non-virtual functions in this class
79 public:
80     unsigned rows(void) const        //! get number of rows.
81         { return row; }
82     unsigned cols(void) const        //! get number of columns.
83         { return col; }
84     matrix add(const matrix & other) const;
85     matrix sub(const matrix & other) const;
86     matrix mul(const matrix & other) const;
87     const ex & operator() (unsigned ro, unsigned co) const;
88     matrix & set(unsigned ro, unsigned co, ex value);
89     matrix transpose(void) const;
90     ex determinant(void) const;
91     ex trace(void) const;
92     ex charpoly(const symbol & lambda) const;
93     matrix inverse(void) const;
94     matrix fraction_free_elim(const matrix & vars, const matrix & v) const;
95     matrix solve(const matrix & vars, const matrix & rhs) const;
96     matrix old_solve(const matrix & v) const;  // FIXME: may be removed
97 protected:
98     ex determinant_numeric(void) const;
99     ex determinant_minor(void) const;
100     ex determinant_bareiss(bool normalize=true) const;
101     int gauss_elimination(void);
102     int fraction_free_elimination(void);
103     int division_free_elimination(void);
104     int pivot(unsigned ro, bool symbolic=true);
105 private:  // FIXME: these should be obsoleted
106     void ffe_swap(unsigned r1, unsigned c1, unsigned r2 ,unsigned c2);
107     void ffe_set(unsigned r, unsigned c, ex e);
108     ex ffe_get(unsigned r, unsigned c) const;
109     
110 // member variables
111 protected:
112     unsigned row;             /**< number of rows      */
113     unsigned col;             /**< number of columns   */
114     exvector m;               /**< representation (cols indexed first) */
115     static unsigned precedence;
116 };
117
118 // global constants
119 extern const matrix some_matrix;
120 extern const type_info & typeid_matrix;
121
122 // wrapper functions around member functions
123
124 inline unsigned nops(const matrix & m)
125 { return m.nops(); }
126
127 inline ex expand(const matrix & m, unsigned options=0)
128 { return m.expand(options); }
129
130 inline bool has(const matrix & m, const ex & other)
131 { return m.has(other); }
132
133 inline ex eval(const matrix & m, int level=0)
134 { return m.eval(level); }
135
136 inline ex evalf(const matrix & m, int level=0)
137 { return m.evalf(level); }
138
139 inline unsigned rows(const matrix & m)
140 { return m.rows(); }
141
142 inline unsigned cols(const matrix & m)
143 { return m.cols(); }
144
145 inline matrix transpose(const matrix & m)
146 { return m.transpose(); }
147
148 inline ex determinant(const matrix & m)
149 { return m.determinant(); }
150
151 inline ex trace(const matrix & m)
152 { return m.trace(); }
153
154 inline ex charpoly(const matrix & m, const symbol & lambda)
155 { return m.charpoly(lambda); }
156
157 inline matrix inverse(const matrix & m)
158 { return m.inverse(); }
159
160 // utility functions
161 inline const matrix &ex_to_matrix(const ex &e)
162 {
163         return static_cast<const matrix &>(*e.bp);
164 }
165
166 extern ex lst_to_matrix(const ex &l);
167
168 #ifndef NO_NAMESPACE_GINAC
169 } // namespace GiNaC
170 #endif // ndef NO_NAMESPACE_GINAC
171
172 #endif // ndef __GINAC_MATRIX_H__