ginac/basic.cpp

   1 /** @file basic.cpp
   2  *
   3  *  Implementation of GiNaC's ABC. */
   4
   5 /*
   6  *  GiNaC Copyright (C) 1999-2001 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 <stdexcept>
  25 #ifdef DO_GINAC_ASSERT
  26 #  include <typeinfo>
  27 #endif
  28
  29 #include "basic.h"
  30 #include "ex.h"
  31 #include "numeric.h"
  32 #include "power.h"
  33 #include "symbol.h"
  34 #include "lst.h"
  35 #include "ncmul.h"
  36 #include "relational.h"
  37 #include "print.h"
  38 #include "archive.h"
  39 #include "utils.h"
  40 #include "debugmsg.h"
  41
  42 namespace GiNaC {
  43
  44 GINAC_IMPLEMENT_REGISTERED_CLASS_NO_CTORS(basic, void)
  45
  46 //////////
  47 // default ctor, dtor, copy ctor assignment operator and helpers
  48 //////////
  49
  50 // public
  51
  52 basic::basic(const basic & other) : tinfo_key(TINFO_basic), flags(0), refcount(0)
  53 {
  54         debugmsg("basic copy ctor", LOGLEVEL_CONSTRUCT);
  55         copy(other);
  56 }
  57
  58 const basic & basic::operator=(const basic & other)
  59 {
  60         debugmsg("basic operator=", LOGLEVEL_ASSIGNMENT);
  61         if (this != &other) {
  62                 destroy(true);
  63                 copy(other);
  64         }
  65         return *this;
  66 }
  67
  68 // protected
  69
  70 // none (all conditionally inlined)
  71
  72 //////////
  73 // other ctors
  74 //////////
  75
  76 // none (all conditionally inlined)
  77
  78 //////////
  79 // archiving
  80 //////////
  81
  82 /** Construct object from archive_node. */
  83 basic::basic(const archive_node &n, const lst &sym_lst) : flags(0), refcount(0)
  84 {
  85         debugmsg("basic ctor from archive_node", LOGLEVEL_CONSTRUCT);
  86
  87         // Reconstruct tinfo_key from class name
  88         std::string class_name;
  89         if (n.find_string("class", class_name))
  90                 tinfo_key = find_tinfo_key(class_name);
  91         else
  92                 throw (std::runtime_error("archive node contains no class name"));
  93 }
  94
  95 /** Unarchive the object. */
  96 DEFAULT_UNARCHIVE(basic)
  97
  98 /** Archive the object. */
  99 void basic::archive(archive_node &n) const
 100 {
 101         n.add_string("class", class_name());
 102 }
 103
 104 //////////
 105 // functions overriding virtual functions from bases classes
 106 //////////
 107
 108 // none
 109
 110 //////////
 111 // new virtual functions which can be overridden by derived classes
 112 //////////
 113
 114 // public
 115
 116 /** Output to stream.
 117  *  @param c print context object that describes the output formatting
 118  *  @param level value that is used to identify the precedence or indentation
 119  *               level for placing parentheses and formatting */
 120 void basic::print(const print_context & c, unsigned level) const
 121 {
 122         debugmsg("basic print", LOGLEVEL_PRINT);
 123
 124         if (is_of_type(c, print_tree)) {
 125
 126                 c.s << std::string(level, ' ') << class_name()
 127                     << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
 128                     << ", nops=" << nops()
 129                     << std::endl;
 130                 for (unsigned i=0; i<nops(); ++i)
 131                         op(i).print(c, level + static_cast<const print_tree &>(c).delta_indent);
 132
 133         } else
 134                 c.s << "[" << class_name() << " object]";
 135 }
 136
 137 /** Little wrapper around print to be called within a debugger.
 138  *  This is needed because you cannot call foo.print(cout) from within the
 139  *  debugger because it might not know what cout is.  This method can be
 140  *  invoked with no argument and it will simply print to stdout.
 141  *
 142  *  @see basic::print */
 143 void basic::dbgprint(void) const
 144 {
 145         this->print(std::cerr);
 146         std::cerr << std::endl;
 147 }
 148
 149 /** Little wrapper around printtree to be called within a debugger.
 150  *
 151  *  @see basic::dbgprint
 152  *  @see basic::printtree */
 153 void basic::dbgprinttree(void) const
 154 {
 155         this->print(print_tree(std::cerr));
 156 }
 157
 158 /** Return relative operator precedence (for parenthizing output). */
 159 unsigned basic::precedence(void) const
 160 {
 161         return 70;
 162 }
 163
 164 /** Create a new copy of this on the heap.  One can think of this as simulating
 165  *  a virtual copy constructor which is needed for instance by the refcounted
 166  *  construction of an ex from a basic. */
 167 basic * basic::duplicate() const
 168 {
 169         debugmsg("basic duplicate",LOGLEVEL_DUPLICATE);
 170         return new basic(*this);
 171 }
 172
 173 /** Information about the object.
 174  *
 175  *  @see class info_flags */
 176 bool basic::info(unsigned inf) const
 177 {
 178         // all possible properties are false for basic objects
 179         return false;
 180 }
 181
 182 /** Number of operands/members. */
 183 unsigned basic::nops() const
 184 {
 185         // iterating from 0 to nops() on atomic objects should be an empty loop,
 186         // and accessing their elements is a range error.  Container objects should
 187         // override this.
 188         return 0;
 189 }
 190
 191 /** Return operand/member at position i. */
 192 ex basic::op(int i) const
 193 {
 194         return (const_cast<basic *>(this))->let_op(i);
 195 }
 196
 197 /** Return modifyable operand/member at position i. */
 198 ex & basic::let_op(int i)
 199 {
 200         throw(std::out_of_range("op() out of range"));
 201 }
 202
 203 ex basic::operator[](const ex & index) const
 204 {
 205         if (is_exactly_of_type(*index.bp,numeric))
 206                 return op(static_cast<const numeric &>(*index.bp).to_int());
 207
 208         throw(std::invalid_argument("non-numeric indices not supported by this type"));
 209 }
 210
 211 ex basic::operator[](int i) const
 212 {
 213         return op(i);
 214 }
 215
 216 /** Search ocurrences.  An object 'has' an expression if it is the expression
 217  *  itself or one of the children 'has' it.  As a consequence (according to
 218  *  the definition of children) given e=x+y+z, e.has(x) is true but e.has(x+y)
 219  *  is false.  The expression can also contain wildcards. */
 220 bool basic::has(const ex & other) const
 221 {
 222         GINAC_ASSERT(other.bp!=0);
 223         lst repl_lst;
 224         if (match(*other.bp, repl_lst))
 225                 return true;
 226         for (unsigned i=0; i<nops(); i++)
 227                 if (op(i).has(other))
 228                         return true;
 229
 230         return false;
 231 }
 232
 233 /** Construct new expression by applying the specified function to all
 234  *  sub-expressions (one level only, not recursively). */
 235 ex basic::map(map_func f) const
 236 {
 237         unsigned num = nops();
 238         if (num == 0)
 239                 return *this;
 240
 241         basic *copy = duplicate();
 242         copy->setflag(status_flags::dynallocated);
 243         copy->clearflag(status_flags::hash_calculated);
 244         ex e(*copy);
 245         for (unsigned i=0; i<num; i++)
 246                 e.let_op(i) = f(e.op(i));
 247         return e.eval();
 248 }
 249
 250 /** Return degree of highest power in object s. */
 251 int basic::degree(const ex & s) const
 252 {
 253         return 0;
 254 }
 255
 256 /** Return degree of lowest power in object s. */
 257 int basic::ldegree(const ex & s) const
 258 {
 259         return 0;
 260 }
 261
 262 /** Return coefficient of degree n in object s. */
 263 ex basic::coeff(const ex & s, int n) const
 264 {
 265         return n==0 ? *this : _ex0();
 266 }
 267
 268 /** Sort expanded expression in terms of powers of some object(s).
 269  *  @param s object(s) to sort in
 270  *  @param distributed recursive or distributed form (only used when s is a list) */
 271 ex basic::collect(const ex & s, bool distributed) const
 272 {
 273         ex x;
 274         if (is_ex_of_type(s, lst)) {
 275
 276                 // List of objects specified
 277                 if (s.nops() == 1)
 278                         return collect(s.op(0));
 279
 280                 else if (distributed) {
 281
 282                         // Get lower/upper degree of all symbols in list
 283                         int num = s.nops();
 284                         struct sym_info {
 285                                 ex sym;
 286                                 int ldeg, deg;
 287                                 int cnt;  // current degree, 'counter'
 288                                 ex coeff; // coefficient for degree 'cnt'
 289                         };
 290                         sym_info *si = new sym_info[num];
 291                         ex c = *this;
 292                         for (int i=0; i<num; i++) {
 293                                 si[i].sym = s.op(i);
 294                                 si[i].ldeg = si[i].cnt = this->ldegree(si[i].sym);
 295                                 si[i].deg = this->degree(si[i].sym);
 296                                 c = si[i].coeff = c.coeff(si[i].sym, si[i].cnt);
 297                         }
 298
 299                         while (true) {
 300
 301                                 // Calculate coeff*x1^c1*...*xn^cn
 302                                 ex y = _ex1();
 303                                 for (int i=0; i<num; i++) {
 304                                         int cnt = si[i].cnt;
 305                                         y *= power(si[i].sym, cnt);
 306                                 }
 307                                 x += y * si[num - 1].coeff;
 308
 309                                 // Increment counters
 310                                 int n = num - 1;
 311                                 while (true) {
 312                                         si[n].cnt++;
 313                                         if (si[n].cnt <= si[n].deg) {
 314                                                 // Update coefficients
 315                                                 ex c;
 316                                                 if (n == 0)
 317                                                         c = *this;
 318                                                 else
 319                                                         c = si[n - 1].coeff;
 320                                                 for (int i=n; i<num; i++)
 321                                                         c = si[i].coeff = c.coeff(si[i].sym, si[i].cnt);
 322                                                 break;
 323                                         }
 324                                         if (n == 0)
 325                                                 goto done;
 326                                         si[n].cnt = si[n].ldeg;
 327                                         n--;
 328                                 }
 329                         }
 330
 331 done:           delete[] si;
 332
 333                 } else {
 334
 335                         // Recursive form
 336                         x = *this;
 337                         for (int n=s.nops()-1; n>=0; n--)
 338                                 x = x.collect(s[n]);
 339                 }
 340
 341         } else {
 342
 343                 // Only one object specified
 344                 for (int n=this->ldegree(s); n<=this->degree(s); ++n)
 345                         x += this->coeff(s,n)*power(s,n);
 346         }
 347
 348         // correct for lost fractional arguments and return
 349         return x + (*this - x).expand();
 350 }
 351
 352 /** Perform automatic non-interruptive symbolic evaluation on expression. */
 353 ex basic::eval(int level) const
 354 {
 355         // There is nothing to do for basic objects:
 356         return this->hold();
 357 }
 358
 359 /** Evaluate object numerically. */
 360 ex basic::evalf(int level) const
 361 {
 362         // There is nothing to do for basic objects:
 363         return *this;
 364 }
 365
 366 /** Evaluate sums and products of matrices. */
 367 ex basic::evalm(void) const
 368 {
 369         if (nops() == 0)
 370                 return *this;
 371         else
 372                 return map(GiNaC::evalm);
 373 }
 374
 375 /** Perform automatic symbolic evaluations on indexed expression that
 376  *  contains this object as the base expression. */
 377 ex basic::eval_indexed(const basic & i) const
 378  // this function can't take a "const ex & i" because that would result
 379  // in an infinite eval() loop
 380 {
 381         // There is nothing to do for basic objects
 382         return i.hold();
 383 }
 384
 385 /** Add two indexed expressions. They are guaranteed to be of class indexed
 386  *  (or a subclass) and their indices are compatible. This function is used
 387  *  internally by simplify_indexed().
 388  *
 389  *  @param self First indexed expression; it's base object is *this
 390  *  @param other Second indexed expression
 391  *  @return sum of self and other
 392  *  @see ex::simplify_indexed() */
 393 ex basic::add_indexed(const ex & self, const ex & other) const
 394 {
 395         return self + other;
 396 }
 397
 398 /** Multiply an indexed expression with a scalar. This function is used
 399  *  internally by simplify_indexed().
 400  *
 401  *  @param self Indexed expression; it's base object is *this
 402  *  @param other Numeric value
 403  *  @return product of self and other
 404  *  @see ex::simplify_indexed() */
 405 ex basic::scalar_mul_indexed(const ex & self, const numeric & other) const
 406 {
 407         return self * other;
 408 }
 409
 410 /** Try to contract two indexed expressions that appear in the same product.
 411  *  If a contraction exists, the function overwrites one or both of the
 412  *  expressions and returns true. Otherwise it returns false. It is
 413  *  guaranteed that both expressions are of class indexed (or a subclass)
 414  *  and that at least one dummy index has been found. This functions is
 415  *  used internally by simplify_indexed().
 416  *
 417  *  @param self Pointer to first indexed expression; it's base object is *this
 418  *  @param other Pointer to second indexed expression
 419  *  @param v The complete vector of factors
 420  *  @return true if the contraction was successful, false otherwise
 421  *  @see ex::simplify_indexed() */
 422 bool basic::contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const
 423 {
 424         // Do nothing
 425         return false;
 426 }
 427
 428 /** Check whether the expression matches a given pattern. For every wildcard
 429  *  object in the pattern, an expression of the form "wildcard == matching_expression"
 430  *  is added to repl_lst. */
 431 bool basic::match(const ex & pattern, lst & repl_lst) const
 432 {
 433 /*
 434         Sweet sweet shapes, sweet sweet shapes,
 435         That's the key thing, right right.
 436         Feed feed face, feed feed shapes,
 437         But who is the king tonight?
 438         Who is the king tonight?
 439         Pattern is the thing, the key thing-a-ling,
 440         But who is the king of pattern?
 441         But who is the king, the king thing-a-ling,
 442         Who is the king of Pattern?
 443         Bog is the king, the king thing-a-ling,
 444         Bog is the king of Pattern.
 445         Ba bu-bu-bu-bu bu-bu-bu-bu-bu-bu bu-bu
 446         Bog is the king of Pattern.
 447 */
 448
 449         if (is_ex_exactly_of_type(pattern, wildcard)) {
 450
 451                 // Wildcard matches anything, but check whether we already have found
 452                 // a match for that wildcard first (if so, it the earlier match must
 453                 // be the same expression)
 454                 for (unsigned i=0; i<repl_lst.nops(); i++) {
 455                         if (repl_lst.op(i).op(0).is_equal(pattern))
 456                                 return is_equal(*repl_lst.op(i).op(1).bp);
 457                 }
 458                 repl_lst.append(pattern == *this);
 459                 return true;
 460
 461         } else {
 462
 463                 // Expression must be of the same type as the pattern
 464                 if (tinfo() != pattern.bp->tinfo())
 465                         return false;
 466
 467                 // Number of subexpressions must match
 468                 if (nops() != pattern.nops())
 469                         return false;
 470
 471                 // No subexpressions? Then just compare the objects (there can't be
 472                 // wildcards in the pattern)
 473                 if (nops() == 0)
 474                         return is_equal(*pattern.bp);
 475
 476                 // Otherwise the subexpressions must match one-to-one
 477                 for (unsigned i=0; i<nops(); i++)
 478                         if (!op(i).match(pattern.op(i), repl_lst))
 479                                 return false;
 480
 481                 // Looks similar enough, match found
 482                 return true;
 483         }
 484 }
 485
 486 /** Substitute a set of objects by arbitrary expressions. The ex returned
 487  *  will already be evaluated. */
 488 ex basic::subs(const lst & ls, const lst & lr, bool no_pattern) const
 489 {
 490         GINAC_ASSERT(ls.nops() == lr.nops());
 491
 492         if (no_pattern) {
 493                 for (unsigned i=0; i<ls.nops(); i++) {
 494                         if (is_equal(*ls.op(i).bp))
 495                                 return lr.op(i);
 496                 }
 497         } else {
 498                 for (unsigned i=0; i<ls.nops(); i++) {
 499                         lst repl_lst;
 500                         if (match(*ls.op(i).bp, repl_lst))
 501                                 return lr.op(i).bp->subs(repl_lst, true); // avoid infinite recursion when re-substituting the wildcards
 502                 }
 503         }
 504
 505         return *this;
 506 }
 507
 508 /** Default interface of nth derivative ex::diff(s, n).  It should be called
 509  *  instead of ::derivative(s) for first derivatives and for nth derivatives it
 510  *  just recurses down.
 511  *
 512  *  @param s symbol to differentiate in
 513  *  @param nth order of differentiation
 514  *  @see ex::diff */
 515 ex basic::diff(const symbol & s, unsigned nth) const
 516 {
 517         // trivial: zeroth derivative
 518         if (nth==0)
 519                 return ex(*this);
 520
 521         // evaluate unevaluated *this before differentiating
 522         if (!(flags & status_flags::evaluated))
 523                 return ex(*this).diff(s, nth);
 524
 525         ex ndiff = this->derivative(s);
 526         while (!ndiff.is_zero() &&    // stop differentiating zeros
 527                nth>1) {
 528                 ndiff = ndiff.diff(s);
 529                 --nth;
 530         }
 531         return ndiff;
 532 }
 533
 534 /** Return a vector containing the free indices of an expression. */
 535 exvector basic::get_free_indices(void) const
 536 {
 537         return exvector(); // return an empty exvector
 538 }
 539
 540 ex basic::simplify_ncmul(const exvector & v) const
 541 {
 542         return simplified_ncmul(v);
 543 }
 544
 545 // protected
 546
 547 /** Default implementation of ex::diff(). It simply throws an error message.
 548  *
 549  *  @exception logic_error (differentiation not supported by this type)
 550  *  @see ex::diff */
 551 ex basic::derivative(const symbol & s) const
 552 {
 553         throw(std::logic_error("differentiation not supported by this type"));
 554 }
 555
 556 /** Returns order relation between two objects of same type.  This needs to be
 557  *  implemented by each class. It may never return anything else than 0,
 558  *  signalling equality, or +1 and -1 signalling inequality and determining
 559  *  the canonical ordering.  (Perl hackers will wonder why C++ doesn't feature
 560  *  the spaceship operator <=> for denoting just this.) */
 561 int basic::compare_same_type(const basic & other) const
 562 {
 563         return compare_pointers(this, &other);
 564 }
 565
 566 /** Returns true if two objects of same type are equal.  Normally needs
 567  *  not be reimplemented as long as it wasn't overwritten by some parent
 568  *  class, since it just calls compare_same_type().  The reason why this
 569  *  function exists is that sometimes it is easier to determine equality
 570  *  than an order relation and then it can be overridden. */
 571 bool basic::is_equal_same_type(const basic & other) const
 572 {
 573         return this->compare_same_type(other)==0;
 574 }
 575
 576 unsigned basic::return_type(void) const
 577 {
 578         return return_types::commutative;
 579 }
 580
 581 unsigned basic::return_type_tinfo(void) const
 582 {
 583         return tinfo();
 584 }
 585
 586 /** Compute the hash value of an object and if it makes sense to store it in
 587  *  the objects status_flags, do so.  The method inherited from class basic
 588  *  computes a hash value based on the type and hash values of possible
 589  *  members.  For this reason it is well suited for container classes but
 590  *  atomic classes should override this implementation because otherwise they
 591  *  would all end up with the same hashvalue. */
 592 unsigned basic::calchash(void) const
 593 {
 594         unsigned v = golden_ratio_hash(tinfo());
 595         for (unsigned i=0; i<nops(); i++) {
 596                 v = rotate_left_31(v);
 597                 v ^= (const_cast<basic *>(this))->op(i).gethash();
 598         }
 599
 600         // mask out numeric hashes:
 601         v &= 0x7FFFFFFFU;
 602
 603         // store calculated hash value only if object is already evaluated
 604         if (flags & status_flags::evaluated) {
 605                 setflag(status_flags::hash_calculated);
 606                 hashvalue = v;
 607         }
 608
 609         return v;
 610 }
 611
 612 /** Expand expression, i.e. multiply it out and return the result as a new
 613  *  expression. */
 614 ex basic::expand(unsigned options) const
 615 {
 616         return this->setflag(status_flags::expanded);
 617 }
 618
 619
 620 //////////
 621 // non-virtual functions in this class
 622 //////////
 623
 624 // public
 625
 626 /** Substitute objects in an expression (syntactic substitution) and return
 627  *  the result as a new expression.  There are two valid types of
 628  *  replacement arguments: 1) a relational like object==ex and 2) a list of
 629  *  relationals lst(object1==ex1,object2==ex2,...), which is converted to
 630  *  subs(lst(object1,object2,...),lst(ex1,ex2,...)). */
 631 ex basic::subs(const ex & e, bool no_pattern) const
 632 {
 633         if (e.info(info_flags::relation_equal)) {
 634                 return subs(lst(e), no_pattern);
 635         }
 636         if (!e.info(info_flags::list)) {
 637                 throw(std::invalid_argument("basic::subs(ex): argument must be a list"));
 638         }
 639         lst ls;
 640         lst lr;
 641         for (unsigned i=0; i<e.nops(); i++) {
 642                 ex r = e.op(i);
 643                 if (!r.info(info_flags::relation_equal)) {
 644                         throw(std::invalid_argument("basic::subs(ex): argument must be a list of equations"));
 645                 }
 646                 ls.append(r.op(0));
 647                 lr.append(r.op(1));
 648         }
 649         return subs(ls, lr, no_pattern);
 650 }
 651
 652 /** Compare objects to establish canonical ordering.
 653  *  All compare functions return: -1 for *this less than other, 0 equal,
 654  *  1 greater. */
 655 int basic::compare(const basic & other) const
 656 {
 657         unsigned hash_this = gethash();
 658         unsigned hash_other = other.gethash();
 659
 660         if (hash_this<hash_other) return -1;
 661         if (hash_this>hash_other) return 1;
 662
 663         unsigned typeid_this = tinfo();
 664         unsigned typeid_other = other.tinfo();
 665
 666         if (typeid_this<typeid_other) {
 667 //              std::cout << "hash collision, different types: "
 668 //                        << *this << " and " << other << std::endl;
 669 //              this->print(print_tree(std::cout));
 670 //              std::cout << " and ";
 671 //              other.print(print_tree(std::cout));
 672 //              std::cout << std::endl;
 673                 return -1;
 674         }
 675         if (typeid_this>typeid_other) {
 676 //              std::cout << "hash collision, different types: "
 677 //                        << *this << " and " << other << std::endl;
 678 //              this->print(print_tree(std::cout));
 679 //              std::cout << " and ";
 680 //              other.print(print_tree(std::cout));
 681 //              std::cout << std::endl;
 682                 return 1;
 683         }
 684
 685         GINAC_ASSERT(typeid(*this)==typeid(other));
 686
 687 //      int cmpval = compare_same_type(other);
 688 //      if ((cmpval!=0) && (hash_this<0x80000000U)) {
 689 //              std::cout << "hash collision, same type: "
 690 //                        << *this << " and " << other << std::endl;
 691 //              this->print(print_tree(std::cout));
 692 //              std::cout << " and ";
 693 //              other.print(print_tree(std::cout));
 694 //              std::cout << std::endl;
 695 //      }
 696 //      return cmpval;
 697
 698         return compare_same_type(other);
 699 }
 700
 701 /** Test for equality.
 702  *  This is only a quick test, meaning objects should be in the same domain.
 703  *  You might have to .expand(), .normal() objects first, depending on the
 704  *  domain of your computation, to get a more reliable answer.
 705  *
 706  *  @see is_equal_same_type */
 707 bool basic::is_equal(const basic & other) const
 708 {
 709         if (this->gethash()!=other.gethash())
 710                 return false;
 711         if (this->tinfo()!=other.tinfo())
 712                 return false;
 713
 714         GINAC_ASSERT(typeid(*this)==typeid(other));
 715
 716         return this->is_equal_same_type(other);
 717 }
 718
 719 // protected
 720
 721 /** Stop further evaluation.
 722  *
 723  *  @see basic::eval */
 724 const basic & basic::hold(void) const
 725 {
 726         return this->setflag(status_flags::evaluated);
 727 }
 728
 729 /** Ensure the object may be modified without hurting others, throws if this
 730  *  is not the case. */
 731 void basic::ensure_if_modifiable(void) const
 732 {
 733         if (this->refcount>1)
 734                 throw(std::runtime_error("cannot modify multiply referenced object"));
 735 }
 736
 737 //////////
 738 // global variables
 739 //////////
 740
 741 int max_recursion_level = 1024;
 742
 743 } // namespace GiNaC