ginac/ex.cpp

   1 /** @file ex.cpp
   2  *
   3  *  Implementation of GiNaC's light-weight expression handles. */
   4
   5 /*
   6  *  GiNaC Copyright (C) 1999-2005 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  21  */
  22
  23 #include <iostream>
  24 #include <stdexcept>
  25
  26 #include "ex.h"
  27 #include "add.h"
  28 #include "mul.h"
  29 #include "ncmul.h"
  30 #include "numeric.h"
  31 #include "power.h"
  32 #include "lst.h"
  33 #include "relational.h"
  34 #include "input_lexer.h"
  35 #include "utils.h"
  36
  37 namespace GiNaC {
  38
  39 //////////
  40 // other constructors
  41 //////////
  42
  43 // none (all inlined)
  44
  45 //////////
  46 // non-virtual functions in this class
  47 //////////
  48
  49 // public
  50
  51 /** Print expression to stream. The formatting of the output is determined
  52  *  by the kind of print_context object that is passed. Possible formattings
  53  *  include ginsh-parsable output (the default), tree-like output for
  54  *  debugging, and C++ source.
  55  *  @see print_context */
  56 void ex::print(const print_context & c, unsigned level) const
  57 {
  58         bp->print(c, level);
  59 }
  60
  61 /** Little wrapper arount print to be called within a debugger. */
  62 void ex::dbgprint() const
  63 {
  64         bp->dbgprint();
  65 }
  66
  67 /** Little wrapper arount printtree to be called within a debugger. */
  68 void ex::dbgprinttree() const
  69 {
  70         bp->dbgprinttree();
  71 }
  72
  73 ex ex::expand(unsigned options) const
  74 {
  75         if (options == 0 && (bp->flags & status_flags::expanded)) // The "expanded" flag only covers the standard options; someone might want to re-expand with different options
  76                 return *this;
  77         else
  78                 return bp->expand(options);
  79 }
  80
  81 /** Compute partial derivative of an expression.
  82  *
  83  *  @param s  symbol by which the expression is derived
  84  *  @param nth  order of derivative (default 1)
  85  *  @return partial derivative as a new expression */
  86 ex ex::diff(const symbol & s, unsigned nth) const
  87 {
  88         if (!nth)
  89                 return *this;
  90         else
  91                 return bp->diff(s, nth);
  92 }
  93
  94 /** Check whether expression matches a specified pattern. */
  95 bool ex::match(const ex & pattern) const
  96 {
  97         lst repl_lst;
  98         return bp->match(pattern, repl_lst);
  99 }
 100
 101 /** Find all occurrences of a pattern. The found matches are appended to
 102  *  the "found" list. If the expression itself matches the pattern, the
 103  *  children are not further examined. This function returns true when any
 104  *  matches were found. */
 105 bool ex::find(const ex & pattern, lst & found) const
 106 {
 107         if (match(pattern)) {
 108                 found.append(*this);
 109                 found.sort();
 110                 found.unique();
 111                 return true;
 112         }
 113         bool any_found = false;
 114         for (size_t i=0; i<nops(); i++)
 115                 if (op(i).find(pattern, found))
 116                         any_found = true;
 117         return any_found;
 118 }
 119
 120 /** Substitute objects in an expression (syntactic substitution) and return
 121  *  the result as a new expression. */
 122 ex ex::subs(const lst & ls, const lst & lr, unsigned options) const
 123 {
 124         GINAC_ASSERT(ls.nops() == lr.nops());
 125
 126         // Convert the lists to a map
 127         exmap m;
 128         for (lst::const_iterator its = ls.begin(), itr = lr.begin(); its != ls.end(); ++its, ++itr) {
 129                 m.insert(std::make_pair(*its, *itr));
 130
 131                 // Search for products and powers in the expressions to be substituted
 132                 // (for an optimization in expairseq::subs())
 133                 if (is_exactly_a<mul>(*its) || is_exactly_a<power>(*its))
 134                         options |= subs_options::pattern_is_product;
 135         }
 136         if (!(options & subs_options::pattern_is_product))
 137                 options |= subs_options::pattern_is_not_product;
 138
 139         return bp->subs(m, options);
 140 }
 141
 142 /** Substitute objects in an expression (syntactic substitution) and return
 143  *  the result as a new expression.  There are two valid types of
 144  *  replacement arguments: 1) a relational like object==ex and 2) a list of
 145  *  relationals lst(object1==ex1,object2==ex2,...). */
 146 ex ex::subs(const ex & e, unsigned options) const
 147 {
 148         if (e.info(info_flags::relation_equal)) {
 149
 150                 // Argument is a relation: convert it to a map
 151                 exmap m;
 152                 const ex & s = e.op(0);
 153                 m.insert(std::make_pair(s, e.op(1)));
 154
 155                 if (is_exactly_a<mul>(s) || is_exactly_a<power>(s))
 156                         options |= subs_options::pattern_is_product;
 157                 else
 158                         options |= subs_options::pattern_is_not_product;
 159
 160                 return bp->subs(m, options);
 161
 162         } else if (e.info(info_flags::list)) {
 163
 164                 // Argument is a list: convert it to a map
 165                 exmap m;
 166                 GINAC_ASSERT(is_a<lst>(e));
 167                 for (lst::const_iterator it = ex_to<lst>(e).begin(); it != ex_to<lst>(e).end(); ++it) {
 168                         ex r = *it;
 169                         if (!r.info(info_flags::relation_equal))
 170                                 throw(std::invalid_argument("basic::subs(ex): argument must be a list of equations"));
 171                         const ex & s = r.op(0);
 172                         m.insert(std::make_pair(s, r.op(1)));
 173
 174                         // Search for products and powers in the expressions to be substituted
 175                         // (for an optimization in expairseq::subs())
 176                         if (is_exactly_a<mul>(s) || is_exactly_a<power>(s))
 177                                 options |= subs_options::pattern_is_product;
 178                 }
 179                 if (!(options & subs_options::pattern_is_product))
 180                         options |= subs_options::pattern_is_not_product;
 181
 182                 return bp->subs(m, options);
 183
 184         } else
 185                 throw(std::invalid_argument("ex::subs(ex): argument must be a relation_equal or a list"));
 186 }
 187
 188 /** Traverse expression tree with given visitor, preorder traversal. */
 189 void ex::traverse_preorder(visitor & v) const
 190 {
 191         accept(v);
 192
 193         size_t n = nops();
 194         for (size_t i = 0; i < n; ++i)
 195                 op(i).traverse_preorder(v);
 196 }
 197
 198 /** Traverse expression tree with given visitor, postorder traversal. */
 199 void ex::traverse_postorder(visitor & v) const
 200 {
 201         size_t n = nops();
 202         for (size_t i = 0; i < n; ++i)
 203                 op(i).traverse_postorder(v);
 204
 205         accept(v);
 206 }
 207
 208 /** Return modifyable operand/member at position i. */
 209 ex & ex::let_op(size_t i)
 210 {
 211         makewriteable();
 212         return bp->let_op(i);
 213 }
 214
 215 ex & ex::operator[](const ex & index)
 216 {
 217         makewriteable();
 218         return (*bp)[index];
 219 }
 220
 221 ex & ex::operator[](size_t i)
 222 {
 223         makewriteable();
 224         return (*bp)[i];
 225 }
 226
 227 /** Left hand side of relational expression. */
 228 ex ex::lhs() const
 229 {
 230         if (!is_a<relational>(*this))
 231                 throw std::runtime_error("ex::lhs(): not a relation");
 232         return bp->op(0);
 233 }
 234
 235 /** Right hand side of relational expression. */
 236 ex ex::rhs() const
 237 {
 238         if (!is_a<relational>(*this))
 239                 throw std::runtime_error("ex::rhs(): not a relation");
 240         return bp->op(1);
 241 }
 242
 243 /** Check whether expression is a polynomial. */
 244 bool ex::is_polynomial(const ex & vars) const
 245 {
 246         if (is_a<lst>(vars)) {
 247                 const lst & varlst = ex_to<lst>(vars);
 248                 for (lst::const_iterator i=varlst.begin(); i!=varlst.end(); ++i)
 249                         if (!bp->is_polynomial(*i))
 250                                 return false;
 251                 return true;
 252         }
 253         else
 254                 return bp->is_polynomial(vars);
 255 }
 256
 257 // private
 258
 259 /** Make this ex writable (if more than one ex handle the same basic) by
 260  *  unlinking the object and creating an unshared copy of it. */
 261 void ex::makewriteable()
 262 {
 263         GINAC_ASSERT(bp->flags & status_flags::dynallocated);
 264         bp.makewritable();
 265         GINAC_ASSERT(bp->get_refcount() == 1);
 266 }
 267
 268 /** Share equal objects between expressions.
 269  *  @see ex::compare(const ex &) */
 270 void ex::share(const ex & other) const
 271 {
 272         if ((bp->flags | other.bp->flags) & status_flags::not_shareable)
 273                 return;
 274
 275         if (bp->get_refcount() <= other.bp->get_refcount())
 276                 bp = other.bp;
 277         else
 278                 other.bp = bp;
 279 }
 280
 281 /** Helper function for the ex-from-basic constructor. This is where GiNaC's
 282  *  automatic evaluator and memory management are implemented.
 283  *  @see ex::ex(const basic &) */
 284 ptr<basic> ex::construct_from_basic(const basic & other)
 285 {
 286         if (!(other.flags & status_flags::evaluated)) {
 287
 288                 // The object is not yet evaluated, so call eval() to evaluate
 289                 // the top level. This will return either
 290                 //  a) the original object with status_flags::evaluated set (when the
 291                 //     eval() implementation calls hold())
 292                 // or
 293                 //  b) a different expression.
 294                 //
 295                 // eval() returns an ex, not a basic&, so this will go through
 296                 // construct_from_basic() a second time. In case a) we end up in
 297                 // the "else" branch below. In case b) we end up here again and
 298                 // apply eval() once more. The recursion stops when eval() calls
 299                 // hold() or returns an object that already has its "evaluated"
 300                 // flag set, such as a symbol or a numeric.
 301                 const ex & tmpex = other.eval(1);
 302
 303                 // Eventually, the eval() recursion goes through the "else" branch
 304                 // below, which assures that the object pointed to by tmpex.bp is
 305                 // allocated on the heap (either it was already on the heap or it
 306                 // is a heap-allocated duplicate of another object).
 307                 GINAC_ASSERT(tmpex.bp->flags & status_flags::dynallocated);
 308
 309                 // If the original object is not referenced but heap-allocated,
 310                 // it means that eval() hit case b) above. The original object is
 311                 // no longer needed (it evaluated into something different), so we
 312                 // delete it (because nobody else will).
 313                 if ((other.get_refcount() == 0) && (other.flags & status_flags::dynallocated))
 314                         delete &other; // yes, you can apply delete to a const pointer
 315
 316                 // We can't return a basic& here because the tmpex is destroyed as
 317                 // soon as we leave the function, which would deallocate the
 318                 // evaluated object.
 319                 return tmpex.bp;
 320
 321         } else {
 322
 323                 // The easy case: making an "ex" out of an evaluated object.
 324                 if (other.flags & status_flags::dynallocated) {
 325
 326                         // The object is already heap-allocated, so we can just make
 327                         // another reference to it.
 328                         return ptr<basic>(const_cast<basic &>(other));
 329
 330                 } else {
 331
 332                         // The object is not heap-allocated, so we create a duplicate
 333                         // on the heap.
 334                         basic *bp = other.duplicate();
 335                         bp->setflag(status_flags::dynallocated);
 336                         GINAC_ASSERT(bp->get_refcount() == 0);
 337                         return bp;
 338                 }
 339         }
 340 }
 341
 342 basic & ex::construct_from_int(int i)
 343 {
 344         switch (i) {  // prefer flyweights over new objects
 345         case -12:
 346                 return *const_cast<numeric *>(_num_12_p);
 347         case -11:
 348                 return *const_cast<numeric *>(_num_11_p);
 349         case -10:
 350                 return *const_cast<numeric *>(_num_10_p);
 351         case -9:
 352                 return *const_cast<numeric *>(_num_9_p);
 353         case -8:
 354                 return *const_cast<numeric *>(_num_8_p);
 355         case -7:
 356                 return *const_cast<numeric *>(_num_7_p);
 357         case -6:
 358                 return *const_cast<numeric *>(_num_6_p);
 359         case -5:
 360                 return *const_cast<numeric *>(_num_5_p);
 361         case -4:
 362                 return *const_cast<numeric *>(_num_4_p);
 363         case -3:
 364                 return *const_cast<numeric *>(_num_3_p);
 365         case -2:
 366                 return *const_cast<numeric *>(_num_2_p);
 367         case -1:
 368                 return *const_cast<numeric *>(_num_1_p);
 369         case 0:
 370                 return *const_cast<numeric *>(_num0_p);
 371         case 1:
 372                 return *const_cast<numeric *>(_num1_p);
 373         case 2:
 374                 return *const_cast<numeric *>(_num2_p);
 375         case 3:
 376                 return *const_cast<numeric *>(_num3_p);
 377         case 4:
 378                 return *const_cast<numeric *>(_num4_p);
 379         case 5:
 380                 return *const_cast<numeric *>(_num5_p);
 381         case 6:
 382                 return *const_cast<numeric *>(_num6_p);
 383         case 7:
 384                 return *const_cast<numeric *>(_num7_p);
 385         case 8:
 386                 return *const_cast<numeric *>(_num8_p);
 387         case 9:
 388                 return *const_cast<numeric *>(_num9_p);
 389         case 10:
 390                 return *const_cast<numeric *>(_num10_p);
 391         case 11:
 392                 return *const_cast<numeric *>(_num11_p);
 393         case 12:
 394                 return *const_cast<numeric *>(_num12_p);
 395         default:
 396                 basic *bp = new numeric(i);
 397                 bp->setflag(status_flags::dynallocated);
 398                 GINAC_ASSERT(bp->get_refcount() == 0);
 399                 return *bp;
 400         }
 401 }
 402
 403 basic & ex::construct_from_uint(unsigned int i)
 404 {
 405         switch (i) {  // prefer flyweights over new objects
 406         case 0:
 407                 return *const_cast<numeric *>(_num0_p);
 408         case 1:
 409                 return *const_cast<numeric *>(_num1_p);
 410         case 2:
 411                 return *const_cast<numeric *>(_num2_p);
 412         case 3:
 413                 return *const_cast<numeric *>(_num3_p);
 414         case 4:
 415                 return *const_cast<numeric *>(_num4_p);
 416         case 5:
 417                 return *const_cast<numeric *>(_num5_p);
 418         case 6:
 419                 return *const_cast<numeric *>(_num6_p);
 420         case 7:
 421                 return *const_cast<numeric *>(_num7_p);
 422         case 8:
 423                 return *const_cast<numeric *>(_num8_p);
 424         case 9:
 425                 return *const_cast<numeric *>(_num9_p);
 426         case 10:
 427                 return *const_cast<numeric *>(_num10_p);
 428         case 11:
 429                 return *const_cast<numeric *>(_num11_p);
 430         case 12:
 431                 return *const_cast<numeric *>(_num12_p);
 432         default:
 433                 basic *bp = new numeric(i);
 434                 bp->setflag(status_flags::dynallocated);
 435                 GINAC_ASSERT(bp->get_refcount() == 0);
 436                 return *bp;
 437         }
 438 }
 439
 440 basic & ex::construct_from_long(long i)
 441 {
 442         switch (i) {  // prefer flyweights over new objects
 443         case -12:
 444                 return *const_cast<numeric *>(_num_12_p);
 445         case -11:
 446                 return *const_cast<numeric *>(_num_11_p);
 447         case -10:
 448                 return *const_cast<numeric *>(_num_10_p);
 449         case -9:
 450                 return *const_cast<numeric *>(_num_9_p);
 451         case -8:
 452                 return *const_cast<numeric *>(_num_8_p);
 453         case -7:
 454                 return *const_cast<numeric *>(_num_7_p);
 455         case -6:
 456                 return *const_cast<numeric *>(_num_6_p);
 457         case -5:
 458                 return *const_cast<numeric *>(_num_5_p);
 459         case -4:
 460                 return *const_cast<numeric *>(_num_4_p);
 461         case -3:
 462                 return *const_cast<numeric *>(_num_3_p);
 463         case -2:
 464                 return *const_cast<numeric *>(_num_2_p);
 465         case -1:
 466                 return *const_cast<numeric *>(_num_1_p);
 467         case 0:
 468                 return *const_cast<numeric *>(_num0_p);
 469         case 1:
 470                 return *const_cast<numeric *>(_num1_p);
 471         case 2:
 472                 return *const_cast<numeric *>(_num2_p);
 473         case 3:
 474                 return *const_cast<numeric *>(_num3_p);
 475         case 4:
 476                 return *const_cast<numeric *>(_num4_p);
 477         case 5:
 478                 return *const_cast<numeric *>(_num5_p);
 479         case 6:
 480                 return *const_cast<numeric *>(_num6_p);
 481         case 7:
 482                 return *const_cast<numeric *>(_num7_p);
 483         case 8:
 484                 return *const_cast<numeric *>(_num8_p);
 485         case 9:
 486                 return *const_cast<numeric *>(_num9_p);
 487         case 10:
 488                 return *const_cast<numeric *>(_num10_p);
 489         case 11:
 490                 return *const_cast<numeric *>(_num11_p);
 491         case 12:
 492                 return *const_cast<numeric *>(_num12_p);
 493         default:
 494                 basic *bp = new numeric(i);
 495                 bp->setflag(status_flags::dynallocated);
 496                 GINAC_ASSERT(bp->get_refcount() == 0);
 497                 return *bp;
 498         }
 499 }
 500
 501 basic & ex::construct_from_ulong(unsigned long i)
 502 {
 503         switch (i) {  // prefer flyweights over new objects
 504         case 0:
 505                 return *const_cast<numeric *>(_num0_p);
 506         case 1:
 507                 return *const_cast<numeric *>(_num1_p);
 508         case 2:
 509                 return *const_cast<numeric *>(_num2_p);
 510         case 3:
 511                 return *const_cast<numeric *>(_num3_p);
 512         case 4:
 513                 return *const_cast<numeric *>(_num4_p);
 514         case 5:
 515                 return *const_cast<numeric *>(_num5_p);
 516         case 6:
 517                 return *const_cast<numeric *>(_num6_p);
 518         case 7:
 519                 return *const_cast<numeric *>(_num7_p);
 520         case 8:
 521                 return *const_cast<numeric *>(_num8_p);
 522         case 9:
 523                 return *const_cast<numeric *>(_num9_p);
 524         case 10:
 525                 return *const_cast<numeric *>(_num10_p);
 526         case 11:
 527                 return *const_cast<numeric *>(_num11_p);
 528         case 12:
 529                 return *const_cast<numeric *>(_num12_p);
 530         default:
 531                 basic *bp = new numeric(i);
 532                 bp->setflag(status_flags::dynallocated);
 533                 GINAC_ASSERT(bp->get_refcount() == 0);
 534                 return *bp;
 535         }
 536 }
 537
 538 basic & ex::construct_from_double(double d)
 539 {
 540         basic *bp = new numeric(d);
 541         bp->setflag(status_flags::dynallocated);
 542         GINAC_ASSERT(bp->get_refcount() == 0);
 543         return *bp;
 544 }
 545
 546 ptr<basic> ex::construct_from_string_and_lst(const std::string &s, const ex &l)
 547 {
 548         set_lexer_string(s);
 549         set_lexer_symbols(l);
 550         ginac_yyrestart(NULL);
 551         if (ginac_yyparse())
 552                 throw (std::runtime_error(get_parser_error()));
 553         else
 554                 return parsed_ex.bp;
 555 }
 556
 557 //////////
 558 // static member variables
 559 //////////
 560
 561 // none
 562
 563 //////////
 564 // functions which are not member functions
 565 //////////
 566
 567 // none
 568
 569 //////////
 570 // global functions
 571 //////////
 572
 573 // none
 574
 575
 576 } // namespace GiNaC