Make .eval() evaluate top-level only.
[ginac.git] / ginac / basic.cpp
1 /** @file basic.cpp
2  *
3  *  Implementation of GiNaC's ABC. */
4
5 /*
6  *  GiNaC Copyright (C) 1999-2015 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 #include "basic.h"
24 #include "ex.h"
25 #include "numeric.h"
26 #include "power.h"
27 #include "add.h"
28 #include "symbol.h"
29 #include "lst.h"
30 #include "ncmul.h"
31 #include "relational.h"
32 #include "operators.h"
33 #include "wildcard.h"
34 #include "archive.h"
35 #include "utils.h"
36 #include "hash_seed.h"
37 #include "inifcns.h"
38
39 #include <iostream>
40 #include <stdexcept>
41 #include <typeinfo>
42
43 namespace GiNaC {
44
45 GINAC_IMPLEMENT_REGISTERED_CLASS_OPT(basic, void,
46   print_func<print_context>(&basic::do_print).
47   print_func<print_tree>(&basic::do_print_tree).
48   print_func<print_python_repr>(&basic::do_print_python_repr))
49
50 //////////
51 // default constructor, destructor, copy constructor and assignment operator
52 //////////
53
54 // public
55
56 /** basic copy constructor: implicitly assumes that the other class is of
57  *  the exact same type (as it's used by duplicate()), so it can copy the
58  *  tinfo_key and the hash value. */
59 basic::basic(const basic & other) : flags(other.flags & ~status_flags::dynallocated), hashvalue(other.hashvalue)
60 {
61 }
62
63 /** basic assignment operator: the other object might be of a derived class. */
64 const basic & basic::operator=(const basic & other)
65 {
66         unsigned fl = other.flags & ~status_flags::dynallocated;
67         if (typeid(*this) != typeid(other)) {
68                 // The other object is of a derived class, so clear the flags as they
69                 // might no longer apply (especially hash_calculated). Oh, and don't
70                 // copy the tinfo_key: it is already set correctly for this object.
71                 fl &= ~(status_flags::evaluated | status_flags::expanded | status_flags::hash_calculated);
72         } else {
73                 // The objects are of the exact same class, so copy the hash value.
74                 hashvalue = other.hashvalue;
75         }
76         flags = fl;
77         set_refcount(0);
78         return *this;
79 }
80
81 // protected
82
83 // none (all inlined)
84
85 //////////
86 // other constructors
87 //////////
88
89 // none (all inlined)
90
91 //////////
92 // archiving
93 //////////
94
95 /** Construct object from archive_node. */
96 void basic::read_archive(const archive_node& n, lst& syms)
97 { }
98
99 /** Archive the object. */
100 void basic::archive(archive_node &n) const
101 {
102         n.add_string("class", class_name());
103 }
104
105 //////////
106 // new virtual functions which can be overridden by derived classes
107 //////////
108
109 // public
110
111 /** Output to stream. This performs double dispatch on the dynamic type of
112  *  *this and the dynamic type of the supplied print context.
113  *  @param c print context object that describes the output formatting
114  *  @param level value that is used to identify the precedence or indentation
115  *               level for placing parentheses and formatting */
116 void basic::print(const print_context & c, unsigned level) const
117 {
118         print_dispatch(get_class_info(), c, level);
119 }
120
121 /** Like print(), but dispatch to the specified class. Can be used by
122  *  implementations of print methods to dispatch to the method of the
123  *  superclass.
124  *
125  *  @see basic::print */
126 void basic::print_dispatch(const registered_class_info & ri, const print_context & c, unsigned level) const
127 {
128         // Double dispatch on object type and print_context type
129         const registered_class_info * reg_info = &ri;
130         const print_context_class_info * pc_info = &c.get_class_info();
131
132 next_class:
133         const std::vector<print_functor> & pdt = reg_info->options.get_print_dispatch_table();
134
135 next_context:
136         unsigned id = pc_info->options.get_id();
137         if (id >= pdt.size() || !(pdt[id].is_valid())) {
138
139                 // Method not found, try parent print_context class
140                 const print_context_class_info * parent_pc_info = pc_info->get_parent();
141                 if (parent_pc_info) {
142                         pc_info = parent_pc_info;
143                         goto next_context;
144                 }
145
146                 // Method still not found, try parent class
147                 const registered_class_info * parent_reg_info = reg_info->get_parent();
148                 if (parent_reg_info) {
149                         reg_info = parent_reg_info;
150                         pc_info = &c.get_class_info();
151                         goto next_class;
152                 }
153
154                 // Method still not found. This shouldn't happen because basic (the
155                 // base class of the algebraic hierarchy) registers a method for
156                 // print_context (the base class of the print context hierarchy),
157                 // so if we end up here, there's something wrong with the class
158                 // registry.
159                 throw (std::runtime_error(std::string("basic::print(): method for ") + class_name() + "/" + c.class_name() + " not found"));
160
161         } else {
162
163                 // Call method
164                 pdt[id](*this, c, level);
165         }
166 }
167
168 /** Default output to stream. */
169 void basic::do_print(const print_context & c, unsigned level) const
170 {
171         c.s << "[" << class_name() << " object]";
172 }
173
174 /** Tree output to stream. */
175 void basic::do_print_tree(const print_tree & c, unsigned level) const
176 {
177         c.s << std::string(level, ' ') << class_name() << " @" << this
178             << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec;
179         if (nops())
180                 c.s << ", nops=" << nops();
181         c.s << std::endl;
182         for (size_t i=0; i<nops(); ++i)
183                 op(i).print(c, level + c.delta_indent);
184 }
185
186 /** Python parsable output to stream. */
187 void basic::do_print_python_repr(const print_python_repr & c, unsigned level) const
188 {
189         c.s << class_name() << "()";
190 }
191
192 /** Little wrapper around print to be called within a debugger.
193  *  This is needed because you cannot call foo.print(cout) from within the
194  *  debugger because it might not know what cout is.  This method can be
195  *  invoked with no argument and it will simply print to stdout.
196  *
197  *  @see basic::print
198  *  @see basic::dbgprinttree */
199 void basic::dbgprint() const
200 {
201         this->print(print_dflt(std::cerr));
202         std::cerr << std::endl;
203 }
204
205 /** Little wrapper around printtree to be called within a debugger.
206  *
207  *  @see basic::dbgprint */
208 void basic::dbgprinttree() const
209 {
210         this->print(print_tree(std::cerr));
211 }
212
213 /** Return relative operator precedence (for parenthezing output). */
214 unsigned basic::precedence() const
215 {
216         return 70;
217 }
218
219 /** Information about the object.
220  *
221  *  @see class info_flags */
222 bool basic::info(unsigned inf) const
223 {
224         // all possible properties are false for basic objects
225         return false;
226 }
227
228 /** Number of operands/members. */
229 size_t basic::nops() const
230 {
231         // iterating from 0 to nops() on atomic objects should be an empty loop,
232         // and accessing their elements is a range error.  Container objects should
233         // override this.
234         return 0;
235 }
236
237 /** Return operand/member at position i. */
238 ex basic::op(size_t i) const
239 {
240         throw(std::range_error(std::string("basic::op(): ") + class_name() + std::string(" has no operands")));
241 }
242
243 /** Return modifiable operand/member at position i. */
244 ex & basic::let_op(size_t i)
245 {
246         ensure_if_modifiable();
247         throw(std::range_error(std::string("basic::let_op(): ") + class_name() + std::string(" has no operands")));
248 }
249
250 ex basic::operator[](const ex & index) const
251 {
252         if (is_exactly_a<numeric>(index))
253                 return op(static_cast<size_t>(ex_to<numeric>(index).to_int()));
254
255         throw(std::invalid_argument(std::string("non-numeric indices not supported by ") + class_name()));
256 }
257
258 ex basic::operator[](size_t i) const
259 {
260         return op(i);
261 }
262
263 ex & basic::operator[](const ex & index)
264 {
265         if (is_exactly_a<numeric>(index))
266                 return let_op(ex_to<numeric>(index).to_int());
267
268         throw(std::invalid_argument(std::string("non-numeric indices not supported by ") + class_name()));
269 }
270
271 ex & basic::operator[](size_t i)
272 {
273         return let_op(i);
274 }
275
276 /** Test for occurrence of a pattern.  An object 'has' a pattern if it matches
277  *  the pattern itself or one of the children 'has' it.  As a consequence
278  *  (according to the definition of children) given e=x+y+z, e.has(x) is true
279  *  but e.has(x+y) is false. */
280 bool basic::has(const ex & pattern, unsigned options) const
281 {
282         exmap repl_lst;
283         if (match(pattern, repl_lst))
284                 return true;
285         for (size_t i=0; i<nops(); i++)
286                 if (op(i).has(pattern, options))
287                         return true;
288         
289         return false;
290 }
291
292 /** Construct new expression by applying the specified function to all
293  *  sub-expressions (one level only, not recursively). */
294 ex basic::map(map_function & f) const
295 {
296         size_t num = nops();
297         if (num == 0)
298                 return *this;
299
300         basic *copy = nullptr;
301         for (size_t i=0; i<num; i++) {
302                 const ex & o = op(i);
303                 const ex & n = f(o);
304                 if (!are_ex_trivially_equal(o, n)) {
305                         if (copy == nullptr)
306                                 copy = duplicate();
307                         copy->let_op(i) = n;
308                 }
309         }
310
311         if (copy) {
312                 copy->clearflag(status_flags::hash_calculated | status_flags::expanded);
313                 return *copy;
314         } else
315                 return *this;
316 }
317
318 /** Check whether this is a polynomial in the given variables. */
319 bool basic::is_polynomial(const ex & var) const
320 {
321         return !has(var) || is_equal(ex_to<basic>(var));
322 }
323
324 /** Return degree of highest power in object s. */
325 int basic::degree(const ex & s) const
326 {
327         return is_equal(ex_to<basic>(s)) ? 1 : 0;
328 }
329
330 /** Return degree of lowest power in object s. */
331 int basic::ldegree(const ex & s) const
332 {
333         return is_equal(ex_to<basic>(s)) ? 1 : 0;
334 }
335
336 /** Return coefficient of degree n in object s. */
337 ex basic::coeff(const ex & s, int n) const
338 {
339         if (is_equal(ex_to<basic>(s)))
340                 return n==1 ? _ex1 : _ex0;
341         else
342                 return n==0 ? *this : _ex0;
343 }
344
345 /** Sort expanded expression in terms of powers of some object(s).
346  *  @param s object(s) to sort in
347  *  @param distributed recursive or distributed form (only used when s is a list) */
348 ex basic::collect(const ex & s, bool distributed) const
349 {
350         ex x;
351         if (is_a<lst>(s)) {
352
353                 // List of objects specified
354                 if (s.nops() == 0)
355                         return *this;
356                 if (s.nops() == 1)
357                         return collect(s.op(0));
358
359                 else if (distributed) {
360
361                         x = this->expand();
362                         if (! is_a<add>(x))
363                                 return x; 
364                         const lst& l(ex_to<lst>(s));
365
366                         exmap cmap;
367                         cmap[_ex1] = _ex0;
368                         for (const auto & xi : x) {
369                                 ex key = _ex1;
370                                 ex pre_coeff = xi;
371                                 for (auto & li : l) {
372                                         int cexp = pre_coeff.degree(li);
373                                         pre_coeff = pre_coeff.coeff(li, cexp);
374                                         key *= pow(li, cexp);
375                                 }
376                                 exmap::iterator ci = cmap.find(key);
377                                 if (ci != cmap.end())
378                                         ci->second += pre_coeff;
379                                 else
380                                         cmap.insert(exmap::value_type(key, pre_coeff));
381                         }
382
383                         exvector resv;
384                         for (auto & mi : cmap)
385                                 resv.push_back((mi.first)*(mi.second));
386                         return dynallocate<add>(resv);
387
388                 } else {
389
390                         // Recursive form
391                         x = *this;
392                         size_t n = s.nops() - 1;
393                         while (true) {
394                                 x = x.collect(s[n]);
395                                 if (n == 0)
396                                         break;
397                                 n--;
398                         }
399                 }
400
401         } else {
402
403                 // Only one object specified
404                 for (int n=this->ldegree(s); n<=this->degree(s); ++n)
405                         x += this->coeff(s,n)*power(s,n);
406         }
407         
408         // correct for lost fractional arguments and return
409         return x + (*this - x).expand();
410 }
411
412 /** Perform automatic non-interruptive term rewriting rules. */
413 ex basic::eval() const
414 {
415         // There is nothing to do for basic objects:
416         return hold();
417 }
418
419 /** Function object to be applied by basic::evalf(). */
420 struct evalf_map_function : public map_function {
421         int level;
422         evalf_map_function(int l) : level(l) {}
423         ex operator()(const ex & e) override { return evalf(e, level); }
424 };
425
426 /** Evaluate object numerically. */
427 ex basic::evalf(int level) const
428 {
429         if (nops() == 0)
430                 return *this;
431         else {
432                 if (level == 1)
433                         return *this;
434                 else if (level == -max_recursion_level)
435                         throw(std::runtime_error("max recursion level reached"));
436                 else {
437                         evalf_map_function map_evalf(level - 1);
438                         return map(map_evalf);
439                 }
440         }
441 }
442
443 /** Function object to be applied by basic::evalm(). */
444 struct evalm_map_function : public map_function {
445         ex operator()(const ex & e) override { return evalm(e); }
446 } map_evalm;
447
448 /** Evaluate sums, products and integer powers of matrices. */
449 ex basic::evalm() const
450 {
451         if (nops() == 0)
452                 return *this;
453         else
454                 return map(map_evalm);
455 }
456
457 /** Function object to be applied by basic::eval_integ(). */
458 struct eval_integ_map_function : public map_function {
459         ex operator()(const ex & e) override { return eval_integ(e); }
460 } map_eval_integ;
461
462 /** Evaluate integrals, if result is known. */
463 ex basic::eval_integ() const
464 {
465         if (nops() == 0)
466                 return *this;
467         else
468                 return map(map_eval_integ);
469 }
470
471 /** Perform automatic symbolic evaluations on indexed expression that
472  *  contains this object as the base expression. */
473 ex basic::eval_indexed(const basic & i) const
474  // this function can't take a "const ex & i" because that would result
475  // in an infinite eval() loop
476 {
477         // There is nothing to do for basic objects
478         return i.hold();
479 }
480
481 /** Add two indexed expressions. They are guaranteed to be of class indexed
482  *  (or a subclass) and their indices are compatible. This function is used
483  *  internally by simplify_indexed().
484  *
485  *  @param self First indexed expression; its base object is *this
486  *  @param other Second indexed expression
487  *  @return sum of self and other 
488  *  @see ex::simplify_indexed() */
489 ex basic::add_indexed(const ex & self, const ex & other) const
490 {
491         return self + other;
492 }
493
494 /** Multiply an indexed expression with a scalar. This function is used
495  *  internally by simplify_indexed().
496  *
497  *  @param self Indexed expression; its base object is *this
498  *  @param other Numeric value
499  *  @return product of self and other
500  *  @see ex::simplify_indexed() */
501 ex basic::scalar_mul_indexed(const ex & self, const numeric & other) const
502 {
503         return self * other;
504 }
505
506 /** Try to contract two indexed expressions that appear in the same product. 
507  *  If a contraction exists, the function overwrites one or both of the
508  *  expressions and returns true. Otherwise it returns false. It is
509  *  guaranteed that both expressions are of class indexed (or a subclass)
510  *  and that at least one dummy index has been found. This functions is
511  *  used internally by simplify_indexed().
512  *
513  *  @param self Pointer to first indexed expression; its base object is *this
514  *  @param other Pointer to second indexed expression
515  *  @param v The complete vector of factors
516  *  @return true if the contraction was successful, false otherwise
517  *  @see ex::simplify_indexed() */
518 bool basic::contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const
519 {
520         // Do nothing
521         return false;
522 }
523
524 /** Check whether the expression matches a given pattern. For every wildcard
525  *  object in the pattern, a pair with the wildcard as a key and matching 
526  *  expression as a value is added to repl_lst. */
527 bool basic::match(const ex & pattern, exmap& repl_lst) const
528 {
529 /*
530         Sweet sweet shapes, sweet sweet shapes,
531         That's the key thing, right right.
532         Feed feed face, feed feed shapes,
533         But who is the king tonight?
534         Who is the king tonight?
535         Pattern is the thing, the key thing-a-ling,
536         But who is the king of Pattern?
537         But who is the king, the king thing-a-ling,
538         Who is the king of Pattern?
539         Bog is the king, the king thing-a-ling,
540         Bog is the king of Pattern.
541         Ba bu-bu-bu-bu bu-bu-bu-bu-bu-bu bu-bu
542         Bog is the king of Pattern.
543 */
544
545         if (is_exactly_a<wildcard>(pattern)) {
546
547                 // Wildcard matches anything, but check whether we already have found
548                 // a match for that wildcard first (if so, the earlier match must be
549                 // the same expression)
550                 for (auto & it : repl_lst) {
551                         if (it.first.is_equal(pattern))
552                                 return is_equal(ex_to<basic>(it.second));
553                 }
554                 repl_lst[pattern] = *this;
555                 return true;
556
557         } else {
558
559                 // Expression must be of the same type as the pattern
560                 if (typeid(*this) != typeid(ex_to<basic>(pattern)))
561                         return false;
562
563                 // Number of subexpressions must match
564                 if (nops() != pattern.nops())
565                         return false;
566
567                 // No subexpressions? Then just compare the objects (there can't be
568                 // wildcards in the pattern)
569                 if (nops() == 0)
570                         return is_equal_same_type(ex_to<basic>(pattern));
571
572                 // Check whether attributes that are not subexpressions match
573                 if (!match_same_type(ex_to<basic>(pattern)))
574                         return false;
575
576                 // Even if the expression does not match the pattern, some of
577                 // its subexpressions could match it. For example, x^5*y^(-1)
578                 // does not match the pattern $0^5, but its subexpression x^5
579                 // does. So, save repl_lst in order to not add bogus entries.
580                 exmap tmp_repl = repl_lst;
581                 // Otherwise the subexpressions must match one-to-one
582                 for (size_t i=0; i<nops(); i++)
583                         if (!op(i).match(pattern.op(i), tmp_repl))
584                                 return false;
585
586                 // Looks similar enough, match found
587                 repl_lst = tmp_repl;
588                 return true;
589         }
590 }
591
592 /** Helper function for subs(). Does not recurse into subexpressions. */
593 ex basic::subs_one_level(const exmap & m, unsigned options) const
594 {
595         if (options & subs_options::no_pattern) {
596                 auto it = m.find(*this);
597                 if (it != m.end())
598                         return it->second;
599                 return *this;
600         } else {
601                 for (auto & it : m) {
602                         exmap repl_lst;
603                         if (match(ex_to<basic>(it.first), repl_lst))
604                                 return it.second.subs(repl_lst, options | subs_options::no_pattern);
605                         // avoid infinite recursion when re-substituting the wildcards
606                 }
607         }
608
609         return *this;
610 }
611
612 /** Substitute a set of objects by arbitrary expressions. The ex returned
613  *  will already be evaluated. */
614 ex basic::subs(const exmap & m, unsigned options) const
615 {
616         size_t num = nops();
617         if (num) {
618
619                 // Substitute in subexpressions
620                 for (size_t i=0; i<num; i++) {
621                         const ex & orig_op = op(i);
622                         const ex & subsed_op = orig_op.subs(m, options);
623                         if (!are_ex_trivially_equal(orig_op, subsed_op)) {
624
625                                 // Something changed, clone the object
626                                 basic *copy = duplicate();
627                                 copy->clearflag(status_flags::hash_calculated | status_flags::expanded);
628
629                                 // Substitute the changed operand
630                                 copy->let_op(i++) = subsed_op;
631
632                                 // Substitute the other operands
633                                 for (; i<num; i++)
634                                         copy->let_op(i) = op(i).subs(m, options);
635
636                                 // Perform substitutions on the new object as a whole
637                                 return copy->subs_one_level(m, options);
638                         }
639                 }
640         }
641
642         // Nothing changed or no subexpressions
643         return subs_one_level(m, options);
644 }
645
646 /** Default interface of nth derivative ex::diff(s, n).  It should be called
647  *  instead of ::derivative(s) for first derivatives and for nth derivatives it
648  *  just recurses down.
649  *
650  *  @param s symbol to differentiate in
651  *  @param nth order of differentiation
652  *  @see ex::diff */
653 ex basic::diff(const symbol & s, unsigned nth) const
654 {
655         // trivial: zeroth derivative
656         if (nth==0)
657                 return ex(*this);
658         
659         // evaluate unevaluated *this before differentiating
660         if (!(flags & status_flags::evaluated))
661                 return ex(*this).diff(s, nth);
662         
663         ex ndiff = this->derivative(s);
664         while (!ndiff.is_zero() &&    // stop differentiating zeros
665                nth>1) {
666                 ndiff = ndiff.diff(s);
667                 --nth;
668         }
669         return ndiff;
670 }
671
672 /** Return a vector containing the free indices of an expression. */
673 exvector basic::get_free_indices() const
674 {
675         return exvector(); // return an empty exvector
676 }
677
678 ex basic::conjugate() const
679 {
680         return *this;
681 }
682
683 ex basic::real_part() const
684 {
685         return real_part_function(*this).hold();
686 }
687
688 ex basic::imag_part() const
689 {
690         return imag_part_function(*this).hold();
691 }
692
693 ex basic::eval_ncmul(const exvector & v) const
694 {
695         return hold_ncmul(v);
696 }
697
698 // protected
699
700 /** Function object to be applied by basic::derivative(). */
701 struct derivative_map_function : public map_function {
702         const symbol &s;
703         derivative_map_function(const symbol &sym) : s(sym) {}
704         ex operator()(const ex & e) override { return diff(e, s); }
705 };
706
707 /** Default implementation of ex::diff(). It maps the operation on the
708  *  operands (or returns 0 when the object has no operands).
709  *
710  *  @see ex::diff */
711 ex basic::derivative(const symbol & s) const
712 {
713         if (nops() == 0)
714                 return _ex0;
715         else {
716                 derivative_map_function map_derivative(s);
717                 return map(map_derivative);
718         }
719 }
720
721 /** Returns order relation between two objects of same type.  This needs to be
722  *  implemented by each class. It may never return anything else than 0,
723  *  signalling equality, or +1 and -1 signalling inequality and determining
724  *  the canonical ordering.  (Perl hackers will wonder why C++ doesn't feature
725  *  the spaceship operator <=> for denoting just this.) */
726 int basic::compare_same_type(const basic & other) const
727 {
728         return compare_pointers(this, &other);
729 }
730
731 /** Returns true if two objects of same type are equal.  Normally needs
732  *  not be reimplemented as long as it wasn't overwritten by some parent
733  *  class, since it just calls compare_same_type().  The reason why this
734  *  function exists is that sometimes it is easier to determine equality
735  *  than an order relation and then it can be overridden. */
736 bool basic::is_equal_same_type(const basic & other) const
737 {
738         return compare_same_type(other)==0;
739 }
740
741 /** Returns true if the attributes of two objects are similar enough for
742  *  a match. This function must not match subexpressions (this is already
743  *  done by basic::match()). Only attributes not accessible by op() should
744  *  be compared. This is also the reason why this function doesn't take the
745  *  wildcard replacement list from match() as an argument: only subexpressions
746  *  are subject to wildcard matches. Also, this function only needs to be
747  *  implemented for container classes because is_equal_same_type() is
748  *  automatically used instead of match_same_type() if nops() == 0.
749  *
750  *  @see basic::match */
751 bool basic::match_same_type(const basic & other) const
752 {
753         // The default is to only consider subexpressions, but not any other
754         // attributes
755         return true;
756 }
757
758 unsigned basic::return_type() const
759 {
760         return return_types::commutative;
761 }
762
763 return_type_t basic::return_type_tinfo() const
764 {
765         return_type_t rt;
766         rt.tinfo = &typeid(*this);
767         rt.rl = 0;
768         return rt;
769 }
770
771 /** Compute the hash value of an object and if it makes sense to store it in
772  *  the objects status_flags, do so.  The method inherited from class basic
773  *  computes a hash value based on the type and hash values of possible
774  *  members.  For this reason it is well suited for container classes but
775  *  atomic classes should override this implementation because otherwise they
776  *  would all end up with the same hashvalue. */
777 unsigned basic::calchash() const
778 {
779         unsigned v = make_hash_seed(typeid(*this));
780         for (size_t i=0; i<nops(); i++) {
781                 v = rotate_left(v);
782                 v ^= this->op(i).gethash();
783         }
784
785         // store calculated hash value only if object is already evaluated
786         if (flags & status_flags::evaluated) {
787                 setflag(status_flags::hash_calculated);
788                 hashvalue = v;
789         }
790
791         return v;
792 }
793
794 /** Function object to be applied by basic::expand(). */
795 struct expand_map_function : public map_function {
796         unsigned options;
797         expand_map_function(unsigned o) : options(o) {}
798         ex operator()(const ex & e) override { return e.expand(options); }
799 };
800
801 /** Expand expression, i.e. multiply it out and return the result as a new
802  *  expression. */
803 ex basic::expand(unsigned options) const
804 {
805         if (nops() == 0)
806                 return (options == 0) ? setflag(status_flags::expanded) : *this;
807         else {
808                 expand_map_function map_expand(options);
809                 return ex_to<basic>(map(map_expand)).setflag(options == 0 ? status_flags::expanded : 0);
810         }
811 }
812
813
814 //////////
815 // non-virtual functions in this class
816 //////////
817
818 // public
819
820 /** Compare objects syntactically to establish canonical ordering.
821  *  All compare functions return: -1 for *this less than other, 0 equal,
822  *  1 greater. */
823 int basic::compare(const basic & other) const
824 {
825 #ifdef GINAC_COMPARE_STATISTICS
826         compare_statistics.total_basic_compares++;
827 #endif
828         const unsigned hash_this = gethash();
829         const unsigned hash_other = other.gethash();
830         if (hash_this<hash_other) return -1;
831         if (hash_this>hash_other) return 1;
832 #ifdef GINAC_COMPARE_STATISTICS
833         compare_statistics.compare_same_hashvalue++;
834 #endif
835
836         const std::type_info& typeid_this = typeid(*this);
837         const std::type_info& typeid_other = typeid(other);
838         if (typeid_this == typeid_other) {
839 //              int cmpval = compare_same_type(other);
840 //              if (cmpval!=0) {
841 //                      std::cout << "hash collision, same type: " 
842 //                                << *this << " and " << other << std::endl;
843 //                      this->print(print_tree(std::cout));
844 //                      std::cout << " and ";
845 //                      other.print(print_tree(std::cout));
846 //                      std::cout << std::endl;
847 //              }
848 //              return cmpval;
849 #ifdef GINAC_COMPARE_STATISTICS
850                 compare_statistics.compare_same_type++;
851 #endif
852                 return compare_same_type(other);
853         } else {
854 //              std::cout << "hash collision, different types: " 
855 //                        << *this << " and " << other << std::endl;
856 //              this->print(print_tree(std::cout));
857 //              std::cout << " and ";
858 //              other.print(print_tree(std::cout));
859 //              std::cout << std::endl;
860                 return (typeid_this.before(typeid_other) ? -1 : 1);
861         }
862 }
863
864 /** Test for syntactic equality.
865  *  This is only a quick test, meaning objects should be in the same domain.
866  *  You might have to .expand(), .normal() objects first, depending on the
867  *  domain of your computation, to get a more reliable answer.
868  *
869  *  @see is_equal_same_type */
870 bool basic::is_equal(const basic & other) const
871 {
872 #ifdef GINAC_COMPARE_STATISTICS
873         compare_statistics.total_basic_is_equals++;
874 #endif
875         if (this->gethash()!=other.gethash())
876                 return false;
877 #ifdef GINAC_COMPARE_STATISTICS
878         compare_statistics.is_equal_same_hashvalue++;
879 #endif
880         if (typeid(*this) != typeid(other))
881                 return false;
882         
883 #ifdef GINAC_COMPARE_STATISTICS
884         compare_statistics.is_equal_same_type++;
885 #endif
886         return is_equal_same_type(other);
887 }
888
889 // protected
890
891 /** Stop further evaluation.
892  *
893  *  @see basic::eval */
894 const basic & basic::hold() const
895 {
896         return setflag(status_flags::evaluated);
897 }
898
899 /** Ensure the object may be modified without hurting others, throws if this
900  *  is not the case. */
901 void basic::ensure_if_modifiable() const
902 {
903         if (get_refcount() > 1)
904                 throw(std::runtime_error("cannot modify multiply referenced object"));
905         clearflag(status_flags::hash_calculated | status_flags::evaluated);
906 }
907
908 //////////
909 // global variables
910 //////////
911
912 int max_recursion_level = 1024;
913
914
915 #ifdef GINAC_COMPARE_STATISTICS
916 compare_statistics_t::~compare_statistics_t()
917 {
918         std::clog << "ex::compare() called " << total_compares << " times" << std::endl;
919         std::clog << "nontrivial compares: " << nontrivial_compares << " times" << std::endl;
920         std::clog << "basic::compare() called " << total_basic_compares << " times" << std::endl;
921         std::clog << "same hashvalue in compare(): " << compare_same_hashvalue << " times" << std::endl;
922         std::clog << "compare_same_type() called " << compare_same_type << " times" << std::endl;
923         std::clog << std::endl;
924         std::clog << "ex::is_equal() called " << total_is_equals << " times" << std::endl;
925         std::clog << "nontrivial is_equals: " << nontrivial_is_equals << " times" << std::endl;
926         std::clog << "basic::is_equal() called " << total_basic_is_equals << " times" << std::endl;
927         std::clog << "same hashvalue in is_equal(): " << is_equal_same_hashvalue << " times" << std::endl;
928         std::clog << "is_equal_same_type() called " << is_equal_same_type << " times" << std::endl;
929         std::clog << std::endl;
930         std::clog << "basic::gethash() called " << total_gethash << " times" << std::endl;
931         std::clog << "used cached hashvalue " << gethash_cached << " times" << std::endl;
932 }
933
934 compare_statistics_t compare_statistics;
935 #endif
936
937 } // namespace GiNaC