da634e08b158ae846b28c02732f540d040c4f4fd
[ginac.git] / ginac / basic.h
1 /** @file basic.h
2  *
3  *  Interface to GiNaC's ABC. */
4
5 /*
6  *  GiNaC Copyright (C) 1999-2004 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_BASIC_H__
24 #define __GINAC_BASIC_H__
25
26 #include <cstddef> // for size_t
27 #include <vector>
28 #include <map>
29 // CINT needs <algorithm> to work properly with <vector>
30 #include <algorithm>
31
32 #include "flags.h"
33 #include "tinfos.h"
34 #include "ptr.h"
35 #include "assertion.h"
36 #include "registrar.h"
37
38 namespace GiNaC {
39
40 class ex;
41 class ex_is_less;
42 class symbol;
43 class numeric;
44 class relational;
45 class archive_node;
46 class print_context;
47
48 typedef std::vector<ex> exvector;
49 typedef std::map<ex, ex, ex_is_less> exmap;
50
51
52 /** Function object for map(). */
53 struct map_function {
54         typedef const ex & argument_type;
55         typedef ex result_type;
56         virtual ex operator()(const ex & e) = 0;
57 };
58
59
60 /** Degenerate base class for visitors. basic and derivative classes
61  *  support Robert C. Martin's Acyclic Visitor pattern (cf.
62  *  http://objectmentor.com/publications/acv.pdf). */
63 class visitor {
64 protected:
65         virtual ~visitor() {}
66 };
67
68
69 /** This class is the ABC (abstract base class) of GiNaC's class hierarchy. */
70 class basic : public refcounted
71 {
72         GINAC_DECLARE_REGISTERED_CLASS_NO_CTORS(basic, void)
73         
74         friend class ex;
75         
76         // default constructor, destructor, copy constructor and assignment operator
77 protected:
78         basic() : tinfo_key(TINFO_basic), flags(0) {}
79
80 public:
81         /** basic destructor, virtual because class ex will delete objects of
82          *  derived classes via a basic*. */
83         virtual ~basic()
84         {
85                 GINAC_ASSERT((!(flags & status_flags::dynallocated)) || (get_refcount() == 0));
86         }
87         basic(const basic & other);
88         const basic & operator=(const basic & other);
89
90 protected:
91         /** Constructor with specified tinfo_key (used by derived classes instead
92          *  of the default constructor to avoid assigning tinfo_key twice). */
93         basic(unsigned ti) : tinfo_key(ti), flags(0) {}
94         
95         // new virtual functions which can be overridden by derived classes
96 public: // only const functions please (may break reference counting)
97
98         /** Create a clone of this object on the heap.  One can think of this as
99          *  simulating a virtual copy constructor which is needed for instance by
100          *  the refcounted construction of an ex from a basic. */
101         virtual basic * duplicate() const { return new basic(*this); }
102
103         // evaluation
104         virtual ex eval(int level = 0) const;
105         virtual ex evalf(int level = 0) const;
106         virtual ex evalm() const;
107 protected:
108         virtual ex eval_ncmul(const exvector & v) const;
109 public:
110         virtual ex eval_indexed(const basic & i) const;
111
112         // printing
113         virtual void print(const print_context & c, unsigned level = 0) const;
114         virtual void dbgprint() const;
115         virtual void dbgprinttree() const;
116         virtual unsigned precedence() const;
117
118         // info
119         virtual bool info(unsigned inf) const;
120
121         // operand access
122         virtual size_t nops() const;
123         virtual ex op(size_t i) const;
124         virtual ex operator[](const ex & index) const;
125         virtual ex operator[](size_t i) const;
126         virtual ex & let_op(size_t i);
127         virtual ex & operator[](const ex & index);
128         virtual ex & operator[](size_t i);
129
130         // pattern matching
131         virtual bool has(const ex & other) const;
132         virtual bool match(const ex & pattern, lst & repl_lst) const;
133 protected:
134         virtual bool match_same_type(const basic & other) const;
135 public:
136
137         // substitutions
138         virtual ex subs(const exmap & m, unsigned options = 0) const;
139
140         // function mapping
141         virtual ex map(map_function & f) const;
142
143         // visitors and tree traversal
144         virtual void accept(GiNaC::visitor & v) const
145         {
146                 if (visitor *p = dynamic_cast<visitor *>(&v))
147                         p->visit(*this);
148         }
149
150         // degree/coeff
151         virtual int degree(const ex & s) const;
152         virtual int ldegree(const ex & s) const;
153         virtual ex coeff(const ex & s, int n = 1) const;
154
155         // expand/collect
156         virtual ex expand(unsigned options = 0) const;
157         virtual ex collect(const ex & s, bool distributed = false) const;
158
159         // differentiation and series expansion
160 protected:
161         virtual ex derivative(const symbol & s) const;
162 public:
163         virtual ex series(const relational & r, int order, unsigned options = 0) const;
164
165         // rational functions
166         virtual ex normal(exmap & repl, exmap & rev_lookup, int level = 0) const;
167         virtual ex to_rational(exmap & repl) const;
168         virtual ex to_polynomial(exmap & repl) const;
169
170         // polynomial algorithms
171         virtual numeric integer_content() const;
172         virtual ex smod(const numeric &xi) const;
173         virtual numeric max_coefficient() const;
174
175         // indexed objects
176         virtual exvector get_free_indices() const;
177         virtual ex add_indexed(const ex & self, const ex & other) const;
178         virtual ex scalar_mul_indexed(const ex & self, const numeric & other) const;
179         virtual bool contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const;
180
181         // noncommutativity
182         virtual unsigned return_type() const;
183         virtual unsigned return_type_tinfo() const;
184
185         // complex conjugation
186         virtual ex conjugate() const;
187
188         // functions that should be called from class ex only
189 protected:
190         virtual int compare_same_type(const basic & other) const;
191         virtual bool is_equal_same_type(const basic & other) const;
192
193         virtual unsigned calchash() const;
194         
195         // non-virtual functions in this class
196 public:
197         /** Like print(), but dispatch to the specified class. Can be used by
198          *  implementations of print methods to dispatch to the method of the
199          *  superclass.
200          *
201          *  @see basic::print */
202         template <class T>
203         void print_dispatch(const print_context & c, unsigned level) const
204         {
205                 print_dispatch(T::get_class_info_static(), c, level);
206         }
207
208         void print_dispatch(const registered_class_info & ri, const print_context & c, unsigned level) const;
209
210         ex subs_one_level(const exmap & m, unsigned options) const;
211         ex diff(const symbol & s, unsigned nth = 1) const;
212         int compare(const basic & other) const;
213         bool is_equal(const basic & other) const;
214         const basic & hold() const;
215         unsigned gethash() const { if (flags & status_flags::hash_calculated) return hashvalue; else return calchash(); }
216         unsigned tinfo() const {return tinfo_key;}
217
218         /** Set some status_flags. */
219         const basic & setflag(unsigned f) const {flags |= f; return *this;}
220
221         /** Clear some status_flags. */
222         const basic & clearflag(unsigned f) const {flags &= ~f; return *this;}
223
224 protected:
225         void ensure_if_modifiable() const;
226
227         void do_print(const print_context & c, unsigned level) const;
228         void do_print_tree(const print_tree & c, unsigned level) const;
229         void do_print_python_repr(const print_python_repr & c, unsigned level) const;
230         
231         // member variables
232 protected:
233         unsigned tinfo_key;                 ///< typeinfo
234         mutable unsigned flags;             ///< of type status_flags
235         mutable unsigned hashvalue;         ///< hash value
236 };
237
238
239 // global variables
240
241 extern int max_recursion_level;
242
243
244 // convenience type checker template functions
245
246 /** Check if obj is a T, including base classes. */
247 template <class T>
248 inline bool is_a(const basic &obj)
249 {
250         return dynamic_cast<const T *>(&obj) != 0;
251 }
252
253 /** Check if obj is a T, not including base classes.  This one is just an
254  *  inefficient default.  It should in all time-critical cases be overridden
255  *  by template specializations that use the TINFO_* constants directly. */
256 template <class T>
257 inline bool is_exactly_a(const basic &obj)
258 {
259         return obj.tinfo() == T::get_class_info_static().options.get_id();
260 }
261
262 } // namespace GiNaC
263
264 #endif // ndef __GINAC_BASIC_H__