Happy New Year!
[ginac.git] / ginac / basic.h
1 /** @file basic.h
2  *
3  *  Interface to GiNaC's ABC. */
4
5 /*
6  *  GiNaC Copyright (C) 1999-2019 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
21  */
22
23 #ifndef GINAC_BASIC_H
24 #define GINAC_BASIC_H
25
26 #include "flags.h"
27 #include "ptr.h"
28 #include "assertion.h"
29 #include "registrar.h"
30
31 #include <cstddef> // for size_t
32 #include <map>
33 #include <set>
34 #include <typeinfo> // for typeid
35 #include <vector>
36 #include <utility>
37
38 namespace GiNaC {
39
40 class ex;
41 struct 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::set<ex, ex_is_less> exset;
50 typedef std::map<ex, ex, ex_is_less> exmap;
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         virtual ~map_function() {}
87         typedef const ex & argument_type;
88         typedef ex result_type;
89         virtual ex operator()(const ex & e) = 0;
90 };
91
92
93 /** Degenerate base class for visitors. basic and derivative classes
94  *  support Robert C. Martin's Acyclic Visitor pattern (cf.
95  *  http://condor.depaul.edu/dmumaugh/OOT/Design-Principles/acv.pdf
96  *  or chapter 10 of Andrei Alexandrescu's "Modern C++ Design"). */
97 class visitor {
98 protected:
99         virtual ~visitor() {}
100 };
101
102
103 /** This class is the ABC (abstract base class) of GiNaC's class hierarchy. */
104 class basic : public refcounted
105 {
106         GINAC_DECLARE_REGISTERED_CLASS_NO_CTORS(basic, void)
107         
108         friend class ex;
109         
110         // default constructor, destructor, copy constructor and assignment operator
111 protected:
112         basic() : flags(0) {}
113
114 public:
115         /** basic destructor, virtual because class ex will delete objects of
116          *  derived classes via a basic*. */
117         virtual ~basic()
118         {
119                 GINAC_ASSERT((!(flags & status_flags::dynallocated)) || (get_refcount() == 0));
120         }
121         basic(const basic & other);
122         const basic & operator=(const basic & other);
123
124 protected:
125         // new virtual functions which can be overridden by derived classes
126 public: // only const functions please (may break reference counting)
127
128         /** Create a clone of this object on the heap.  One can think of this as
129          *  simulating a virtual copy constructor which is needed for instance by
130          *  the refcounted construction of an ex from a basic. */
131         virtual basic * duplicate() const
132         {
133                 basic * bp = new basic(*this);
134                 bp->setflag(status_flags::dynallocated);
135                 return bp;
136         }
137
138         // evaluation
139         virtual ex eval() const;
140         virtual ex evalf() const;
141         virtual ex evalm() const;
142         virtual ex eval_integ() const;
143 protected:
144         virtual ex eval_ncmul(const exvector & v) const;
145 public:
146         virtual ex eval_indexed(const basic & i) const;
147
148         // printing
149         virtual void print(const print_context & c, unsigned level = 0) const;
150         virtual void dbgprint() const;
151         virtual void dbgprinttree() const;
152         virtual unsigned precedence() const;
153
154         // info
155         virtual bool info(unsigned inf) const;
156
157         // operand access
158         virtual size_t nops() const;
159         virtual ex op(size_t i) const;
160         virtual ex operator[](const ex & index) const;
161         virtual ex operator[](size_t i) const;
162         virtual ex & let_op(size_t i);
163         virtual ex & operator[](const ex & index);
164         virtual ex & operator[](size_t i);
165
166         // pattern matching
167         virtual bool has(const ex & other, unsigned options = 0) const;
168         virtual bool match(const ex & pattern, exmap & repls) const;
169 protected:
170         virtual bool match_same_type(const basic & other) const;
171 public:
172
173         // substitutions
174         virtual ex subs(const exmap & m, unsigned options = 0) const;
175
176         // function mapping
177         virtual ex map(map_function & f) const;
178
179         // visitors and tree traversal
180         virtual void accept(GiNaC::visitor & v) const
181         {
182                 if (visitor *p = dynamic_cast<visitor *>(&v))
183                         p->visit(*this);
184         }
185
186         // degree/coeff
187         virtual bool is_polynomial(const ex & var) const;
188         virtual int degree(const ex & s) const;
189         virtual int ldegree(const ex & s) const;
190         virtual ex coeff(const ex & s, int n = 1) const;
191
192         // expand/collect
193         virtual ex expand(unsigned options = 0) const;
194         virtual ex collect(const ex & s, bool distributed = false) const;
195
196         // differentiation and series expansion
197 protected:
198         virtual ex derivative(const symbol & s) const;
199 public:
200         virtual ex series(const relational & r, int order, unsigned options = 0) const;
201
202         // rational functions
203         virtual ex normal(exmap & repl, exmap & rev_lookup) const;
204         virtual ex to_rational(exmap & repl) const;
205         virtual ex to_polynomial(exmap & repl) const;
206
207         // polynomial algorithms
208         virtual numeric integer_content() const;
209         virtual ex smod(const numeric &xi) const;
210         virtual numeric max_coefficient() const;
211
212         // indexed objects
213         virtual exvector get_free_indices() const;
214         virtual ex add_indexed(const ex & self, const ex & other) const;
215         virtual ex scalar_mul_indexed(const ex & self, const numeric & other) const;
216         virtual bool contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const;
217
218         // noncommutativity
219         virtual unsigned return_type() const;
220         virtual return_type_t return_type_tinfo() const;
221
222         // functions for complex expressions
223         virtual ex conjugate() const;
224         virtual ex real_part() const;
225         virtual ex imag_part() const;
226
227         // functions that should be called from class ex only
228 protected:
229         virtual int compare_same_type(const basic & other) const;
230         virtual bool is_equal_same_type(const basic & other) const;
231
232         virtual unsigned calchash() const;
233         
234         // non-virtual functions in this class
235 public:
236         /** Like print(), but dispatch to the specified class. Can be used by
237          *  implementations of print methods to dispatch to the method of the
238          *  superclass.
239          *
240          *  @see basic::print */
241         template <class T>
242         void print_dispatch(const print_context & c, unsigned level) const
243         {
244                 print_dispatch(T::get_class_info_static(), c, level);
245         }
246
247         void print_dispatch(const registered_class_info & ri, const print_context & c, unsigned level) const;
248
249         /** Save (serialize) the object into archive node.
250          *
251          * Losely speaking, this method turns an expression into a byte
252          * stream (which can be saved and restored later on, or sent via
253          * network, etc.)
254          */
255         virtual void archive(archive_node& n) const;
256         /** Load (deserialize) the object from an archive node.
257          *
258          *  @note This method is essentially a constructor. However,
259          *  constructors can't be virtual. So, if unarchiving routines
260          *  are implemented as constructors one would need to define such
261          *  a constructor in every class, even if all it does is simply
262          *  calling constructor of a superclass.
263          */
264         virtual void read_archive(const archive_node& n, lst& syms); // no const
265
266         ex subs_one_level(const exmap & m, unsigned options) const;
267         ex diff(const symbol & s, unsigned nth = 1) const;
268         int compare(const basic & other) const;
269         bool is_equal(const basic & other) const;
270         const basic & hold() const;
271
272         unsigned gethash() const
273         {
274 #ifdef GINAC_COMPARE_STATISTICS
275                 compare_statistics.total_gethash++;
276 #endif
277                 if (flags & status_flags::hash_calculated) {
278 #ifdef GINAC_COMPARE_STATISTICS
279                         compare_statistics.gethash_cached++;
280 #endif
281                         return hashvalue;
282                 } else {
283                         return calchash();
284                 }
285         }
286
287         /** Set some status_flags. */
288         const basic & setflag(unsigned f) const {flags |= f; return *this;}
289
290         /** Clear some status_flags. */
291         const basic & clearflag(unsigned f) const {flags &= ~f; return *this;}
292
293 protected:
294         void ensure_if_modifiable() const;
295
296         void do_print(const print_context & c, unsigned level) const;
297         void do_print_tree(const print_tree & c, unsigned level) const;
298         void do_print_python_repr(const print_python_repr & c, unsigned level) const;
299         
300         // member variables
301 protected:
302         mutable unsigned flags;             ///< of type status_flags
303         mutable unsigned hashvalue;         ///< hash value
304 };
305
306 // global variables
307
308
309 // convenience type checker template functions
310
311 /** Check if obj is a T, including base classes. */
312 template <class T>
313 inline bool is_a(const basic &obj)
314 {
315         return dynamic_cast<const T *>(&obj) != nullptr;
316 }
317
318 /** Check if obj is a T, not including base classes. */
319 template <class T>
320 inline bool is_exactly_a(const basic & obj)
321 {
322         return typeid(T) == typeid(obj);
323 }
324
325 /** Constructs a new (class basic or derived) B object on the heap.
326  *
327  *  This function picks the object's ctor based on the given argument types.
328  *
329  *  This helps the constructor of ex from basic (or a derived class B) because
330  *  then the constructor doesn't have to duplicate the object onto the heap.
331  *  See ex::construct_from_basic(const basic &) for more information.
332  */
333 template<class B, typename... Args>
334 inline B & dynallocate(Args &&... args)
335 {
336         return const_cast<B &>(static_cast<const B &>((new B(std::forward<Args>(args)...))->setflag(status_flags::dynallocated)));
337 }
338 /** Constructs a new (class basic or derived) B object on the heap.
339  *
340  *  This function is needed for GiNaC classes which have public ctors from
341  *  initializer lists of expressions (which are not a type and not captured
342  *  by the variadic template version).
343  */
344 template<class B>
345 inline B & dynallocate(std::initializer_list<ex> il)
346 {
347         return const_cast<B &>(static_cast<const B &>((new B(il))->setflag(status_flags::dynallocated)));
348 }
349
350 } // namespace GiNaC
351
352 #endif // ndef GINAC_BASIC_H