3 * Implementation of GiNaC's ABC. */
6 * GiNaC Copyright (C) 1999 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
40 // default constructor, destructor, copy constructor assignment operator and helpers
45 #ifndef INLINE_BASIC_CONSTRUCTORS
46 basic::basic() : flags(0), refcount(0), tinfo_key(TINFO_BASIC)
48 debugmsg("basic default constructor",LOGLEVEL_CONSTRUCT);
54 debugmsg("basic destructor",LOGLEVEL_DESTRUCT);
56 GINAC_ASSERT((!(flags & status_flags::dynallocated))||(refcount==0));
59 basic::basic(basic const & other) : flags(0), refcount(0), tinfo_key(TINFO_BASIC)
61 debugmsg("basic copy constructor",LOGLEVEL_CONSTRUCT);
66 basic const & basic::operator=(basic const & other)
68 debugmsg("basic operator=",LOGLEVEL_ASSIGNMENT);
79 void basic::copy(basic const & other)
81 flags=other.flags & ~ status_flags::dynallocated;
82 hashvalue=other.hashvalue;
83 tinfo_key=other.tinfo_key;
91 #ifndef INLINE_BASIC_CONSTRUCTORS
92 basic::basic(unsigned ti) : flags(0), refcount(0), tinfo_key(ti)
94 debugmsg("basic constructor with tinfo_key",LOGLEVEL_CONSTRUCT);
100 // functions overriding virtual functions from bases classes
106 // new virtual functions which can be overridden by derived classes
111 basic * basic::duplicate() const
113 debugmsg("basic duplicate",LOGLEVEL_DUPLICATE);
114 return new basic(*this);
117 bool basic::info(unsigned inf) const
119 return false; // all possible properties are false for basic objects
122 int basic::nops() const
127 ex basic::op(int const i) const
129 return (const_cast<basic *>(this))->let_op(i);
132 ex & basic::let_op(int const i)
134 throw(std::out_of_range("op() out of range"));
137 ex basic::operator[](ex const & index) const
139 if (is_exactly_of_type(*index.bp,numeric)) {
140 return op(static_cast<numeric const &>(*index.bp).to_int());
142 throw(std::invalid_argument("non-numeric indices not supported by this type"));
145 ex basic::operator[](int const i) const
150 bool basic::has(ex const & other) const
152 GINAC_ASSERT(other.bp!=0);
153 if (is_equal(*other.bp)) return true;
155 for (int i=0; i<nops(); i++) {
156 if (op(i).has(other)) return true;
162 int basic::degree(symbol const & s) const
167 int basic::ldegree(symbol const & s) const
172 ex basic::coeff(symbol const & s, int const n) const
174 return n==0 ? *this : exZERO();
177 ex basic::collect(symbol const & s) const
182 for (int n=ldeg; n<=deg; n++) {
183 x += coeff(s,n)*power(s,n);
188 ex basic::eval(int level) const
193 ex basic::evalf(int level) const
198 ex basic::subs(lst const & ls, lst const & lr) const
203 exvector basic::get_indices(void) const
205 return exvector(); // return an empty exvector
208 ex basic::simplify_ncmul(exvector const & v) const
210 return simplified_ncmul(v);
215 int basic::compare_same_type(basic const & other) const
217 return compare_pointers(this, &other);
220 bool basic::is_equal_same_type(basic const & other) const
222 return compare_same_type(other)==0;
225 unsigned basic::return_type(void) const
227 return return_types::commutative;
230 unsigned basic::return_type_tinfo(void) const
235 unsigned basic::calchash(void) const
237 unsigned v=golden_ratio_hash(tinfo());
238 for (int i=0; i<nops(); i++) {
240 v ^= (const_cast<basic *>(this))->let_op(i).gethash();
245 // store calculated hash value only if object is already evaluated
246 if (flags & status_flags::evaluated) {
247 setflag(status_flags::hash_calculated);
254 ex basic::expand(unsigned options) const
256 return this->setflag(status_flags::expanded);
260 // non-virtual functions in this class
265 ex basic::subs(ex const & e) const
267 // accept 2 types of replacement expressions:
269 // - lst(symbol1==ex1,symbol2==ex2,...)
270 // convert to subs(lst(symbol1,symbol2,...),lst(ex1,ex2,...))
271 // additionally, idx can be used instead of symbol
272 if (e.info(info_flags::relation_equal)) {
275 if (!e.info(info_flags::list)) {
276 throw(std::invalid_argument("basic::subs(ex): argument must be a list"));
280 for (int i=0; i<e.nops(); i++) {
281 if (!e.op(i).info(info_flags::relation_equal)) {
282 throw(std::invalid_argument("basic::subs(ex): argument must be a list or equations"));
284 if (!e.op(i).op(0).info(info_flags::symbol)) {
285 if (!e.op(i).op(0).info(info_flags::idx)) {
286 throw(std::invalid_argument("basic::subs(ex): lhs must be a symbol or an idx"));
289 ls.append(e.op(i).op(0));
290 lr.append(e.op(i).op(1));
295 // compare functions to sort expressions canonically
296 // all compare functions return: -1 for *this less than other, 0 equal, 1 greater
299 int basic::compare(basic const & other) const
301 const type_info & typeid_this = typeid(*this);
302 const type_info & typeid_other = typeid(other);
304 if (typeid_this==typeid_other) {
305 return compare_same_type(other);
308 // special rule: sort numeric() to end
309 if (typeid_this==typeid_numeric) return 1;
310 if (typeid_other==typeid_numeric) return -1;
312 // otherwise: sort according to type_info order (arbitrary, but well defined)
313 return typeid_this.before(typeid_other) ? -1 : 1;
317 int basic::compare(basic const & other) const
319 unsigned hash_this = gethash();
320 unsigned hash_other = other.gethash();
322 if (hash_this<hash_other) return -1;
323 if (hash_this>hash_other) return 1;
325 unsigned typeid_this = tinfo();
326 unsigned typeid_other = other.tinfo();
328 if (typeid_this<typeid_other) {
330 cout << "hash collision, different types: "
331 << *this << " and " << other << endl;
332 this->printraw(cout);
334 other.printraw(cout);
339 if (typeid_this>typeid_other) {
341 cout << "hash collision, different types: "
342 << *this << " and " << other << endl;
343 this->printraw(cout);
345 other.printraw(cout);
351 GINAC_ASSERT(typeid(*this)==typeid(other));
353 int cmpval=compare_same_type(other);
354 if ((cmpval!=0)&&(hash_this<0x80000000U)) {
356 cout << "hash collision, same type: "
357 << *this << " and " << other << endl;
358 this->printraw(cout);
360 other.printraw(cout);
367 bool basic::is_equal(basic const & other) const
369 unsigned hash_this = gethash();
370 unsigned hash_other = other.gethash();
372 if (hash_this!=hash_other) return false;
374 unsigned typeid_this = tinfo();
375 unsigned typeid_other = other.tinfo();
377 if (typeid_this!=typeid_other) return false;
379 GINAC_ASSERT(typeid(*this)==typeid(other));
381 return is_equal_same_type(other);
386 basic const & basic::hold(void) const
388 return setflag(status_flags::evaluated);
391 void basic::ensure_if_modifiable(void) const
394 throw(std::runtime_error("cannot modify multiply referenced object"));
399 // static member variables
404 unsigned basic::precedence=70;
405 unsigned basic::delta_indent=4;
411 const basic some_basic;
412 type_info const & typeid_basic=typeid(some_basic);
418 int max_recursion_level=1024;