3 * Interface to GiNaC's ABC. */
6 * GiNaC Copyright (C) 1999-2006 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 #ifndef __GINAC_BASIC_H__
24 #define __GINAC_BASIC_H__
26 #include <cstddef> // for size_t
29 // CINT needs <algorithm> to work properly with <vector>
34 #include "assertion.h"
35 #include "registrar.h"
47 typedef std::vector<ex> exvector;
48 typedef std::map<ex, ex, ex_is_less> exmap;
50 // Define this to enable some statistical output for comparisons and hashing
51 #undef GINAC_COMPARE_STATISTICS
53 #ifdef GINAC_COMPARE_STATISTICS
54 class compare_statistics_t {
56 compare_statistics_t()
57 : total_compares(0), nontrivial_compares(0), total_basic_compares(0), compare_same_hashvalue(0), compare_same_type(0),
58 total_is_equals(0), nontrivial_is_equals(0), total_basic_is_equals(0), is_equal_same_hashvalue(0), is_equal_same_type(0),
59 total_gethash(0), gethash_cached(0) {}
60 ~compare_statistics_t();
62 unsigned long total_compares;
63 unsigned long nontrivial_compares;
64 unsigned long total_basic_compares;
65 unsigned long compare_same_hashvalue;
66 unsigned long compare_same_type;
68 unsigned long total_is_equals;
69 unsigned long nontrivial_is_equals;
70 unsigned long total_basic_is_equals;
71 unsigned long is_equal_same_hashvalue;
72 unsigned long is_equal_same_type;
74 unsigned long total_gethash;
75 unsigned long gethash_cached;
78 extern compare_statistics_t compare_statistics;
82 /** Function object for map(). */
84 virtual ~map_function() {}
85 typedef const ex & argument_type;
86 typedef ex result_type;
87 virtual ex operator()(const ex & e) = 0;
91 /** Degenerate base class for visitors. basic and derivative classes
92 * support Robert C. Martin's Acyclic Visitor pattern (cf.
93 * http://objectmentor.com/publications/acv.pdf). */
100 /** This class is the ABC (abstract base class) of GiNaC's class hierarchy. */
101 class basic : public refcounted
103 GINAC_DECLARE_REGISTERED_CLASS_NO_CTORS(basic, void)
107 // default constructor, destructor, copy constructor and assignment operator
109 basic() : tinfo_key(&tinfo_static), flags(0) {}
112 /** basic destructor, virtual because class ex will delete objects of
113 * derived classes via a basic*. */
116 GINAC_ASSERT((!(flags & status_flags::dynallocated)) || (get_refcount() == 0));
118 basic(const basic & other);
119 const basic & operator=(const basic & other);
122 /** Constructor with specified tinfo_key (used by derived classes instead
123 * of the default constructor to avoid assigning tinfo_key twice). */
124 basic(tinfo_t ti) : tinfo_key(ti), flags(0) {}
126 // new virtual functions which can be overridden by derived classes
127 public: // only const functions please (may break reference counting)
129 /** Create a clone of this object on the heap. One can think of this as
130 * simulating a virtual copy constructor which is needed for instance by
131 * the refcounted construction of an ex from a basic. */
132 virtual basic * duplicate() const { return new basic(*this); }
135 virtual ex eval(int level = 0) const;
136 virtual ex evalf(int level = 0) const;
137 virtual ex evalm() const;
138 virtual ex eval_integ() const;
140 virtual ex eval_ncmul(const exvector & v) const;
142 virtual ex eval_indexed(const basic & i) const;
145 virtual void print(const print_context & c, unsigned level = 0) const;
146 virtual void dbgprint() const;
147 virtual void dbgprinttree() const;
148 virtual unsigned precedence() const;
151 virtual bool info(unsigned inf) const;
154 virtual size_t nops() const;
155 virtual ex op(size_t i) const;
156 virtual ex operator[](const ex & index) const;
157 virtual ex operator[](size_t i) const;
158 virtual ex & let_op(size_t i);
159 virtual ex & operator[](const ex & index);
160 virtual ex & operator[](size_t i);
163 virtual bool has(const ex & other) const;
164 virtual bool match(const ex & pattern, lst & repl_lst) const;
166 virtual bool match_same_type(const basic & other) const;
170 virtual ex subs(const exmap & m, unsigned options = 0) const;
173 virtual ex map(map_function & f) const;
175 // visitors and tree traversal
176 virtual void accept(GiNaC::visitor & v) const
178 if (visitor *p = dynamic_cast<visitor *>(&v))
183 virtual int degree(const ex & s) const;
184 virtual int ldegree(const ex & s) const;
185 virtual ex coeff(const ex & s, int n = 1) const;
188 virtual ex expand(unsigned options = 0) const;
189 virtual ex collect(const ex & s, bool distributed = false) const;
191 // differentiation and series expansion
193 virtual ex derivative(const symbol & s) const;
195 virtual ex series(const relational & r, int order, unsigned options = 0) const;
197 // rational functions
198 virtual ex normal(exmap & repl, exmap & rev_lookup, int level = 0) const;
199 virtual ex to_rational(exmap & repl) const;
200 virtual ex to_polynomial(exmap & repl) const;
202 // polynomial algorithms
203 virtual numeric integer_content() const;
204 virtual ex smod(const numeric &xi) const;
205 virtual numeric max_coefficient() const;
208 virtual exvector get_free_indices() const;
209 virtual ex add_indexed(const ex & self, const ex & other) const;
210 virtual ex scalar_mul_indexed(const ex & self, const numeric & other) const;
211 virtual bool contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const;
214 virtual unsigned return_type() const;
215 virtual const basic* return_type_tinfo() const;
217 // complex conjugation
218 virtual ex conjugate() const;
220 // functions that should be called from class ex only
222 virtual int compare_same_type(const basic & other) const;
223 virtual bool is_equal_same_type(const basic & other) const;
225 virtual unsigned calchash() const;
227 // non-virtual functions in this class
229 /** Like print(), but dispatch to the specified class. Can be used by
230 * implementations of print methods to dispatch to the method of the
233 * @see basic::print */
235 void print_dispatch(const print_context & c, unsigned level) const
237 print_dispatch(T::get_class_info_static(), c, level);
240 void print_dispatch(const registered_class_info & ri, const print_context & c, unsigned level) const;
242 ex subs_one_level(const exmap & m, unsigned options) const;
243 ex diff(const symbol & s, unsigned nth = 1) const;
244 int compare(const basic & other) const;
245 bool is_equal(const basic & other) const;
246 const basic & hold() const;
248 unsigned gethash() const
250 #ifdef GINAC_COMPARE_STATISTICS
251 compare_statistics.total_gethash++;
253 if (flags & status_flags::hash_calculated) {
254 #ifdef GINAC_COMPARE_STATISTICS
255 compare_statistics.gethash_cached++;
263 tinfo_t tinfo() const {return tinfo_key;}
265 /** Set some status_flags. */
266 const basic & setflag(unsigned f) const {flags |= f; return *this;}
268 /** Clear some status_flags. */
269 const basic & clearflag(unsigned f) const {flags &= ~f; return *this;}
272 void ensure_if_modifiable() const;
274 void do_print(const print_context & c, unsigned level) const;
275 void do_print_tree(const print_tree & c, unsigned level) const;
276 void do_print_python_repr(const print_python_repr & c, unsigned level) const;
280 tinfo_t tinfo_key; ///< type info
281 mutable unsigned flags; ///< of type status_flags
282 mutable unsigned hashvalue; ///< hash value
288 extern int max_recursion_level;
291 // convenience type checker template functions
293 /** Check if obj is a T, including base classes. */
295 inline bool is_a(const basic &obj)
297 return dynamic_cast<const T *>(&obj) != 0;
300 /** Check if obj is a T, not including base classes. */
302 inline bool is_exactly_a(const basic & obj)
304 return obj.tinfo() == &T::tinfo_static;
309 #endif // ndef __GINAC_BASIC_H__