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_GINAC_NAMESPACE
  39 namespace GiNaC {
  40 #endif // ndef NO_GINAC_NAMESPACE
  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(basic const & 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 basic const & basic::operator=(basic const & 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 #if 0
  84 void basic::copy(basic const & other)
  85 {
  86     flags=other.flags & ~ status_flags::dynallocated;
  87     hashvalue=other.hashvalue;
  88     tinfo_key=other.tinfo_key;
  89 }
  90 #endif
  91
  92 //////////
  93 // other constructors
  94 //////////
  95
  96 #ifndef INLINE_BASIC_CONSTRUCTORS
  97 basic::basic(unsigned ti) : flags(0), refcount(0), tinfo_key(ti)
  98 {
  99     debugmsg("basic constructor with tinfo_key", LOGLEVEL_CONSTRUCT);
 100     // nothing to do
 101 }
 102 #endif
 103
 104 //////////
 105 // archiving
 106 //////////
 107
 108 /** Construct object from archive_node. */
 109 basic::basic(const archive_node &n, const lst &sym_lst) : flags(0), refcount(0)
 110 {
 111     debugmsg("basic constructor from archive_node", LOGLEVEL_CONSTRUCT);
 112
 113     // Reconstruct tinfo_key from class name
 114     string class_name;
 115     if (n.find_string("class", class_name))
 116         tinfo_key = find_tinfo_key(class_name);
 117     else
 118         throw (std::runtime_error("archive node contains no class name"));
 119 }
 120
 121 /** Unarchive the object. */
 122 ex basic::unarchive(const archive_node &n, const lst &sym_lst)
 123 {
 124     return (new basic(n, sym_lst))->setflag(status_flags::dynallocated);
 125 }
 126
 127 /** Archive the object. */
 128 void basic::archive(archive_node &n) const
 129 {
 130     n.add_string("class", class_name());
 131 }
 132
 133 //////////
 134 // functions overriding virtual functions from bases classes
 135 //////////
 136
 137 // none
 138
 139 //////////
 140 // new virtual functions which can be overridden by derived classes
 141 //////////
 142
 143 // public
 144
 145 /** Output to stream formatted to be useful as ginsh input. */
 146 void basic::print(ostream & os, unsigned upper_precedence) const
 147 {
 148     debugmsg("basic print",LOGLEVEL_PRINT);
 149     os << "[basic object]";
 150 }
 151
 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
 155 {
 156     debugmsg("basic printraw",LOGLEVEL_PRINT);
 157     os << "[basic object]";
 158 }
 159
 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
 163 {
 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);
 171     }
 172 }
 173
 174 /** Output to stream formatted as C-source.
 175  *
 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
 181 {
 182     debugmsg("basic print csrc", LOGLEVEL_PRINT);
 183 }
 184
 185 /** Little wrapper arount print to be called within a debugger. */
 186 void basic::dbgprint(void) const
 187 {
 188     print(cerr);
 189     cerr << endl;
 190 }
 191
 192 /** Little wrapper arount printtree to be called within a debugger. */
 193 void basic::dbgprinttree(void) const
 194 {
 195     printtree(cerr,0);
 196 }
 197
 198 basic * basic::duplicate() const
 199 {
 200     debugmsg("basic duplicate",LOGLEVEL_DUPLICATE);
 201     return new basic(*this);
 202 }
 203
 204 bool basic::info(unsigned inf) const
 205 {
 206     return false; // all possible properties are false for basic objects
 207 }
 208
 209 unsigned basic::nops() const
 210 {
 211     return 0;
 212 }
 213
 214 ex basic::op(int const i) const
 215 {
 216     return (const_cast<basic *>(this))->let_op(i);
 217 }
 218
 219 ex & basic::let_op(int const i)
 220 {
 221     throw(std::out_of_range("op() out of range"));
 222 }
 223
 224 ex basic::operator[](ex const & index) const
 225 {
 226     if (is_exactly_of_type(*index.bp,numeric)) {
 227         return op(static_cast<numeric const &>(*index.bp).to_int());
 228     }
 229     throw(std::invalid_argument("non-numeric indices not supported by this type"));
 230 }
 231
 232 ex basic::operator[](int const i) const
 233 {
 234     return op(i);
 235 }
 236
 237 bool basic::has(ex const & other) const
 238 {
 239     GINAC_ASSERT(other.bp!=0);
 240     if (is_equal(*other.bp)) return true;
 241     if (nops()>0) {
 242         for (unsigned i=0; i<nops(); i++) {
 243             if (op(i).has(other)) return true;
 244         }
 245     }
 246     return false;
 247 }
 248
 249 int basic::degree(symbol const & s) const
 250 {
 251     return 0;
 252 }
 253
 254 int basic::ldegree(symbol const & s) const
 255 {
 256     return 0;
 257 }
 258
 259 ex basic::coeff(symbol const & s, int const n) const
 260 {
 261     return n==0 ? *this : _ex0();
 262 }
 263
 264 ex basic::collect(symbol const & s) const
 265 {
 266     ex x;
 267     int ldeg=ldegree(s);
 268     int deg=degree(s);
 269     for (int n=ldeg; n<=deg; n++) {
 270         x += coeff(s,n)*power(s,n);
 271     }
 272     return x;
 273 }
 274
 275 ex basic::eval(int level) const
 276 {
 277     return this->hold();
 278 }
 279
 280 ex basic::evalf(int level) const
 281 {
 282     return *this;
 283 }
 284
 285 ex basic::subs(lst const & ls, lst const & lr) const
 286 {
 287     return *this;
 288 }
 289
 290 exvector basic::get_indices(void) const
 291 {
 292     return exvector(); // return an empty exvector
 293 }
 294
 295 ex basic::simplify_ncmul(exvector const & v) const
 296 {
 297     return simplified_ncmul(v);
 298 }
 299
 300 // protected
 301
 302 int basic::compare_same_type(basic const & other) const
 303 {
 304     return compare_pointers(this, &other);
 305 }
 306
 307 bool basic::is_equal_same_type(basic const & other) const
 308 {
 309     return compare_same_type(other)==0;
 310 }
 311
 312 unsigned basic::return_type(void) const
 313 {
 314     return return_types::commutative;
 315 }
 316
 317 unsigned basic::return_type_tinfo(void) const
 318 {
 319     return tinfo();
 320 }
 321
 322 unsigned basic::calchash(void) const
 323 {
 324     unsigned v=golden_ratio_hash(tinfo());
 325     for (unsigned i=0; i<nops(); i++) {
 326         v=rotate_left_31(v);
 327         v ^= (const_cast<basic *>(this))->op(i).gethash();
 328     }
 329
 330     v = v & 0x7FFFFFFFU;
 331
 332     // store calculated hash value only if object is already evaluated
 333     if (flags & status_flags::evaluated) {
 334         setflag(status_flags::hash_calculated);
 335         hashvalue=v;
 336     }
 337
 338     return v;
 339 }
 340
 341 ex basic::expand(unsigned options) const
 342 {
 343     return this->setflag(status_flags::expanded);
 344 }
 345
 346 //////////
 347 // non-virtual functions in this class
 348 //////////
 349
 350 // public
 351
 352 ex basic::subs(ex const & e) const
 353 {
 354     // accept 2 types of replacement expressions:
 355     //   - symbol==ex
 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)) {
 360         return subs(lst(e));
 361     }
 362     if (!e.info(info_flags::list)) {
 363         throw(std::invalid_argument("basic::subs(ex): argument must be a list"));
 364     }
 365     lst ls;
 366     lst lr;
 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"));
 370         }
 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"));
 374             }
 375         }
 376         ls.append(e.op(i).op(0));
 377         lr.append(e.op(i).op(1));
 378     }
 379     return subs(ls,lr);
 380 }
 381
 382 /** Compare objects to establish canonical order.
 383  *  All compare functions return: -1 for *this less than other, 0 equal,
 384  *  1 greater. */
 385 int basic::compare(basic const & other) const
 386 {
 387     unsigned hash_this = gethash();
 388     unsigned hash_other = other.gethash();
 389
 390     if (hash_this<hash_other) return -1;
 391     if (hash_this>hash_other) return 1;
 392
 393     unsigned typeid_this = tinfo();
 394     unsigned typeid_other = other.tinfo();
 395
 396     if (typeid_this<typeid_other) {
 397         /*
 398         cout << "hash collision, different types: "
 399              << *this << " and " << other << endl;
 400         this->printraw(cout);
 401         cout << " and ";
 402         other.printraw(cout);
 403         cout << endl;
 404         */
 405         return -1;
 406     }
 407     if (typeid_this>typeid_other) {
 408         /*
 409         cout << "hash collision, different types: "
 410              << *this << " and " << other << endl;
 411         this->printraw(cout);
 412         cout << " and ";
 413         other.printraw(cout);
 414         cout << endl;
 415         */
 416         return 1;
 417     }
 418
 419     GINAC_ASSERT(typeid(*this)==typeid(other));
 420
 421     int cmpval=compare_same_type(other);
 422     if ((cmpval!=0)&&(hash_this<0x80000000U)) {
 423         /*
 424         cout << "hash collision, same type: "
 425              << *this << " and " << other << endl;
 426         this->printraw(cout);
 427         cout << " and ";
 428         other.printraw(cout);
 429         cout << endl;
 430         */
 431     }
 432     return cmpval;
 433 }
 434
 435 bool basic::is_equal(basic const & other) const
 436 {
 437     unsigned hash_this = gethash();
 438     unsigned hash_other = other.gethash();
 439
 440     if (hash_this!=hash_other) return false;
 441
 442     unsigned typeid_this = tinfo();
 443     unsigned typeid_other = other.tinfo();
 444
 445     if (typeid_this!=typeid_other) return false;
 446
 447     GINAC_ASSERT(typeid(*this)==typeid(other));
 448
 449     return is_equal_same_type(other);
 450 }
 451
 452 // protected
 453
 454 basic const & basic::hold(void) const
 455 {
 456     return setflag(status_flags::evaluated);
 457 }
 458
 459 void basic::ensure_if_modifiable(void) const
 460 {
 461     if (refcount>1) {
 462         throw(std::runtime_error("cannot modify multiply referenced object"));
 463     }
 464 }
 465
 466 //////////
 467 // static member variables
 468 //////////
 469
 470 // protected
 471
 472 unsigned basic::precedence=70;
 473 unsigned basic::delta_indent=4;
 474
 475 //////////
 476 // global constants
 477 //////////
 478
 479 const basic some_basic;
 480 type_info const & typeid_basic=typeid(some_basic);
 481
 482 //////////
 483 // global variables
 484 //////////
 485
 486 int max_recursion_level=1024;
 487
 488 #ifndef NO_GINAC_NAMESPACE
 489 } // namespace GiNaC
 490 #endif // ndef NO_GINAC_NAMESPACE