2a4a3e39b9e3629b79b9e2e3cfd7a5307428eaa6
[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     return this->hold();
288 }
289
290 /** Evaluate object numerically. */
291 ex basic::evalf(int level) const
292 {
293     return *this;
294 }
295
296 /* Substitute a set of symbols. */
297 ex basic::subs(const lst & ls, const lst & lr) const
298 {
299     return *this;
300 }
301
302 /** Default interface of nth derivative ex::diff(s, n).  It should be called
303  *  instead of ::derivative(s) for first derivatives and for nth derivatives it
304  *  just recurses down.
305  *
306  *  @param s symbol to differentiate in
307  *  @param nth order of differentiation
308  *  @see ex::diff */
309 ex basic::diff(const symbol & s, unsigned nth) const
310 {
311     // trivial: zeroth derivative
312     if (!nth)
313         return ex(*this);
314     
315     // evaluate unevaluated *this before differentiating
316     if (!(flags & status_flags::evaluated))
317         return ex(*this).diff(s, nth);
318     
319     ex ndiff = derivative(s);
320     while (!ndiff.is_zero() &&    // stop differentiating zeros
321            nth>1) {
322         ndiff = ndiff.diff(s);
323         --nth;
324     }
325     return ndiff;
326 }
327
328 exvector basic::get_indices(void) const
329 {
330     return exvector(); // return an empty exvector
331 }
332
333 ex basic::simplify_ncmul(const exvector & v) const
334 {
335     return simplified_ncmul(v);
336 }
337
338 // protected
339
340 /** Default implementation of ex::diff(). It simply throws an error message.
341  *
342  *  @exception logic_error (differentiation not supported by this type)
343  *  @see ex::diff */
344 ex basic::derivative(const symbol & s) const
345 {
346     throw(std::logic_error("differentiation not supported by this type"));
347 }
348
349 /** Returns order relation between two objects of same type.  Needs to be
350  *  implemented by each class. */
351 int basic::compare_same_type(const basic & other) const
352 {
353     return compare_pointers(this, &other);
354 }
355
356 /** Returns true if two objects of same type are equal.  Normally needs
357  *  not be reimplemented as long as it wasn't overwritten by some parent
358  *  class, since it just calls complare_same_type(). */
359 bool basic::is_equal_same_type(const basic & other) const
360 {
361     return compare_same_type(other)==0;
362 }
363
364 unsigned basic::return_type(void) const
365 {
366     return return_types::commutative;
367 }
368
369 unsigned basic::return_type_tinfo(void) const
370 {
371     return tinfo();
372 }
373
374 unsigned basic::calchash(void) const
375 {
376     unsigned v=golden_ratio_hash(tinfo());
377     for (unsigned i=0; i<nops(); i++) {
378         v=rotate_left_31(v);
379         v ^= (const_cast<basic *>(this))->op(i).gethash();
380     }
381
382     v = v & 0x7FFFFFFFU;
383     
384     // store calculated hash value only if object is already evaluated
385     if (flags & status_flags::evaluated) {
386         setflag(status_flags::hash_calculated);
387         hashvalue=v;
388     }
389
390     return v;
391 }
392
393 /** Expand expression, i.e. multiply it out and return the result as a new
394  *  expression. */
395 ex basic::expand(unsigned options) const
396 {
397     return this->setflag(status_flags::expanded);
398 }
399
400
401 //////////
402 // non-virtual functions in this class
403 //////////
404
405 // public
406
407 /** Substitute symbols in expression and return the result as a new expression.
408  *  There are two valid types of replacement arguments: 1) a relational like
409  *  symbol==ex and 2) a list of relationals lst(symbol1==ex1,symbol2==ex2,...),
410  *  which is converted to subs(lst(symbol1,symbol2,...),lst(ex1,ex2,...)).
411  *  In addition, an object of class idx can be used instead of a symbol. */
412 ex basic::subs(const ex & e) const
413 {
414     if (e.info(info_flags::relation_equal)) {
415         return subs(lst(e));
416     }
417     if (!e.info(info_flags::list)) {
418         throw(std::invalid_argument("basic::subs(ex): argument must be a list"));
419     }
420     lst ls;
421     lst lr;
422     for (unsigned i=0; i<e.nops(); i++) {
423         if (!e.op(i).info(info_flags::relation_equal)) {
424             throw(std::invalid_argument("basic::subs(ex): argument must be a list or equations"));
425         }
426         if (!e.op(i).op(0).info(info_flags::symbol)) {
427             if (!e.op(i).op(0).info(info_flags::idx)) {
428                 throw(std::invalid_argument("basic::subs(ex): lhs must be a symbol or an idx"));
429             }
430         }
431         ls.append(e.op(i).op(0));
432         lr.append(e.op(i).op(1));
433     }
434     return subs(ls,lr);
435 }
436
437 /** Compare objects to establish canonical order.
438  *  All compare functions return: -1 for *this less than other, 0 equal,
439  *  1 greater. */
440 int basic::compare(const basic & other) const
441 {
442     unsigned hash_this = gethash();
443     unsigned hash_other = other.gethash();
444
445     if (hash_this<hash_other) return -1;
446     if (hash_this>hash_other) return 1;
447
448     unsigned typeid_this = tinfo();
449     unsigned typeid_other = other.tinfo();
450
451     if (typeid_this<typeid_other) {
452         /*
453         cout << "hash collision, different types: " 
454              << *this << " and " << other << endl;
455         this->printraw(cout);
456         cout << " and ";
457         other.printraw(cout);
458         cout << endl;
459         */
460         return -1;
461     }
462     if (typeid_this>typeid_other) {
463         /*
464         cout << "hash collision, different types: " 
465              << *this << " and " << other << endl;
466         this->printraw(cout);
467         cout << " and ";
468         other.printraw(cout);
469         cout << endl;
470         */
471         return 1;
472     }
473
474     GINAC_ASSERT(typeid(*this)==typeid(other));
475
476     int cmpval=compare_same_type(other);
477     if ((cmpval!=0)&&(hash_this<0x80000000U)) {
478         /*
479         cout << "hash collision, same type: " 
480              << *this << " and " << other << endl;
481         this->printraw(cout);
482         cout << " and ";
483         other.printraw(cout);
484         cout << endl;
485         */
486     }
487     return cmpval;
488 }
489
490 /** Test for equality. */
491 bool basic::is_equal(const basic & other) const
492 {
493     unsigned hash_this = gethash();
494     unsigned hash_other = other.gethash();
495
496     if (hash_this!=hash_other) return false;
497
498     unsigned typeid_this = tinfo();
499     unsigned typeid_other = other.tinfo();
500
501     if (typeid_this!=typeid_other) return false;
502
503     GINAC_ASSERT(typeid(*this)==typeid(other));
504
505     return is_equal_same_type(other);
506 }
507
508 // protected
509
510 /** Stop further evaluation.
511  *  @see basic::eval */
512 const basic & basic::hold(void) const
513 {
514     return setflag(status_flags::evaluated);
515 }
516
517 void basic::ensure_if_modifiable(void) const
518 {
519     if (refcount>1) {
520         throw(std::runtime_error("cannot modify multiply referenced object"));
521     }
522 }
523
524 //////////
525 // static member variables
526 //////////
527
528 // protected
529
530 unsigned basic::precedence = 70;
531 unsigned basic::delta_indent = 4;
532
533 //////////
534 // global constants
535 //////////
536
537 const basic some_basic;
538 const type_info & typeid_basic=typeid(some_basic);
539
540 //////////
541 // global variables
542 //////////
543
544 int max_recursion_level=1024;
545
546 #ifndef NO_NAMESPACE_GINAC
547 } // namespace GiNaC
548 #endif // ndef NO_NAMESPACE_GINAC