ginac/basic.cpp

   1 /** @file basic.cpp
   2  *
   3  *  Implementation of GiNaC's ABC. */
   4
   5 /*
   6  *  GiNaC Copyright (C) 1999-2000 Johannes Gutenberg University Mainz, Germany
   7  *
   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.
  12  *
  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.
  17  *
  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
  21  */
  22
  23 #include <iostream>
  24 #include <typeinfo>
  25 #include <stdexcept>
  26
  27 #include "basic.h"
  28 #include "ex.h"
  29 #include "numeric.h"
  30 #include "power.h"
  31 #include "symbol.h"
  32 #include "lst.h"
  33 #include "ncmul.h"
  34 #include "archive.h"
  35 #include "utils.h"
  36 #include "debugmsg.h"
  37
  38 #ifndef NO_NAMESPACE_GINAC
  39 namespace GiNaC {
  40 #endif // ndef NO_NAMESPACE_GINAC
  41
  42 GINAC_IMPLEMENT_REGISTERED_CLASS(basic, void)
  43
  44 //////////
  45 // default constructor, destructor, copy constructor assignment operator and helpers
  46 //////////
  47
  48 // public
  49
  50 #ifndef INLINE_BASIC_CONSTRUCTORS
  51 basic::basic() : flags(0), refcount(0), tinfo_key(TINFO_BASIC)
  52 {
  53     debugmsg("basic default constructor", LOGLEVEL_CONSTRUCT);
  54     // nothing to do
  55 }
  56
  57 basic::~basic()
  58 {
  59     debugmsg("basic destructor", LOGLEVEL_DESTRUCT);
  60     destroy(0);
  61     GINAC_ASSERT((!(flags & status_flags::dynallocated))||(refcount==0));
  62 }
  63
  64 basic::basic(const basic & other) : flags(0), refcount(0), tinfo_key(TINFO_BASIC)
  65 {
  66     debugmsg("basic copy constructor", LOGLEVEL_CONSTRUCT);
  67     copy(other);
  68 }
  69 #endif
  70
  71 const basic & basic::operator=(const basic & other)
  72 {
  73     debugmsg("basic operator=", LOGLEVEL_ASSIGNMENT);
  74     if (this != &other) {
  75         destroy(1);
  76         copy(other);
  77     }
  78     return *this;
  79 }
  80
  81 // protected
  82
  83 // none (all inlined)
  84
  85 //////////
  86 // other constructors
  87 //////////
  88
  89 #ifndef INLINE_BASIC_CONSTRUCTORS
  90 basic::basic(unsigned ti) : flags(0), refcount(0), tinfo_key(ti)
  91 {
  92     debugmsg("basic constructor with tinfo_key", LOGLEVEL_CONSTRUCT);
  93     // nothing to do
  94 }
  95 #endif
  96
  97 //////////
  98 // archiving
  99 //////////
 100
 101 /** Construct object from archive_node. */
 102 basic::basic(const archive_node &n, const lst &sym_lst) : flags(0), refcount(0)
 103 {
 104     debugmsg("basic constructor from archive_node", LOGLEVEL_CONSTRUCT);
 105
 106     // Reconstruct tinfo_key from class name
 107     std::string class_name;
 108     if (n.find_string("class", class_name))
 109         tinfo_key = find_tinfo_key(class_name);
 110     else
 111         throw (std::runtime_error("archive node contains no class name"));
 112 }
 113
 114 /** Unarchive the object. */
 115 ex basic::unarchive(const archive_node &n, const lst &sym_lst)
 116 {
 117     return (new basic(n, sym_lst))->setflag(status_flags::dynallocated);
 118 }
 119
 120 /** Archive the object. */
 121 void basic::archive(archive_node &n) const
 122 {
 123     n.add_string("class", class_name());
 124 }
 125
 126 //////////
 127 // functions overriding virtual functions from bases classes
 128 //////////
 129
 130 // none
 131
 132 //////////
 133 // new virtual functions which can be overridden by derived classes
 134 //////////
 135
 136 // public
 137
 138 /** Output to stream formatted to be useful as ginsh input. */
 139 void basic::print(std::ostream & os, unsigned upper_precedence) const
 140 {
 141     debugmsg("basic print",LOGLEVEL_PRINT);
 142     os << "[basic object]";
 143 }
 144
 145 /** Output to stream in ugly raw format, so brave developers can have a look
 146  * at the underlying structure. */
 147 void basic::printraw(std::ostream & os) const
 148 {
 149     debugmsg("basic printraw",LOGLEVEL_PRINT);
 150     os << "[basic object]";
 151 }
 152
 153 /** Output to stream formatted in tree- (indented-) form, so developers can
 154  *  have a look at the underlying structure. */
 155 void basic::printtree(std::ostream & os, unsigned indent) const
 156 {
 157     debugmsg("basic printtree",LOGLEVEL_PRINT);
 158     os << std::string(indent,' ') << "type=" << typeid(*this).name()
 159        << ", hash=" << hashvalue
 160        << " (0x" << std::hex << hashvalue << std::dec << ")"
 161        << ", flags=" << flags
 162        << ", nops=" << nops() << std::endl;
 163     for (unsigned i=0; i<nops(); ++i) {
 164         op(i).printtree(os,indent+delta_indent);
 165     }
 166 }
 167
 168 /** Output to stream formatted as C-source.
 169  *
 170  *  @param os a stream for output
 171  *  @param type variable type (one of the csrc_types)
 172  *  @param upper_precedence operator precedence of caller
 173  *  @see ex::printcsrc */
 174 void basic::printcsrc(std::ostream & os, unsigned type, unsigned upper_precedence) const
 175 {
 176     debugmsg("basic print csrc", LOGLEVEL_PRINT);
 177 }
 178
 179 /** Little wrapper arount print to be called within a debugger. */
 180 void basic::dbgprint(void) const
 181 {
 182     print(std::cerr);
 183     std::cerr << std::endl;
 184 }
 185
 186 /** Little wrapper arount printtree to be called within a debugger. */
 187 void basic::dbgprinttree(void) const
 188 {
 189     printtree(std::cerr,0);
 190 }
 191
 192 basic * basic::duplicate() const
 193 {
 194     debugmsg("basic duplicate",LOGLEVEL_DUPLICATE);
 195     return new basic(*this);
 196 }
 197
 198 /** Information about the object.
 199  *
 200  *  @see class info_flags */
 201 bool basic::info(unsigned inf) const
 202 {
 203     return false; // all possible properties are false for basic objects
 204 }
 205
 206 /** Number of operands/members. */
 207 unsigned basic::nops() const
 208 {
 209     // iterating from 0 to nops() on atomic objects should be an empty loop,
 210     // and accessing their elements is a range error.  Container objects should
 211     // override this.
 212     return 0;
 213 }
 214
 215 /** Return operand/member at position i. */
 216 ex basic::op(int i) const
 217 {
 218     return (const_cast<basic *>(this))->let_op(i);
 219 }
 220
 221 /** Return modifyable operand/member at position i. */
 222 ex & basic::let_op(int i)
 223 {
 224     throw(std::out_of_range("op() out of range"));
 225 }
 226
 227 ex basic::operator[](const ex & index) const
 228 {
 229     if (is_exactly_of_type(*index.bp,numeric))
 230         return op(static_cast<const numeric &>(*index.bp).to_int());
 231
 232     throw(std::invalid_argument("non-numeric indices not supported by this type"));
 233 }
 234
 235 ex basic::operator[](int i) const
 236 {
 237     return op(i);
 238 }
 239
 240 /** Search ocurrences.  An object  'has' an expression if it is the expression
 241  *  itself or one of the children 'has' it. */
 242 bool basic::has(const ex & other) const
 243 {
 244     GINAC_ASSERT(other.bp!=0);
 245     if (is_equal(*other.bp)) return true;
 246     if (nops()>0) {
 247         for (unsigned i=0; i<nops(); i++) {
 248             if (op(i).has(other)) return true;
 249         }
 250     }
 251     return false;
 252 }
 253
 254 /** Return degree of highest power in symbol s. */
 255 int basic::degree(const symbol & s) const
 256 {
 257     return 0;
 258 }
 259
 260 /** Return degree of lowest power in symbol s. */
 261 int basic::ldegree(const symbol & s) const
 262 {
 263     return 0;
 264 }
 265
 266 /** Return coefficient of degree n in symbol s. */
 267 ex basic::coeff(const symbol & s, int n) const
 268 {
 269     return n==0 ? *this : _ex0();
 270 }
 271
 272 /** Sort expression in terms of powers of some symbol.
 273  *  @param s symbol to sort in. */
 274 ex basic::collect(const symbol & s) const
 275 {
 276     ex x;
 277     int ldeg = this->ldegree(s);
 278     int deg = this->degree(s);
 279     for (int n=ldeg; n<=deg; n++) {
 280         x += this->coeff(s,n)*power(s,n);
 281     }
 282     return x;
 283 }
 284
 285 /* Perform automatic symbolic evaluations on expression. */
 286 ex basic::eval(int level) const
 287 {
 288     // There is nothing to do for basic objects:
 289     return this->hold();
 290 }
 291
 292 /** Evaluate object numerically. */
 293 ex basic::evalf(int level) const
 294 {
 295     // There is nothing to do for basic objects:
 296     return *this;
 297 }
 298
 299 /* Substitute a set of symbols. */
 300 ex basic::subs(const lst & ls, const lst & lr) const
 301 {
 302     return *this;
 303 }
 304
 305 /** Default interface of nth derivative ex::diff(s, n).  It should be called
 306  *  instead of ::derivative(s) for first derivatives and for nth derivatives it
 307  *  just recurses down.
 308  *
 309  *  @param s symbol to differentiate in
 310  *  @param nth order of differentiation
 311  *  @see ex::diff */
 312 ex basic::diff(const symbol & s, unsigned nth) const
 313 {
 314     // trivial: zeroth derivative
 315     if (nth==0)
 316         return ex(*this);
 317
 318     // evaluate unevaluated *this before differentiating
 319     if (!(flags & status_flags::evaluated))
 320         return ex(*this).diff(s, nth);
 321
 322     ex ndiff = this->derivative(s);
 323     while (!ndiff.is_zero() &&    // stop differentiating zeros
 324            nth>1) {
 325         ndiff = ndiff.diff(s);
 326         --nth;
 327     }
 328     return ndiff;
 329 }
 330
 331 exvector basic::get_indices(void) const
 332 {
 333     return exvector(); // return an empty exvector
 334 }
 335
 336 ex basic::simplify_ncmul(const exvector & v) const
 337 {
 338     return simplified_ncmul(v);
 339 }
 340
 341 // protected
 342
 343 /** Default implementation of ex::diff(). It simply throws an error message.
 344  *
 345  *  @exception logic_error (differentiation not supported by this type)
 346  *  @see ex::diff */
 347 ex basic::derivative(const symbol & s) const
 348 {
 349     throw(std::logic_error("differentiation not supported by this type"));
 350 }
 351
 352 /** Returns order relation between two objects of same type.  Needs to be
 353  *  implemented by each class. */
 354 int basic::compare_same_type(const basic & other) const
 355 {
 356     return compare_pointers(this, &other);
 357 }
 358
 359 /** Returns true if two objects of same type are equal.  Normally needs
 360  *  not be reimplemented as long as it wasn't overwritten by some parent
 361  *  class, since it just calls complare_same_type(). */
 362 bool basic::is_equal_same_type(const basic & other) const
 363 {
 364     return compare_same_type(other)==0;
 365 }
 366
 367 unsigned basic::return_type(void) const
 368 {
 369     return return_types::commutative;
 370 }
 371
 372 unsigned basic::return_type_tinfo(void) const
 373 {
 374     return tinfo();
 375 }
 376
 377 unsigned basic::calchash(void) const
 378 {
 379     unsigned v=golden_ratio_hash(tinfo());
 380     for (unsigned i=0; i<nops(); i++) {
 381         v=rotate_left_31(v);
 382         v ^= (const_cast<basic *>(this))->op(i).gethash();
 383     }
 384
 385     v = v & 0x7FFFFFFFU;
 386
 387     // store calculated hash value only if object is already evaluated
 388     if (flags & status_flags::evaluated) {
 389         setflag(status_flags::hash_calculated);
 390         hashvalue=v;
 391     }
 392
 393     return v;
 394 }
 395
 396 /** Expand expression, i.e. multiply it out and return the result as a new
 397  *  expression. */
 398 ex basic::expand(unsigned options) const
 399 {
 400     return this->setflag(status_flags::expanded);
 401 }
 402
 403
 404 //////////
 405 // non-virtual functions in this class
 406 //////////
 407
 408 // public
 409
 410 /** Substitute symbols in expression and return the result as a new expression.
 411  *  There are two valid types of replacement arguments: 1) a relational like
 412  *  symbol==ex and 2) a list of relationals lst(symbol1==ex1,symbol2==ex2,...),
 413  *  which is converted to subs(lst(symbol1,symbol2,...),lst(ex1,ex2,...)).
 414  *  In addition, an object of class idx can be used instead of a symbol. */
 415 ex basic::subs(const ex & e) const
 416 {
 417     if (e.info(info_flags::relation_equal)) {
 418         return subs(lst(e));
 419     }
 420     if (!e.info(info_flags::list)) {
 421         throw(std::invalid_argument("basic::subs(ex): argument must be a list"));
 422     }
 423     lst ls;
 424     lst lr;
 425     for (unsigned i=0; i<e.nops(); i++) {
 426         if (!e.op(i).info(info_flags::relation_equal)) {
 427             throw(std::invalid_argument("basic::subs(ex): argument must be a list or equations"));
 428         }
 429         if (!e.op(i).op(0).info(info_flags::symbol)) {
 430             if (!e.op(i).op(0).info(info_flags::idx)) {
 431                 throw(std::invalid_argument("basic::subs(ex): lhs must be a symbol or an idx"));
 432             }
 433         }
 434         ls.append(e.op(i).op(0));
 435         lr.append(e.op(i).op(1));
 436     }
 437     return subs(ls,lr);
 438 }
 439
 440 /** Compare objects to establish canonical order.
 441  *  All compare functions return: -1 for *this less than other, 0 equal,
 442  *  1 greater. */
 443 int basic::compare(const basic & other) const
 444 {
 445     unsigned hash_this = gethash();
 446     unsigned hash_other = other.gethash();
 447
 448     if (hash_this<hash_other) return -1;
 449     if (hash_this>hash_other) return 1;
 450
 451     unsigned typeid_this = tinfo();
 452     unsigned typeid_other = other.tinfo();
 453
 454     if (typeid_this<typeid_other) {
 455         /*
 456         cout << "hash collision, different types: "
 457              << *this << " and " << other << endl;
 458         this->printraw(cout);
 459         cout << " and ";
 460         other.printraw(cout);
 461         cout << endl;
 462         */
 463         return -1;
 464     }
 465     if (typeid_this>typeid_other) {
 466         /*
 467         cout << "hash collision, different types: "
 468              << *this << " and " << other << endl;
 469         this->printraw(cout);
 470         cout << " and ";
 471         other.printraw(cout);
 472         cout << endl;
 473         */
 474         return 1;
 475     }
 476
 477     GINAC_ASSERT(typeid(*this)==typeid(other));
 478
 479     int cmpval=compare_same_type(other);
 480     if ((cmpval!=0)&&(hash_this<0x80000000U)) {
 481         /*
 482         cout << "hash collision, same type: "
 483              << *this << " and " << other << endl;
 484         this->printraw(cout);
 485         cout << " and ";
 486         other.printraw(cout);
 487         cout << endl;
 488         */
 489     }
 490     return cmpval;
 491 }
 492
 493 /** Test for equality. */
 494 bool basic::is_equal(const basic & other) const
 495 {
 496     unsigned hash_this = gethash();
 497     unsigned hash_other = other.gethash();
 498
 499     if (hash_this!=hash_other) return false;
 500
 501     unsigned typeid_this = tinfo();
 502     unsigned typeid_other = other.tinfo();
 503
 504     if (typeid_this!=typeid_other) return false;
 505
 506     GINAC_ASSERT(typeid(*this)==typeid(other));
 507
 508     return is_equal_same_type(other);
 509 }
 510
 511 // protected
 512
 513 /** Stop further evaluation.
 514  *  @see basic::eval */
 515 const basic & basic::hold(void) const
 516 {
 517     return setflag(status_flags::evaluated);
 518 }
 519
 520 void basic::ensure_if_modifiable(void) const
 521 {
 522     if (refcount>1) {
 523         throw(std::runtime_error("cannot modify multiply referenced object"));
 524     }
 525 }
 526
 527 //////////
 528 // static member variables
 529 //////////
 530
 531 // protected
 532
 533 unsigned basic::precedence = 70;
 534 unsigned basic::delta_indent = 4;
 535
 536 //////////
 537 // global constants
 538 //////////
 539
 540 const basic some_basic;
 541 const type_info & typeid_basic=typeid(some_basic);
 542
 543 //////////
 544 // global variables
 545 //////////
 546
 547 int max_recursion_level=1024;
 548
 549 #ifndef NO_NAMESPACE_GINAC
 550 } // namespace GiNaC
 551 #endif // ndef NO_NAMESPACE_GINAC