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
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
214 /** Return operand/member at position i. */
215 ex basic::op(int i) const
217 return (const_cast<basic *>(this))->let_op(i);
220 /** Return modifyable operand/member at position i. */
221 ex & basic::let_op(int i)
223 throw(std::out_of_range("op() out of range"));
226 ex basic::operator[](const ex & index) const
228 if (is_exactly_of_type(*index.bp,numeric))
229 return op(static_cast<const numeric &>(*index.bp).to_int());
231 throw(std::invalid_argument("non-numeric indices not supported by this type"));
234 ex basic::operator[](int i) const
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
243 GINAC_ASSERT(other.bp!=0);
244 if (is_equal(*other.bp)) return true;
246 for (unsigned i=0; i<nops(); i++) {
247 if (op(i).has(other)) return true;
253 /** Return degree of highest power in symbol s. */
254 int basic::degree(const symbol & s) const
259 /** Return degree of lowest power in symbol s. */
260 int basic::ldegree(const symbol & s) const
265 /** Return coefficient of degree n in symbol s. */
266 ex basic::coeff(const symbol & s, int n) const
268 return n==0 ? *this : _ex0();
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
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);
284 /* Perform automatic symbolic evaluations on expression. */
285 ex basic::eval(int level) const
287 // There is nothing to do for basic objects:
291 /** Evaluate object numerically. */
292 ex basic::evalf(int level) const
294 // There is nothing to do for basic objects:
298 /* Substitute a set of symbols. */
299 ex basic::subs(const lst & ls, const lst & lr) const
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.
308 * @param s symbol to differentiate in
309 * @param nth order of differentiation
311 ex basic::diff(const symbol & s, unsigned nth) const
313 // trivial: zeroth derivative
317 // evaluate unevaluated *this before differentiating
318 if (!(flags & status_flags::evaluated))
319 return ex(*this).diff(s, nth);
321 ex ndiff = derivative(s);
322 while (!ndiff.is_zero() && // stop differentiating zeros
324 ndiff = ndiff.diff(s);
330 exvector basic::get_indices(void) const
332 return exvector(); // return an empty exvector
335 ex basic::simplify_ncmul(const exvector & v) const
337 return simplified_ncmul(v);
342 /** Default implementation of ex::diff(). It simply throws an error message.
344 * @exception logic_error (differentiation not supported by this type)
346 ex basic::derivative(const symbol & s) const
348 throw(std::logic_error("differentiation not supported by this type"));
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
355 return compare_pointers(this, &other);
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
363 return compare_same_type(other)==0;
366 unsigned basic::return_type(void) const
368 return return_types::commutative;
371 unsigned basic::return_type_tinfo(void) const
376 unsigned basic::calchash(void) const
378 unsigned v=golden_ratio_hash(tinfo());
379 for (unsigned i=0; i<nops(); i++) {
381 v ^= (const_cast<basic *>(this))->op(i).gethash();
386 // store calculated hash value only if object is already evaluated
387 if (flags & status_flags::evaluated) {
388 setflag(status_flags::hash_calculated);
395 /** Expand expression, i.e. multiply it out and return the result as a new
397 ex basic::expand(unsigned options) const
399 return this->setflag(status_flags::expanded);
404 // non-virtual functions in this class
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
416 if (e.info(info_flags::relation_equal)) {
419 if (!e.info(info_flags::list)) {
420 throw(std::invalid_argument("basic::subs(ex): argument must be a list"));
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"));
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"));
433 ls.append(e.op(i).op(0));
434 lr.append(e.op(i).op(1));
439 /** Compare objects to establish canonical order.
440 * All compare functions return: -1 for *this less than other, 0 equal,
442 int basic::compare(const basic & other) const
444 unsigned hash_this = gethash();
445 unsigned hash_other = other.gethash();
447 if (hash_this<hash_other) return -1;
448 if (hash_this>hash_other) return 1;
450 unsigned typeid_this = tinfo();
451 unsigned typeid_other = other.tinfo();
453 if (typeid_this<typeid_other) {
455 cout << "hash collision, different types: "
456 << *this << " and " << other << endl;
457 this->printraw(cout);
459 other.printraw(cout);
464 if (typeid_this>typeid_other) {
466 cout << "hash collision, different types: "
467 << *this << " and " << other << endl;
468 this->printraw(cout);
470 other.printraw(cout);
476 GINAC_ASSERT(typeid(*this)==typeid(other));
478 int cmpval=compare_same_type(other);
479 if ((cmpval!=0)&&(hash_this<0x80000000U)) {
481 cout << "hash collision, same type: "
482 << *this << " and " << other << endl;
483 this->printraw(cout);
485 other.printraw(cout);
492 /** Test for equality. */
493 bool basic::is_equal(const basic & other) const
495 unsigned hash_this = gethash();
496 unsigned hash_other = other.gethash();
498 if (hash_this!=hash_other) return false;
500 unsigned typeid_this = tinfo();
501 unsigned typeid_other = other.tinfo();
503 if (typeid_this!=typeid_other) return false;
505 GINAC_ASSERT(typeid(*this)==typeid(other));
507 return is_equal_same_type(other);
512 /** Stop further evaluation.
513 * @see basic::eval */
514 const basic & basic::hold(void) const
516 return setflag(status_flags::evaluated);
519 void basic::ensure_if_modifiable(void) const
522 throw(std::runtime_error("cannot modify multiply referenced object"));
527 // static member variables
532 unsigned basic::precedence = 70;
533 unsigned basic::delta_indent = 4;
539 const basic some_basic;
540 const type_info & typeid_basic=typeid(some_basic);
546 int max_recursion_level=1024;
548 #ifndef NO_NAMESPACE_GINAC
550 #endif // ndef NO_NAMESPACE_GINAC