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_GINAC_NAMESPACE
40 #endif // ndef NO_GINAC_NAMESPACE
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(basic const & other) : flags(0), refcount(0), tinfo_key(TINFO_BASIC)
66 debugmsg("basic copy constructor", LOGLEVEL_CONSTRUCT);
71 basic const & basic::operator=(basic const & other)
73 debugmsg("basic operator=", LOGLEVEL_ASSIGNMENT);
84 void basic::copy(basic const & other)
86 flags=other.flags & ~ status_flags::dynallocated;
87 hashvalue=other.hashvalue;
88 tinfo_key=other.tinfo_key;
96 #ifndef INLINE_BASIC_CONSTRUCTORS
97 basic::basic(unsigned ti) : flags(0), refcount(0), tinfo_key(ti)
99 debugmsg("basic constructor with tinfo_key", LOGLEVEL_CONSTRUCT);
108 /** Construct object from archive_node. */
109 basic::basic(const archive_node &n, const lst &sym_lst) : flags(0), refcount(0)
111 debugmsg("basic constructor from archive_node", LOGLEVEL_CONSTRUCT);
113 // Reconstruct tinfo_key from class name
115 if (n.find_string("class", class_name))
116 tinfo_key = find_tinfo_key(class_name);
118 throw (std::runtime_error("archive node contains no class name"));
121 /** Unarchive the object. */
122 ex basic::unarchive(const archive_node &n, const lst &sym_lst)
124 return (new basic(n, sym_lst))->setflag(status_flags::dynallocated);
127 /** Archive the object. */
128 void basic::archive(archive_node &n) const
130 n.add_string("class", class_name());
134 // functions overriding virtual functions from bases classes
140 // new virtual functions which can be overridden by derived classes
145 /** Output to stream formatted to be useful as ginsh input. */
146 void basic::print(ostream & os, unsigned upper_precedence) const
148 debugmsg("basic print",LOGLEVEL_PRINT);
149 os << "[basic object]";
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
156 debugmsg("basic printraw",LOGLEVEL_PRINT);
157 os << "[basic object]";
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
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);
174 /** Output to stream formatted as C-source.
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
182 debugmsg("basic print csrc", LOGLEVEL_PRINT);
185 /** Little wrapper arount print to be called within a debugger. */
186 void basic::dbgprint(void) const
192 /** Little wrapper arount printtree to be called within a debugger. */
193 void basic::dbgprinttree(void) const
198 basic * basic::duplicate() const
200 debugmsg("basic duplicate",LOGLEVEL_DUPLICATE);
201 return new basic(*this);
204 bool basic::info(unsigned inf) const
206 return false; // all possible properties are false for basic objects
209 unsigned basic::nops() const
214 ex basic::op(int const i) const
216 return (const_cast<basic *>(this))->let_op(i);
219 ex & basic::let_op(int const i)
221 throw(std::out_of_range("op() out of range"));
224 ex basic::operator[](ex const & index) const
226 if (is_exactly_of_type(*index.bp,numeric)) {
227 return op(static_cast<numeric const &>(*index.bp).to_int());
229 throw(std::invalid_argument("non-numeric indices not supported by this type"));
232 ex basic::operator[](int const i) const
237 bool basic::has(ex const & other) const
239 GINAC_ASSERT(other.bp!=0);
240 if (is_equal(*other.bp)) return true;
242 for (unsigned i=0; i<nops(); i++) {
243 if (op(i).has(other)) return true;
249 int basic::degree(symbol const & s) const
254 int basic::ldegree(symbol const & s) const
259 ex basic::coeff(symbol const & s, int const n) const
261 return n==0 ? *this : _ex0();
264 ex basic::collect(symbol const & s) const
269 for (int n=ldeg; n<=deg; n++) {
270 x += coeff(s,n)*power(s,n);
275 ex basic::eval(int level) const
280 ex basic::evalf(int level) const
285 ex basic::subs(lst const & ls, lst const & lr) const
290 exvector basic::get_indices(void) const
292 return exvector(); // return an empty exvector
295 ex basic::simplify_ncmul(exvector const & v) const
297 return simplified_ncmul(v);
302 int basic::compare_same_type(basic const & other) const
304 return compare_pointers(this, &other);
307 bool basic::is_equal_same_type(basic const & other) const
309 return compare_same_type(other)==0;
312 unsigned basic::return_type(void) const
314 return return_types::commutative;
317 unsigned basic::return_type_tinfo(void) const
322 unsigned basic::calchash(void) const
324 unsigned v=golden_ratio_hash(tinfo());
325 for (unsigned i=0; i<nops(); i++) {
327 v ^= (const_cast<basic *>(this))->let_op(i).gethash();
332 // store calculated hash value only if object is already evaluated
333 if (flags & status_flags::evaluated) {
334 setflag(status_flags::hash_calculated);
341 ex basic::expand(unsigned options) const
343 return this->setflag(status_flags::expanded);
347 // non-virtual functions in this class
352 ex basic::subs(ex const & e) const
354 // accept 2 types of replacement expressions:
356 // - lst(symbol1==ex1,symbol2==ex2,...)
357 // convert to subs(lst(symbol1,symbol2,...),lst(ex1,ex2,...))
358 // additionally, idx can be used instead of symbol
359 if (e.info(info_flags::relation_equal)) {
362 if (!e.info(info_flags::list)) {
363 throw(std::invalid_argument("basic::subs(ex): argument must be a list"));
367 for (unsigned i=0; i<e.nops(); i++) {
368 if (!e.op(i).info(info_flags::relation_equal)) {
369 throw(std::invalid_argument("basic::subs(ex): argument must be a list or equations"));
371 if (!e.op(i).op(0).info(info_flags::symbol)) {
372 if (!e.op(i).op(0).info(info_flags::idx)) {
373 throw(std::invalid_argument("basic::subs(ex): lhs must be a symbol or an idx"));
376 ls.append(e.op(i).op(0));
377 lr.append(e.op(i).op(1));
382 /** Compare objects to establish canonical order.
383 * All compare functions return: -1 for *this less than other, 0 equal,
385 int basic::compare(basic const & other) const
387 unsigned hash_this = gethash();
388 unsigned hash_other = other.gethash();
390 if (hash_this<hash_other) return -1;
391 if (hash_this>hash_other) return 1;
393 unsigned typeid_this = tinfo();
394 unsigned typeid_other = other.tinfo();
396 if (typeid_this<typeid_other) {
398 cout << "hash collision, different types: "
399 << *this << " and " << other << endl;
400 this->printraw(cout);
402 other.printraw(cout);
407 if (typeid_this>typeid_other) {
409 cout << "hash collision, different types: "
410 << *this << " and " << other << endl;
411 this->printraw(cout);
413 other.printraw(cout);
419 GINAC_ASSERT(typeid(*this)==typeid(other));
421 int cmpval=compare_same_type(other);
422 if ((cmpval!=0)&&(hash_this<0x80000000U)) {
424 cout << "hash collision, same type: "
425 << *this << " and " << other << endl;
426 this->printraw(cout);
428 other.printraw(cout);
435 bool basic::is_equal(basic const & other) const
437 unsigned hash_this = gethash();
438 unsigned hash_other = other.gethash();
440 if (hash_this!=hash_other) return false;
442 unsigned typeid_this = tinfo();
443 unsigned typeid_other = other.tinfo();
445 if (typeid_this!=typeid_other) return false;
447 GINAC_ASSERT(typeid(*this)==typeid(other));
449 return is_equal_same_type(other);
454 basic const & basic::hold(void) const
456 return setflag(status_flags::evaluated);
459 void basic::ensure_if_modifiable(void) const
462 throw(std::runtime_error("cannot modify multiply referenced object"));
467 // static member variables
472 unsigned basic::precedence=70;
473 unsigned basic::delta_indent=4;
479 const basic some_basic;
480 type_info const & typeid_basic=typeid(some_basic);
486 int max_recursion_level=1024;
488 #ifndef NO_GINAC_NAMESPACE
490 #endif // ndef NO_GINAC_NAMESPACE