- revamped indexed objects
[ginac.git] / ginac / basic.cpp
1 /** @file basic.cpp
2  *
3  *  Implementation of GiNaC's ABC. */
4
5 /*
6  *  GiNaC Copyright (C) 1999-2001 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 #include <iostream>
24 #include <typeinfo>
25 #include <stdexcept>
26
27 #include "basic.h"
28 #include "ex.h"
29 #include "numeric.h"
30 #include "power.h"
31 #include "symbol.h"
32 #include "lst.h"
33 #include "ncmul.h"
34 #include "archive.h"
35 #include "utils.h"
36 #include "debugmsg.h"
37
38 namespace GiNaC {
39
40 GINAC_IMPLEMENT_REGISTERED_CLASS_NO_CTORS(basic, void)
41
42 //////////
43 // default ctor, dtor, copy ctor assignment operator and helpers
44 //////////
45
46 // public
47
48 basic::basic(const basic & other) : tinfo_key(TINFO_basic), flags(0), refcount(0)
49 {
50         debugmsg("basic copy ctor", LOGLEVEL_CONSTRUCT);
51         copy(other);
52 }
53
54 const basic & basic::operator=(const basic & other)
55 {
56         debugmsg("basic operator=", LOGLEVEL_ASSIGNMENT);
57         if (this != &other) {
58                 destroy(true);
59                 copy(other);
60         }
61         return *this;
62 }
63
64 // protected
65
66 // none (all conditionally inlined)
67
68 //////////
69 // other ctors
70 //////////
71
72 // none (all conditionally inlined)
73
74 //////////
75 // archiving
76 //////////
77
78 /** Construct object from archive_node. */
79 basic::basic(const archive_node &n, const lst &sym_lst) : flags(0), refcount(0)
80 {
81         debugmsg("basic ctor from archive_node", LOGLEVEL_CONSTRUCT);
82
83         // Reconstruct tinfo_key from class name
84         std::string class_name;
85         if (n.find_string("class", class_name))
86                 tinfo_key = find_tinfo_key(class_name);
87         else
88                 throw (std::runtime_error("archive node contains no class name"));
89 }
90
91 /** Unarchive the object. */
92 ex basic::unarchive(const archive_node &n, const lst &sym_lst)
93 {
94         return (new basic(n, sym_lst))->setflag(status_flags::dynallocated);
95 }
96
97 /** Archive the object. */
98 void basic::archive(archive_node &n) const
99 {
100         n.add_string("class", class_name());
101 }
102
103 //////////
104 // functions overriding virtual functions from bases classes
105 //////////
106
107 // none
108
109 //////////
110 // new virtual functions which can be overridden by derived classes
111 //////////
112
113 // public
114
115 /** Output to ostream formatted as parsable (as in ginsh) input.
116  *  Generally, superfluous parenthesis should be avoided as far as possible. */
117 void basic::print(std::ostream & os, unsigned upper_precedence) const
118 {
119         debugmsg("basic print",LOGLEVEL_PRINT);
120         os << "[" << class_name() << " object]";
121 }
122
123 /** Output to ostream in ugly raw format, so brave developers can have a look
124  *  at the underlying structure. */
125 void basic::printraw(std::ostream & os) const
126 {
127         debugmsg("basic printraw",LOGLEVEL_PRINT);
128         os << "[" << class_name() << " object]";
129 }
130
131 /** Output to ostream formatted in tree- (indented-) form, so developers can
132  *  have a look at the underlying structure. */
133 void basic::printtree(std::ostream & os, unsigned indent) const
134 {
135         debugmsg("basic printtree",LOGLEVEL_PRINT);
136         os << std::string(indent,' ') << "type=" << class_name()
137            << ", hash=" << hashvalue
138            << " (0x" << std::hex << hashvalue << std::dec << ")"
139            << ", flags=" << flags
140            << ", nops=" << nops() << std::endl;
141         for (unsigned i=0; i<nops(); ++i) {
142                 op(i).printtree(os,indent+delta_indent);
143         }
144 }
145
146 /** Output to ostream formatted as C-source.
147  *
148  *  @param os a stream for output
149  *  @param type variable type (one of the csrc_types)
150  *  @param upper_precedence operator precedence of caller
151  *  @see ex::printcsrc */
152 void basic::printcsrc(std::ostream & os, unsigned type, unsigned upper_precedence) const
153 {
154         debugmsg("basic print csrc", LOGLEVEL_PRINT);
155 }
156
157 /** Little wrapper arount print to be called within a debugger.
158  *  This is needed because you cannot call foo.print(cout) from within the
159  *  debugger because it might not know what cout is.  This method can be
160  *  invoked with no argument and it will simply print to stdout.
161  *
162  *  @see basic::print*/
163 void basic::dbgprint(void) const
164 {
165         this->print(std::cerr);
166         std::cerr << std::endl;
167 }
168
169 /** Little wrapper arount printtree to be called within a debugger.
170  *
171  *  @see basic::dbgprint
172  *  @see basic::printtree */
173 void basic::dbgprinttree(void) const
174 {
175         this->printtree(std::cerr,0);
176 }
177
178 /** Create a new copy of this on the heap.  One can think of this as simulating
179  *  a virtual copy constructor which is needed for instance by the refcounted
180  *  construction of an ex from a basic. */
181 basic * basic::duplicate() const
182 {
183         debugmsg("basic duplicate",LOGLEVEL_DUPLICATE);
184         return new basic(*this);
185 }
186
187 /** Information about the object.
188  *
189  *  @see class info_flags */
190 bool basic::info(unsigned inf) const
191 {
192         // all possible properties are false for basic objects
193         return false;
194 }
195
196 /** Number of operands/members. */
197 unsigned basic::nops() const
198 {
199         // iterating from 0 to nops() on atomic objects should be an empty loop,
200         // and accessing their elements is a range error.  Container objects should
201         // override this.
202         return 0;
203 }
204
205 /** Return operand/member at position i. */
206 ex basic::op(int i) const
207 {
208         return (const_cast<basic *>(this))->let_op(i);
209 }
210
211 /** Return modifyable operand/member at position i. */
212 ex & basic::let_op(int i)
213 {
214         throw(std::out_of_range("op() out of range"));
215 }
216
217 ex basic::operator[](const ex & index) const
218 {
219         if (is_exactly_of_type(*index.bp,numeric))
220                 return op(static_cast<const numeric &>(*index.bp).to_int());
221         
222         throw(std::invalid_argument("non-numeric indices not supported by this type"));
223 }
224
225 ex basic::operator[](int i) const
226 {
227         return op(i);
228 }
229
230 /** Search ocurrences.  An object  'has' an expression if it is the expression
231  *  itself or one of the children 'has' it.  As a consequence (according to
232  *  the definition of children) given e=x+y+z, e.has(x) is true but e.has(x+y)
233  *  is false. */
234 bool basic::has(const ex & other) const
235 {
236         GINAC_ASSERT(other.bp!=0);
237         if (is_equal(*other.bp)) return true;
238         if (nops()>0) {
239                 for (unsigned i=0; i<nops(); i++)
240                         if (op(i).has(other))
241                                 return true;
242         }
243         
244         return false;
245 }
246
247 /** Return degree of highest power in symbol s. */
248 int basic::degree(const symbol & s) const
249 {
250         return 0;
251 }
252
253 /** Return degree of lowest power in symbol s. */
254 int basic::ldegree(const symbol & s) const
255 {
256         return 0;
257 }
258
259 /** Return coefficient of degree n in symbol s. */
260 ex basic::coeff(const symbol & s, int n) const
261 {
262         return n==0 ? *this : _ex0();
263 }
264
265 /** Sort expression in terms of powers of some symbol.
266  *  @param s symbol to sort in. */
267 ex basic::collect(const symbol & s) const
268 {
269         ex x;
270         for (int n=this->ldegree(s); n<=this->degree(s); n++)
271                 x += this->coeff(s,n)*power(s,n);
272         
273         return x;
274 }
275
276 /** Perform automatic non-interruptive symbolic evaluation on expression. */
277 ex basic::eval(int level) const
278 {
279         // There is nothing to do for basic objects:
280         return this->hold();
281 }
282
283 /** Evaluate object numerically. */
284 ex basic::evalf(int level) const
285 {
286         // There is nothing to do for basic objects:
287         return *this;
288 }
289
290 /** Perform automatic symbolic evaluations on indexed expression that
291  *  contains this object as the base expression. */
292 ex basic::eval_indexed(const basic & i) const
293  // this function can't take a "const ex & i" because that would result
294  // in an infinite eval() loop
295 {
296         // There is nothing to do for basic objects
297         return i.hold();
298 }
299
300 /** Try to contract two indexed expressions. If a contraction exists, the
301  *  function overwrites one or both arguments and returns true. Otherwise it
302  *  returns false. It is guaranteed that both expressions are of class
303  *  indexed (or a subclass) and that at least one dummy index has been
304  *  found.
305  *
306  *  @param self The first indexed expression; it's base object is *this
307  *  @param other The second indexed expression
308  *  @return true if the contraction was successful, false otherwise */
309 bool basic::contract_with(ex & self, ex & other) const
310 {
311         // Do nothing
312         return false;
313 }
314
315 /** Substitute a set of symbols by arbitrary expressions. The ex returned
316  *  will already be evaluated. */
317 ex basic::subs(const lst & ls, const lst & lr) const
318 {
319         return *this;
320 }
321
322 /** Default interface of nth derivative ex::diff(s, n).  It should be called
323  *  instead of ::derivative(s) for first derivatives and for nth derivatives it
324  *  just recurses down.
325  *
326  *  @param s symbol to differentiate in
327  *  @param nth order of differentiation
328  *  @see ex::diff */
329 ex basic::diff(const symbol & s, unsigned nth) const
330 {
331         // trivial: zeroth derivative
332         if (nth==0)
333                 return ex(*this);
334         
335         // evaluate unevaluated *this before differentiating
336         if (!(flags & status_flags::evaluated))
337                 return ex(*this).diff(s, nth);
338         
339         ex ndiff = this->derivative(s);
340         while (!ndiff.is_zero() &&    // stop differentiating zeros
341                nth>1) {
342                 ndiff = ndiff.diff(s);
343                 --nth;
344         }
345         return ndiff;
346 }
347
348 /** Return a vector containing the free indices of an expression. */
349 exvector basic::get_free_indices(void) const
350 {
351         return exvector(); // return an empty exvector
352 }
353
354 ex basic::simplify_ncmul(const exvector & v) const
355 {
356         return simplified_ncmul(v);
357 }
358
359 // protected
360
361 /** Default implementation of ex::diff(). It simply throws an error message.
362  *
363  *  @exception logic_error (differentiation not supported by this type)
364  *  @see ex::diff */
365 ex basic::derivative(const symbol & s) const
366 {
367         throw(std::logic_error("differentiation not supported by this type"));
368 }
369
370 /** Returns order relation between two objects of same type.  This needs to be
371  *  implemented by each class. It may never return anything else than 0,
372  *  signalling equality, or +1 and -1 signalling inequality and determining
373  *  the canonical ordering. */
374 int basic::compare_same_type(const basic & other) const
375 {
376         return compare_pointers(this, &other);
377 }
378
379 /** Returns true if two objects of same type are equal.  Normally needs
380  *  not be reimplemented as long as it wasn't overwritten by some parent
381  *  class, since it just calls compare_same_type().  The reason why this
382  *  function exists is that sometimes it is easier to determine equality
383  *  than an order relation and then it can be overridden. */
384 bool basic::is_equal_same_type(const basic & other) const
385 {
386         return this->compare_same_type(other)==0;
387 }
388
389 unsigned basic::return_type(void) const
390 {
391         return return_types::commutative;
392 }
393
394 unsigned basic::return_type_tinfo(void) const
395 {
396         return tinfo();
397 }
398
399 /** Compute the hash value of an object and if it makes sense to store it in
400  *  the objects status_flags, do so.  The method inherited from class basic
401  *  computes a hash value based on the type and hash values of possible
402  *  members.  For this reason it is well suited for container classes but
403  *  atomic classes should override this implementation because otherwise they
404  *  would all end up with the same hashvalue. */
405 unsigned basic::calchash(void) const
406 {
407         unsigned v = golden_ratio_hash(tinfo());
408         for (unsigned i=0; i<nops(); i++) {
409                 v = rotate_left_31(v);
410                 v ^= (const_cast<basic *>(this))->op(i).gethash();
411         }
412         
413         // mask out numeric hashes:
414         v &= 0x7FFFFFFFU;
415         
416         // store calculated hash value only if object is already evaluated
417         if (flags & status_flags::evaluated) {
418                 setflag(status_flags::hash_calculated);
419                 hashvalue = v;
420         }
421
422         return v;
423 }
424
425 /** Expand expression, i.e. multiply it out and return the result as a new
426  *  expression. */
427 ex basic::expand(unsigned options) const
428 {
429         return this->setflag(status_flags::expanded);
430 }
431
432
433 //////////
434 // non-virtual functions in this class
435 //////////
436
437 // public
438
439 /** Substitute symbols in expression and return the result as a new expression.
440  *  There are two valid types of replacement arguments: 1) a relational like
441  *  symbol==ex and 2) a list of relationals lst(symbol1==ex1,symbol2==ex2,...),
442  *  which is converted to subs(lst(symbol1,symbol2,...),lst(ex1,ex2,...)).
443  *  In addition, an object of class idx can be used instead of a symbol. */
444 ex basic::subs(const ex & e) const
445 {
446         if (e.info(info_flags::relation_equal)) {
447                 return subs(lst(e));
448         }
449         if (!e.info(info_flags::list)) {
450                 throw(std::invalid_argument("basic::subs(ex): argument must be a list"));
451         }
452         lst ls;
453         lst lr;
454         for (unsigned i=0; i<e.nops(); i++) {
455                 if (!e.op(i).info(info_flags::relation_equal)) {
456                         throw(std::invalid_argument("basic::subs(ex): argument must be a list or equations"));
457                 }
458                 if (!e.op(i).op(0).info(info_flags::symbol)) {
459                         if (!e.op(i).op(0).info(info_flags::idx)) {
460                                 throw(std::invalid_argument("basic::subs(ex): lhs must be a symbol or an idx"));
461                         }
462                 }
463                 ls.append(e.op(i).op(0));
464                 lr.append(e.op(i).op(1));
465         }
466         return subs(ls,lr);
467 }
468
469 /** Compare objects to establish canonical ordering.
470  *  All compare functions return: -1 for *this less than other, 0 equal,
471  *  1 greater. */
472 int basic::compare(const basic & other) const
473 {
474         unsigned hash_this = gethash();
475         unsigned hash_other = other.gethash();
476         
477         if (hash_this<hash_other) return -1;
478         if (hash_this>hash_other) return 1;
479         
480         unsigned typeid_this = tinfo();
481         unsigned typeid_other = other.tinfo();
482         
483         if (typeid_this<typeid_other) {
484 //              std::cout << "hash collision, different types: " 
485 //                        << *this << " and " << other << std::endl;
486 //              this->printraw(std::cout);
487 //              std::cout << " and ";
488 //              other.printraw(std::cout);
489 //              std::cout << std::endl;
490                 return -1;
491         }
492         if (typeid_this>typeid_other) {
493 //              std::cout << "hash collision, different types: " 
494 //                        << *this << " and " << other << std::endl;
495 //              this->printraw(std::cout);
496 //              std::cout << " and ";
497 //              other.printraw(std::cout);
498 //              std::cout << std::endl;
499                 return 1;
500         }
501         
502         GINAC_ASSERT(typeid(*this)==typeid(other));
503         
504         int cmpval = compare_same_type(other);
505         if ((cmpval!=0) && (hash_this<0x80000000U)) {
506 //              std::cout << "hash collision, same type: " 
507 //                        << *this << " and " << other << std::endl;
508 //              this->printraw(std::cout);
509 //              std::cout << " and ";
510 //              other.printraw(std::cout);
511 //              std::cout << std::endl;
512         }
513         return cmpval;
514 }
515
516 /** Test for equality.
517  *  This is only a quick test, meaning objects should be in the same domain.
518  *  You might have to .expand(), .normal() objects first, depending on the
519  *  domain of your computation, to get a more reliable answer.
520  *
521  *  @see is_equal_same_type */
522 bool basic::is_equal(const basic & other) const
523 {
524         if (this->gethash()!=other.gethash())
525                 return false;
526         if (this->tinfo()!=other.tinfo())
527                 return false;
528         
529         GINAC_ASSERT(typeid(*this)==typeid(other));
530         
531         return this->is_equal_same_type(other);
532 }
533
534 // protected
535
536 /** Stop further evaluation.
537  *
538  *  @see basic::eval */
539 const basic & basic::hold(void) const
540 {
541         return this->setflag(status_flags::evaluated);
542 }
543
544 /** Ensure the object may be modified without hurting others, throws if this
545  *  is not the case. */
546 void basic::ensure_if_modifiable(void) const
547 {
548         if (this->refcount>1)
549                 throw(std::runtime_error("cannot modify multiply referenced object"));
550 }
551
552 //////////
553 // static member variables
554 //////////
555
556 // protected
557
558 unsigned basic::precedence = 70;
559 unsigned basic::delta_indent = 4;
560
561 //////////
562 // global variables
563 //////////
564
565 int max_recursion_level = 1024;
566
567 } // namespace GiNaC