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
37 #ifndef NO_GINAC_NAMESPACE
39 #endif // ndef NO_GINAC_NAMESPACE
42 // default constructor, destructor, copy constructor assignment operator and helpers
47 #ifndef INLINE_BASIC_CONSTRUCTORS
48 basic::basic() : flags(0), refcount(0), tinfo_key(TINFO_BASIC)
50 debugmsg("basic default constructor",LOGLEVEL_CONSTRUCT);
56 debugmsg("basic destructor",LOGLEVEL_DESTRUCT);
58 GINAC_ASSERT((!(flags & status_flags::dynallocated))||(refcount==0));
61 basic::basic(basic const & other) : flags(0), refcount(0), tinfo_key(TINFO_BASIC)
63 debugmsg("basic copy constructor",LOGLEVEL_CONSTRUCT);
68 basic const & basic::operator=(basic const & other)
70 debugmsg("basic operator=",LOGLEVEL_ASSIGNMENT);
81 void basic::copy(basic const & other)
83 flags=other.flags & ~ status_flags::dynallocated;
84 hashvalue=other.hashvalue;
85 tinfo_key=other.tinfo_key;
93 #ifndef INLINE_BASIC_CONSTRUCTORS
94 basic::basic(unsigned ti) : flags(0), refcount(0), tinfo_key(ti)
96 debugmsg("basic constructor with tinfo_key",LOGLEVEL_CONSTRUCT);
102 // functions overriding virtual functions from bases classes
108 // new virtual functions which can be overridden by derived classes
113 /** Output to stream formatted to be useful as ginsh input. */
114 void basic::print(ostream & os, unsigned upper_precedence) const
116 debugmsg("basic print",LOGLEVEL_PRINT);
117 os << "[basic object]";
120 /** Output to stream in ugly raw format, so brave developers can have a look
121 * at the underlying structure. */
122 void basic::printraw(ostream & os) const
124 debugmsg("basic printraw",LOGLEVEL_PRINT);
125 os << "[basic object]";
128 /** Output to stream formatted in tree- (indented-) form, so developers can
129 * have a look at the underlying structure. */
130 void basic::printtree(ostream & os, unsigned indent) const
132 debugmsg("basic printtree",LOGLEVEL_PRINT);
133 os << string(indent,' ') << "type=" << typeid(*this).name()
134 << ", hash=" << hashvalue << " (0x" << hex << hashvalue << dec << ")"
135 << ", flags=" << flags
136 << ", nops=" << nops() << endl;
137 for (unsigned i=0; i<nops(); ++i) {
138 op(i).printtree(os,indent+delta_indent);
142 /** Output to stream formatted as C-source.
144 * @param os a stream for output
145 * @param type variable type (one of the csrc_types)
146 * @param upper_precedence operator precedence of caller
147 * @see ex::printcsrc */
148 void basic::printcsrc(ostream & os, unsigned type, unsigned upper_precedence) const
150 debugmsg("basic print csrc", LOGLEVEL_PRINT);
153 /** Little wrapper arount print to be called within a debugger. */
154 void basic::dbgprint(void) const
160 /** Little wrapper arount printtree to be called within a debugger. */
161 void basic::dbgprinttree(void) const
166 basic * basic::duplicate() const
168 debugmsg("basic duplicate",LOGLEVEL_DUPLICATE);
169 return new basic(*this);
172 bool basic::info(unsigned inf) const
174 return false; // all possible properties are false for basic objects
177 unsigned basic::nops() const
182 ex basic::op(int const i) const
184 return (const_cast<basic *>(this))->let_op(i);
187 ex & basic::let_op(int const i)
189 throw(std::out_of_range("op() out of range"));
192 ex basic::operator[](ex const & index) const
194 if (is_exactly_of_type(*index.bp,numeric)) {
195 return op(static_cast<numeric const &>(*index.bp).to_int());
197 throw(std::invalid_argument("non-numeric indices not supported by this type"));
200 ex basic::operator[](int const i) const
205 bool basic::has(ex const & other) const
207 GINAC_ASSERT(other.bp!=0);
208 if (is_equal(*other.bp)) return true;
210 for (unsigned i=0; i<nops(); i++) {
211 if (op(i).has(other)) return true;
217 int basic::degree(symbol const & s) const
222 int basic::ldegree(symbol const & s) const
227 ex basic::coeff(symbol const & s, int const n) const
229 return n==0 ? *this : _ex0();
232 ex basic::collect(symbol const & s) const
237 for (int n=ldeg; n<=deg; n++) {
238 x += coeff(s,n)*power(s,n);
243 ex basic::eval(int level) const
248 ex basic::evalf(int level) const
253 ex basic::subs(lst const & ls, lst const & lr) const
258 exvector basic::get_indices(void) const
260 return exvector(); // return an empty exvector
263 ex basic::simplify_ncmul(exvector const & v) const
265 return simplified_ncmul(v);
270 int basic::compare_same_type(basic const & other) const
272 return compare_pointers(this, &other);
275 bool basic::is_equal_same_type(basic const & other) const
277 return compare_same_type(other)==0;
280 unsigned basic::return_type(void) const
282 return return_types::commutative;
285 unsigned basic::return_type_tinfo(void) const
290 unsigned basic::calchash(void) const
292 unsigned v=golden_ratio_hash(tinfo());
293 for (unsigned i=0; i<nops(); i++) {
295 v ^= (const_cast<basic *>(this))->let_op(i).gethash();
300 // store calculated hash value only if object is already evaluated
301 if (flags & status_flags::evaluated) {
302 setflag(status_flags::hash_calculated);
309 ex basic::expand(unsigned options) const
311 return this->setflag(status_flags::expanded);
315 // non-virtual functions in this class
320 ex basic::subs(ex const & e) const
322 // accept 2 types of replacement expressions:
324 // - lst(symbol1==ex1,symbol2==ex2,...)
325 // convert to subs(lst(symbol1,symbol2,...),lst(ex1,ex2,...))
326 // additionally, idx can be used instead of symbol
327 if (e.info(info_flags::relation_equal)) {
330 if (!e.info(info_flags::list)) {
331 throw(std::invalid_argument("basic::subs(ex): argument must be a list"));
335 for (unsigned i=0; i<e.nops(); i++) {
336 if (!e.op(i).info(info_flags::relation_equal)) {
337 throw(std::invalid_argument("basic::subs(ex): argument must be a list or equations"));
339 if (!e.op(i).op(0).info(info_flags::symbol)) {
340 if (!e.op(i).op(0).info(info_flags::idx)) {
341 throw(std::invalid_argument("basic::subs(ex): lhs must be a symbol or an idx"));
344 ls.append(e.op(i).op(0));
345 lr.append(e.op(i).op(1));
350 /** Compare objects to establish canonical order.
351 * All compare functions return: -1 for *this less than other, 0 equal,
353 int basic::compare(basic const & other) const
355 unsigned hash_this = gethash();
356 unsigned hash_other = other.gethash();
358 if (hash_this<hash_other) return -1;
359 if (hash_this>hash_other) return 1;
361 unsigned typeid_this = tinfo();
362 unsigned typeid_other = other.tinfo();
364 if (typeid_this<typeid_other) {
366 cout << "hash collision, different types: "
367 << *this << " and " << other << endl;
368 this->printraw(cout);
370 other.printraw(cout);
375 if (typeid_this>typeid_other) {
377 cout << "hash collision, different types: "
378 << *this << " and " << other << endl;
379 this->printraw(cout);
381 other.printraw(cout);
387 GINAC_ASSERT(typeid(*this)==typeid(other));
389 int cmpval=compare_same_type(other);
390 if ((cmpval!=0)&&(hash_this<0x80000000U)) {
392 cout << "hash collision, same type: "
393 << *this << " and " << other << endl;
394 this->printraw(cout);
396 other.printraw(cout);
403 bool basic::is_equal(basic const & other) const
405 unsigned hash_this = gethash();
406 unsigned hash_other = other.gethash();
408 if (hash_this!=hash_other) return false;
410 unsigned typeid_this = tinfo();
411 unsigned typeid_other = other.tinfo();
413 if (typeid_this!=typeid_other) return false;
415 GINAC_ASSERT(typeid(*this)==typeid(other));
417 return is_equal_same_type(other);
422 basic const & basic::hold(void) const
424 return setflag(status_flags::evaluated);
427 void basic::ensure_if_modifiable(void) const
430 throw(std::runtime_error("cannot modify multiply referenced object"));
435 // static member variables
440 unsigned basic::precedence=70;
441 unsigned basic::delta_indent=4;
447 const basic some_basic;
448 type_info const & typeid_basic=typeid(some_basic);
454 int max_recursion_level=1024;
456 #ifndef NO_GINAC_NAMESPACE
458 #endif // ndef NO_GINAC_NAMESPACE