3 * Implementation of GiNaC's ABC. */
6 * GiNaC Copyright (C) 1999-2000 Johannes Gutenberg University Mainz, Germany
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.
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.
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
38 #ifndef NO_NAMESPACE_GINAC
40 #endif // ndef NO_NAMESPACE_GINAC
42 GINAC_IMPLEMENT_REGISTERED_CLASS(basic, void)
45 // default constructor, destructor, copy constructor assignment operator and helpers
50 #ifndef INLINE_BASIC_CONSTRUCTORS
51 basic::basic() : flags(0), refcount(0), tinfo_key(TINFO_BASIC)
53 debugmsg("basic default constructor", LOGLEVEL_CONSTRUCT);
59 debugmsg("basic destructor", LOGLEVEL_DESTRUCT);
61 GINAC_ASSERT((!(flags & status_flags::dynallocated))||(refcount==0));
64 basic::basic(const basic & other) : flags(0), refcount(0), tinfo_key(TINFO_BASIC)
66 debugmsg("basic copy constructor", LOGLEVEL_CONSTRUCT);
71 const basic & basic::operator=(const basic & other)
73 debugmsg("basic operator=", LOGLEVEL_ASSIGNMENT);
89 #ifndef INLINE_BASIC_CONSTRUCTORS
90 basic::basic(unsigned ti) : flags(0), refcount(0), tinfo_key(ti)
92 debugmsg("basic constructor with tinfo_key", LOGLEVEL_CONSTRUCT);
101 /** Construct object from archive_node. */
102 basic::basic(const archive_node &n, const lst &sym_lst) : flags(0), refcount(0)
104 debugmsg("basic constructor from archive_node", LOGLEVEL_CONSTRUCT);
106 // Reconstruct tinfo_key from class name
108 if (n.find_string("class", class_name))
109 tinfo_key = find_tinfo_key(class_name);
111 throw (std::runtime_error("archive node contains no class name"));
114 /** Unarchive the object. */
115 ex basic::unarchive(const archive_node &n, const lst &sym_lst)
117 return (new basic(n, sym_lst))->setflag(status_flags::dynallocated);
120 /** Archive the object. */
121 void basic::archive(archive_node &n) const
123 n.add_string("class", class_name());
127 // functions overriding virtual functions from bases classes
133 // new virtual functions which can be overridden by derived classes
138 /** Output to stream formatted to be useful as ginsh input. */
139 void basic::print(ostream & os, unsigned upper_precedence) const
141 debugmsg("basic print",LOGLEVEL_PRINT);
142 os << "[basic object]";
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
149 debugmsg("basic printraw",LOGLEVEL_PRINT);
150 os << "[basic object]";
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
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);
167 /** Output to stream formatted as C-source.
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
175 debugmsg("basic print csrc", LOGLEVEL_PRINT);
178 /** Little wrapper arount print to be called within a debugger. */
179 void basic::dbgprint(void) const
185 /** Little wrapper arount printtree to be called within a debugger. */
186 void basic::dbgprinttree(void) const
191 basic * basic::duplicate() const
193 debugmsg("basic duplicate",LOGLEVEL_DUPLICATE);
194 return new basic(*this);
197 /** Information about the object.
199 * @see class info_flags */
200 bool basic::info(unsigned inf) const
202 return false; // all possible properties are false for basic objects
205 /** Number of operands/members. */
206 unsigned basic::nops() const
211 /** Return operand/member at position i. */
212 ex basic::op(int i) const
214 return (const_cast<basic *>(this))->let_op(i);
217 /** Return modifyable operand/member at position i. */
218 ex & basic::let_op(int i)
220 throw(std::out_of_range("op() out of range"));
223 ex basic::operator[](const ex & index) const
225 if (is_exactly_of_type(*index.bp,numeric))
226 return op(static_cast<const numeric &>(*index.bp).to_int());
228 throw(std::invalid_argument("non-numeric indices not supported by this type"));
231 ex basic::operator[](int i) const
236 /** Search ocurrences. An object 'has' an expression if it is the expression
237 * itself or one of the children 'has' it. */
238 bool basic::has(const ex & other) const
240 GINAC_ASSERT(other.bp!=0);
241 if (is_equal(*other.bp)) return true;
243 for (unsigned i=0; i<nops(); i++) {
244 if (op(i).has(other)) return true;
250 /** Return degree of highest power in symbol s. */
251 int basic::degree(const symbol & s) const
256 /** Return degree of lowest power in symbol s. */
257 int basic::ldegree(const symbol & s) const
262 /** Return coefficient of degree n in symbol s. */
263 ex basic::coeff(const symbol & s, int n) const
265 return n==0 ? *this : _ex0();
268 /** Sort expression in terms of powers of some symbol.
269 * @param s symbol to sort in. */
270 ex basic::collect(const symbol & s) const
273 int ldeg = this->ldegree(s);
274 int deg = this->degree(s);
275 for (int n=ldeg; n<=deg; n++) {
276 x += this->coeff(s,n)*power(s,n);
281 /* Perform automatic symbolic evaluations on expression. */
282 ex basic::eval(int level) const
287 /** Evaluate object numerically. */
288 ex basic::evalf(int level) const
293 /* Substitute a set of symbols. */
294 ex basic::subs(const lst & ls, const lst & lr) const
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.
303 * @param s symbol to differentiate in
304 * @param nth order of differentiation
306 ex basic::diff(const symbol & s, unsigned nth) const
308 // trivial: zeroth derivative
312 // evaluate unevaluated *this before differentiating
313 if (!(flags & status_flags::evaluated))
314 return ex(*this).diff(s, nth);
316 ex ndiff = derivative(s);
317 while (!ndiff.is_zero() && // stop differentiating zeros
319 ndiff = ndiff.diff(s);
325 exvector basic::get_indices(void) const
327 return exvector(); // return an empty exvector
330 ex basic::simplify_ncmul(const exvector & v) const
332 return simplified_ncmul(v);
337 /** Default implementation of ex::diff(). It simply throws an error message.
339 * @exception logic_error (differentiation not supported by this type)
341 ex basic::derivative(const symbol & s) const
343 throw(std::logic_error("differentiation not supported by this type"));
346 /** Returns order relation between two objects of same type. Needs to be
347 * implemented by each class. */
348 int basic::compare_same_type(const basic & other) const
350 return compare_pointers(this, &other);
353 /** Returns true if two objects of same type are equal. Normally needs
354 * not be reimplemented as long as it wasn't overwritten by some parent
355 * class, since it just calls complare_same_type(). */
356 bool basic::is_equal_same_type(const basic & other) const
358 return compare_same_type(other)==0;
361 unsigned basic::return_type(void) const
363 return return_types::commutative;
366 unsigned basic::return_type_tinfo(void) const
371 unsigned basic::calchash(void) const
373 unsigned v=golden_ratio_hash(tinfo());
374 for (unsigned i=0; i<nops(); i++) {
376 v ^= (const_cast<basic *>(this))->op(i).gethash();
381 // store calculated hash value only if object is already evaluated
382 if (flags & status_flags::evaluated) {
383 setflag(status_flags::hash_calculated);
390 /** Expand expression, i.e. multiply it out and return the result as a new
392 ex basic::expand(unsigned options) const
394 return this->setflag(status_flags::expanded);
399 // non-virtual functions in this class
404 /** Substitute symbols in expression and return the result as a new expression.
405 * There are two valid types of replacement arguments: 1) a relational like
406 * symbol==ex and 2) a list of relationals lst(symbol1==ex1,symbol2==ex2,...),
407 * which is converted to subs(lst(symbol1,symbol2,...),lst(ex1,ex2,...)).
408 * In addition, an object of class idx can be used instead of a symbol. */
409 ex basic::subs(const ex & e) const
411 if (e.info(info_flags::relation_equal)) {
414 if (!e.info(info_flags::list)) {
415 throw(std::invalid_argument("basic::subs(ex): argument must be a list"));
419 for (unsigned i=0; i<e.nops(); i++) {
420 if (!e.op(i).info(info_flags::relation_equal)) {
421 throw(std::invalid_argument("basic::subs(ex): argument must be a list or equations"));
423 if (!e.op(i).op(0).info(info_flags::symbol)) {
424 if (!e.op(i).op(0).info(info_flags::idx)) {
425 throw(std::invalid_argument("basic::subs(ex): lhs must be a symbol or an idx"));
428 ls.append(e.op(i).op(0));
429 lr.append(e.op(i).op(1));
434 /** Compare objects to establish canonical order.
435 * All compare functions return: -1 for *this less than other, 0 equal,
437 int basic::compare(const basic & other) const
439 unsigned hash_this = gethash();
440 unsigned hash_other = other.gethash();
442 if (hash_this<hash_other) return -1;
443 if (hash_this>hash_other) return 1;
445 unsigned typeid_this = tinfo();
446 unsigned typeid_other = other.tinfo();
448 if (typeid_this<typeid_other) {
450 cout << "hash collision, different types: "
451 << *this << " and " << other << endl;
452 this->printraw(cout);
454 other.printraw(cout);
459 if (typeid_this>typeid_other) {
461 cout << "hash collision, different types: "
462 << *this << " and " << other << endl;
463 this->printraw(cout);
465 other.printraw(cout);
471 GINAC_ASSERT(typeid(*this)==typeid(other));
473 int cmpval=compare_same_type(other);
474 if ((cmpval!=0)&&(hash_this<0x80000000U)) {
476 cout << "hash collision, same type: "
477 << *this << " and " << other << endl;
478 this->printraw(cout);
480 other.printraw(cout);
487 /** Test for equality. */
488 bool basic::is_equal(const basic & other) const
490 unsigned hash_this = gethash();
491 unsigned hash_other = other.gethash();
493 if (hash_this!=hash_other) return false;
495 unsigned typeid_this = tinfo();
496 unsigned typeid_other = other.tinfo();
498 if (typeid_this!=typeid_other) return false;
500 GINAC_ASSERT(typeid(*this)==typeid(other));
502 return is_equal_same_type(other);
507 /** Stop further evaluation.
508 * @see basic::eval */
509 const basic & basic::hold(void) const
511 return setflag(status_flags::evaluated);
514 void basic::ensure_if_modifiable(void) const
517 throw(std::runtime_error("cannot modify multiply referenced object"));
522 // static member variables
527 unsigned basic::precedence = 70;
528 unsigned basic::delta_indent = 4;
534 const basic some_basic;
535 const type_info & typeid_basic=typeid(some_basic);
541 int max_recursion_level=1024;
543 #ifndef NO_NAMESPACE_GINAC
545 #endif // ndef NO_NAMESPACE_GINAC