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