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