3 * Interface to GiNaC's ABC. */
6 * GiNaC Copyright (C) 1999-2007 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
30 // CINT needs <algorithm> to work properly with <vector>
35 #include "assertion.h"
36 #include "registrar.h"
48 typedef std::vector<ex> exvector;
49 typedef std::set<ex, ex_is_less> exset;
50 typedef std::map<ex, ex, ex_is_less> exmap;
52 // Define this to enable some statistical output for comparisons and hashing
53 #undef GINAC_COMPARE_STATISTICS
55 #ifdef GINAC_COMPARE_STATISTICS
56 class compare_statistics_t {
58 compare_statistics_t()
59 : total_compares(0), nontrivial_compares(0), total_basic_compares(0), compare_same_hashvalue(0), compare_same_type(0),
60 total_is_equals(0), nontrivial_is_equals(0), total_basic_is_equals(0), is_equal_same_hashvalue(0), is_equal_same_type(0),
61 total_gethash(0), gethash_cached(0) {}
62 ~compare_statistics_t();
64 unsigned long total_compares;
65 unsigned long nontrivial_compares;
66 unsigned long total_basic_compares;
67 unsigned long compare_same_hashvalue;
68 unsigned long compare_same_type;
70 unsigned long total_is_equals;
71 unsigned long nontrivial_is_equals;
72 unsigned long total_basic_is_equals;
73 unsigned long is_equal_same_hashvalue;
74 unsigned long is_equal_same_type;
76 unsigned long total_gethash;
77 unsigned long gethash_cached;
80 extern compare_statistics_t compare_statistics;
84 /** Function object for map(). */
86 virtual ~map_function() {}
87 typedef const ex & argument_type;
88 typedef ex result_type;
89 virtual ex operator()(const ex & e) = 0;
93 /** Degenerate base class for visitors. basic and derivative classes
94 * support Robert C. Martin's Acyclic Visitor pattern (cf.
95 * http://objectmentor.com/publications/acv.pdf). */
102 /** This class is the ABC (abstract base class) of GiNaC's class hierarchy. */
103 class basic : public refcounted
105 GINAC_DECLARE_REGISTERED_CLASS_NO_CTORS(basic, void)
109 // default constructor, destructor, copy constructor and assignment operator
111 basic() : tinfo_key(&tinfo_static), flags(0) {}
114 /** basic destructor, virtual because class ex will delete objects of
115 * derived classes via a basic*. */
118 GINAC_ASSERT((!(flags & status_flags::dynallocated)) || (get_refcount() == 0));
120 basic(const basic & other);
121 const basic & operator=(const basic & other);
124 /** Constructor with specified tinfo_key (used by derived classes instead
125 * of the default constructor to avoid assigning tinfo_key twice). */
126 basic(tinfo_t ti) : tinfo_key(ti), flags(0) {}
128 // new virtual functions which can be overridden by derived classes
129 public: // only const functions please (may break reference counting)
131 /** Create a clone of this object on the heap. One can think of this as
132 * simulating a virtual copy constructor which is needed for instance by
133 * the refcounted construction of an ex from a basic. */
134 virtual basic * duplicate() const { return new basic(*this); }
137 virtual ex eval(int level = 0) const;
138 virtual ex evalf(int level = 0) const;
139 virtual ex evalm() const;
140 virtual ex eval_integ() const;
142 virtual ex eval_ncmul(const exvector & v) const;
144 virtual ex eval_indexed(const basic & i) const;
147 virtual void print(const print_context & c, unsigned level = 0) const;
148 virtual void dbgprint() const;
149 virtual void dbgprinttree() const;
150 virtual unsigned precedence() const;
153 virtual bool info(unsigned inf) const;
156 virtual size_t nops() const;
157 virtual ex op(size_t i) const;
158 virtual ex operator[](const ex & index) const;
159 virtual ex operator[](size_t i) const;
160 virtual ex & let_op(size_t i);
161 virtual ex & operator[](const ex & index);
162 virtual ex & operator[](size_t i);
165 virtual bool has(const ex & other, unsigned options = 0) const;
166 virtual bool match(const ex & pattern, lst & repl_lst) const;
168 virtual bool match_same_type(const basic & other) const;
172 virtual ex subs(const exmap & m, unsigned options = 0) const;
175 virtual ex map(map_function & f) const;
177 // visitors and tree traversal
178 virtual void accept(GiNaC::visitor & v) const
180 if (visitor *p = dynamic_cast<visitor *>(&v))
185 virtual bool is_polynomial(const ex & var) const;
186 virtual int degree(const ex & s) const;
187 virtual int ldegree(const ex & s) const;
188 virtual ex coeff(const ex & s, int n = 1) const;
191 virtual ex expand(unsigned options = 0) const;
192 virtual ex collect(const ex & s, bool distributed = false) const;
194 // differentiation and series expansion
196 virtual ex derivative(const symbol & s) const;
198 virtual ex series(const relational & r, int order, unsigned options = 0) const;
200 // rational functions
201 virtual ex normal(exmap & repl, exmap & rev_lookup, int level = 0) const;
202 virtual ex to_rational(exmap & repl) const;
203 virtual ex to_polynomial(exmap & repl) const;
205 // polynomial algorithms
206 virtual numeric integer_content() const;
207 virtual ex smod(const numeric &xi) const;
208 virtual numeric max_coefficient() const;
211 virtual exvector get_free_indices() const;
212 virtual ex add_indexed(const ex & self, const ex & other) const;
213 virtual ex scalar_mul_indexed(const ex & self, const numeric & other) const;
214 virtual bool contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const;
217 virtual unsigned return_type() const;
218 virtual tinfo_t return_type_tinfo() const;
220 // functions for complex expressions
221 virtual ex conjugate() const;
222 virtual ex real_part() const;
223 virtual ex imag_part() const;
225 // functions that should be called from class ex only
227 virtual int compare_same_type(const basic & other) const;
228 virtual bool is_equal_same_type(const basic & other) const;
230 virtual unsigned calchash() const;
232 // non-virtual functions in this class
234 /** Like print(), but dispatch to the specified class. Can be used by
235 * implementations of print methods to dispatch to the method of the
238 * @see basic::print */
240 void print_dispatch(const print_context & c, unsigned level) const
242 print_dispatch(T::get_class_info_static(), c, level);
245 void print_dispatch(const registered_class_info & ri, const print_context & c, unsigned level) const;
247 ex subs_one_level(const exmap & m, unsigned options) const;
248 ex diff(const symbol & s, unsigned nth = 1) const;
249 int compare(const basic & other) const;
250 bool is_equal(const basic & other) const;
251 const basic & hold() const;
253 unsigned gethash() const
255 #ifdef GINAC_COMPARE_STATISTICS
256 compare_statistics.total_gethash++;
258 if (flags & status_flags::hash_calculated) {
259 #ifdef GINAC_COMPARE_STATISTICS
260 compare_statistics.gethash_cached++;
268 tinfo_t tinfo() const {return tinfo_key;}
270 /** Set some status_flags. */
271 const basic & setflag(unsigned f) const {flags |= f; return *this;}
273 /** Clear some status_flags. */
274 const basic & clearflag(unsigned f) const {flags &= ~f; return *this;}
277 void ensure_if_modifiable() const;
279 void do_print(const print_context & c, unsigned level) const;
280 void do_print_tree(const print_tree & c, unsigned level) const;
281 void do_print_python_repr(const print_python_repr & c, unsigned level) const;
285 tinfo_t tinfo_key; ///< type info
286 mutable unsigned flags; ///< of type status_flags
287 mutable unsigned hashvalue; ///< hash value
293 extern int max_recursion_level;
296 // convenience type checker template functions
298 /** Check if obj is a T, including base classes. */
300 inline bool is_a(const basic &obj)
302 return dynamic_cast<const T *>(&obj) != 0;
305 /** Check if obj is a T, not including base classes. */
307 inline bool is_exactly_a(const basic & obj)
309 return obj.tinfo() == &T::tinfo_static;
314 #endif // ndef __GINAC_BASIC_H__