added the possibility to get some statistical information from ex::compare()
[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 // Define this to enable some statistical output for comparisons and hashing
53 #undef GINAC_COMPARE_STATISTICS
54
55 #ifdef GINAC_COMPARE_STATISTICS
56 class compare_statistics_t {
57 public:
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();
63
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;
69
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;
75
76         unsigned long total_gethash;
77         unsigned long gethash_cached;
78 };
79
80 extern compare_statistics_t compare_statistics;
81 #endif
82
83
84 /** Function object for map(). */
85 struct map_function {
86         typedef const ex & argument_type;
87         typedef ex result_type;
88         virtual ex operator()(const ex & e) = 0;
89 };
90
91
92 /** Degenerate base class for visitors. basic and derivative classes
93  *  support Robert C. Martin's Acyclic Visitor pattern (cf.
94  *  http://objectmentor.com/publications/acv.pdf). */
95 class visitor {
96 protected:
97         virtual ~visitor() {}
98 };
99
100
101 /** This class is the ABC (abstract base class) of GiNaC's class hierarchy. */
102 class basic : public refcounted
103 {
104         GINAC_DECLARE_REGISTERED_CLASS_NO_CTORS(basic, void)
105         
106         friend class ex;
107         
108         // default constructor, destructor, copy constructor and assignment operator
109 protected:
110         basic() : tinfo_key(TINFO_basic), flags(0) {}
111
112 public:
113         /** basic destructor, virtual because class ex will delete objects of
114          *  derived classes via a basic*. */
115         virtual ~basic()
116         {
117                 GINAC_ASSERT((!(flags & status_flags::dynallocated)) || (get_refcount() == 0));
118         }
119         basic(const basic & other);
120         const basic & operator=(const basic & other);
121
122 protected:
123         /** Constructor with specified tinfo_key (used by derived classes instead
124          *  of the default constructor to avoid assigning tinfo_key twice). */
125         basic(unsigned ti) : tinfo_key(ti), flags(0) {}
126         
127         // new virtual functions which can be overridden by derived classes
128 public: // only const functions please (may break reference counting)
129
130         /** Create a clone of this object on the heap.  One can think of this as
131          *  simulating a virtual copy constructor which is needed for instance by
132          *  the refcounted construction of an ex from a basic. */
133         virtual basic * duplicate() const { return new basic(*this); }
134
135         // evaluation
136         virtual ex eval(int level = 0) const;
137         virtual ex evalf(int level = 0) const;
138         virtual ex evalm() const;
139 protected:
140         virtual ex eval_ncmul(const exvector & v) const;
141 public:
142         virtual ex eval_indexed(const basic & i) const;
143
144         // printing
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;
149
150         // info
151         virtual bool info(unsigned inf) const;
152
153         // operand access
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);
161
162         // pattern matching
163         virtual bool has(const ex & other) const;
164         virtual bool match(const ex & pattern, lst & repl_lst) const;
165 protected:
166         virtual bool match_same_type(const basic & other) const;
167 public:
168
169         // substitutions
170         virtual ex subs(const exmap & m, unsigned options = 0) const;
171
172         // function mapping
173         virtual ex map(map_function & f) const;
174
175         // visitors and tree traversal
176         virtual void accept(GiNaC::visitor & v) const
177         {
178                 if (visitor *p = dynamic_cast<visitor *>(&v))
179                         p->visit(*this);
180         }
181
182         // degree/coeff
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;
186
187         // expand/collect
188         virtual ex expand(unsigned options = 0) const;
189         virtual ex collect(const ex & s, bool distributed = false) const;
190
191         // differentiation and series expansion
192 protected:
193         virtual ex derivative(const symbol & s) const;
194 public:
195         virtual ex series(const relational & r, int order, unsigned options = 0) const;
196
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;
201
202         // polynomial algorithms
203         virtual numeric integer_content() const;
204         virtual ex smod(const numeric &xi) const;
205         virtual numeric max_coefficient() const;
206
207         // indexed objects
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;
212
213         // noncommutativity
214         virtual unsigned return_type() const;
215         virtual unsigned return_type_tinfo() const;
216
217         // complex conjugation
218         virtual ex conjugate() const;
219
220         // functions that should be called from class ex only
221 protected:
222         virtual int compare_same_type(const basic & other) const;
223         virtual bool is_equal_same_type(const basic & other) const;
224
225         virtual unsigned calchash() const;
226         
227         // non-virtual functions in this class
228 public:
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
231          *  superclass.
232          *
233          *  @see basic::print */
234         template <class T>
235         void print_dispatch(const print_context & c, unsigned level) const
236         {
237                 print_dispatch(T::get_class_info_static(), c, level);
238         }
239
240         void print_dispatch(const registered_class_info & ri, const print_context & c, unsigned level) const;
241
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;
247
248         unsigned gethash() const
249         {
250 #ifdef GINAC_COMPARE_STATISTICS
251                 compare_statistics.total_gethash++;
252 #endif
253                 if (flags & status_flags::hash_calculated) {
254 #ifdef GINAC_COMPARE_STATISTICS
255                         compare_statistics.gethash_cached++;
256 #endif
257                         return hashvalue;
258                 } else {
259                         return calchash();
260                 }
261         }
262
263         unsigned tinfo() const {return tinfo_key;}
264
265         /** Set some status_flags. */
266         const basic & setflag(unsigned f) const {flags |= f; return *this;}
267
268         /** Clear some status_flags. */
269         const basic & clearflag(unsigned f) const {flags &= ~f; return *this;}
270
271 protected:
272         void ensure_if_modifiable() const;
273
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;
277         
278         // member variables
279 protected:
280         unsigned tinfo_key;                 ///< typeinfo
281         mutable unsigned flags;             ///< of type status_flags
282         mutable unsigned hashvalue;         ///< hash value
283 };
284
285
286 // global variables
287
288 extern int max_recursion_level;
289
290
291 // convenience type checker template functions
292
293 /** Check if obj is a T, including base classes. */
294 template <class T>
295 inline bool is_a(const basic &obj)
296 {
297         return dynamic_cast<const T *>(&obj) != 0;
298 }
299
300 /** Check if obj is a T, not including base classes.  This one is just an
301  *  inefficient default.  It should in all time-critical cases be overridden
302  *  by template specializations that use the TINFO_* constants directly. */
303 template <class T>
304 inline bool is_exactly_a(const basic &obj)
305 {
306         return obj.tinfo() == T::get_class_info_static().options.get_id();
307 }
308
309 } // namespace GiNaC
310
311 #endif // ndef __GINAC_BASIC_H__