]> www.ginac.de Git - ginac.git/blob - ginac/matrix.h
- building GiNaC in a separate directory now works
[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_GINAC_NAMESPACE
31 namespace GiNaC {
32 #endif // ndef NO_GINAC_NAMESPACE
33
34 /** Symbolic matrices. */
35 class matrix : public basic
36 {
37     GINAC_DECLARE_REGISTERED_CLASS(matrix, basic)
38
39 // friends
40     friend ex determinant_numeric(const matrix & m);
41     friend ex determinant_symbolic_perm(const matrix & m);
42     friend ex determinant_symbolic_minor(const matrix & m);
43
44 // member functions
45
46     // default constructor, destructor, copy constructor, assignment operator
47     // and helpers:
48 public:
49     matrix();
50     ~matrix();
51     matrix(const matrix & other);
52     const matrix & operator=(const matrix & other);
53 protected:
54     void copy(const matrix & other);
55     void destroy(bool call_parent);
56
57     // other constructors
58 public:
59     matrix(unsigned r, unsigned c);
60     matrix(unsigned r, unsigned c, const exvector & m2);
61    
62     // functions overriding virtual functions from bases classes
63 public:
64     basic * duplicate() const;
65     void print(ostream & os, unsigned upper_precedence=0) const;
66     void printraw(ostream & os) const;
67     unsigned nops() const;
68     ex op(int i) const;
69     ex & let_op(int i);
70     ex expand(unsigned options=0) const;
71     bool has(const ex & other) const;
72     ex eval(int level=0) const;
73     ex evalf(int level=0) const;
74     // ex subs(const lst & ls, const lst & lr) const;
75 protected:
76     int compare_same_type(const basic & other) const;
77     unsigned return_type(void) const { return return_types::noncommutative; };
78     // new virtual functions which can be overridden by derived classes
79     // (none)
80     
81     // non-virtual functions in this class
82 public:
83     unsigned rows() const            //! get number of rows.
84         { return row; }
85     unsigned cols() const            //! get number of columns.
86         { return col; }
87     matrix add(const matrix & other) const;
88     matrix sub(const matrix & other) const;
89     matrix mul(const matrix & other) const;
90     const ex & operator() (unsigned ro, unsigned co) const;
91     matrix & set(unsigned ro, unsigned co, ex value);
92     matrix transpose(void) const;
93     ex determinant(bool normalized=true) const;
94     ex trace(void) const;
95     ex charpoly(const ex & lambda) const;
96     matrix inverse(void) const;
97     matrix fraction_free_elim(const matrix & vars, const matrix & v) const;
98     matrix solve(const matrix & v) const;
99 protected:
100     int pivot(unsigned ro);
101     void ffe_swap(unsigned r1, unsigned c1, unsigned r2 ,unsigned c2);
102     void ffe_set(unsigned r, unsigned c, ex e);
103     ex ffe_get(unsigned r, unsigned c) const;
104     
105 // member variables
106 protected:
107     unsigned row;             /**< number of rows      */
108     unsigned col;             /**< number of columns   */
109     exvector m;               /**< representation (cols indexed first) */
110     static unsigned precedence;
111 };
112
113 // global constants
114 extern const matrix some_matrix;
115 extern const type_info & typeid_matrix;
116
117 // wrapper functions around member functions
118
119 inline unsigned nops(const matrix & m)
120 { return m.nops(); }
121
122 inline ex expand(const matrix & m, unsigned options=0)
123 { return m.expand(options); }
124
125 inline bool has(const matrix & m, const ex & other)
126 { return m.has(other); }
127
128 inline ex eval(const matrix & m, int level=0)
129 { return m.eval(level); }
130
131 inline ex evalf(const matrix & m, int level=0)
132 { return m.evalf(level); }
133
134 inline unsigned rows(const matrix & m)
135 { return m.rows(); }
136
137 inline unsigned cols(const matrix & m)
138 { return m.cols(); }
139
140 inline matrix transpose(const matrix & m)
141 { return m.transpose(); }
142
143 inline ex determinant(const matrix & m, bool normalized=true)
144 { return m.determinant(normalized); }
145
146 inline ex trace(const matrix & m)
147 { return m.trace(); }
148
149 inline ex charpoly(const matrix & m, const ex & lambda)
150 { return m.charpoly(lambda); }
151
152 inline matrix inverse(const matrix & m)
153 { return m.inverse(); }
154
155 // utility functions
156 inline const matrix &ex_to_matrix(const ex &e)
157 {
158         return static_cast<const matrix &>(*e.bp);
159 }
160
161 #ifndef NO_GINAC_NAMESPACE
162 } // namespace GiNaC
163 #endif // ndef NO_GINAC_NAMESPACE
164
165 #endif // ndef __GINAC_MATRIX_H__