ginac/ex.h

   1 /** @file ex.h
   2  *
   3  *  Interface to GiNaC's light-weight expression handles. */
   4
   5 /*
   6  *  GiNaC Copyright (C) 1999-2004 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 #ifndef __GINAC_EX_H__
  24 #define __GINAC_EX_H__
  25
  26 #include <iosfwd>
  27 #include <iterator>
  28 #include <functional>
  29 #include <stack>
  30
  31 #include "basic.h"
  32 #include "ptr.h"
  33
  34 namespace GiNaC {
  35
  36
  37 /** Helper class to initialize the library.  There must be one static object
  38  *  of this class in every object file that makes use of our flyweights in
  39  *  order to guarantee proper initialization.  Hence we put it into this
  40  *  file which is included by every relevant file anyways.  This is modeled
  41  *  after section 27.4.2.1.6 of the C++ standard, where cout and friends are
  42  *  set up.
  43  *
  44  *  @see utils.cpp */
  45 class library_init {
  46 public:
  47         library_init();
  48         ~library_init();
  49 private:
  50         static int count;
  51 };
  52 /** For construction of flyweights, etc. */
  53 static library_init library_initializer;
  54
  55
  56 class scalar_products;
  57 class const_iterator;
  58 class const_preorder_iterator;
  59 class const_postorder_iterator;
  60
  61
  62 /** Lightweight wrapper for GiNaC's symbolic objects.  Basically all it does is
  63  *  to hold a pointer to the other objects, manage the reference counting and
  64  *  provide methods for manipulation of these objects.  (Some people call such
  65  *  a thing a proxy class.) */
  66 class ex {
  67         friend class archive_node;
  68         friend inline bool are_ex_trivially_equal(const ex &, const ex &);
  69         template<class T> friend inline const T &ex_to(const ex &);
  70         template<class T> friend inline bool is_a(const ex &);
  71         template<class T> friend inline bool is_exactly_a(const ex &);
  72
  73         // default constructor, copy constructor and assignment operator
  74 public:
  75         ex() throw();
  76 #ifdef OBSCURE_CINT_HACK
  77         ex(const ex & other);
  78         ex & operator=(const ex & other);
  79 #endif
  80
  81         // other constructors
  82 public:
  83         ex(const basic & other);
  84         ex(int i);
  85         ex(unsigned int i);
  86         ex(long i);
  87         ex(unsigned long i);
  88         ex(double const d);
  89
  90         /** Construct ex from string and a list of symbols. The input grammar is
  91          *  similar to the GiNaC output format. All symbols and indices to be used
  92          *  in the expression must be specified in a lst in the second argument.
  93          *  Undefined symbols and other parser errors will throw an exception. */
  94         ex(const std::string &s, const ex &l);
  95
  96 public:
  97         // non-virtual functions in this class
  98 public:
  99         /** Efficiently swap the contents of two expressions. */
 100         void swap(ex & other) throw()
 101         {
 102                 GINAC_ASSERT(bp->flags & status_flags::dynallocated);
 103                 GINAC_ASSERT(other.bp->flags & status_flags::dynallocated);
 104                 bp.swap(other.bp);
 105         }
 106
 107         // iterators
 108         const_iterator begin() const throw();
 109         const_iterator end() const throw();
 110         const_preorder_iterator preorder_begin() const;
 111         const_preorder_iterator preorder_end() const throw();
 112         const_postorder_iterator postorder_begin() const;
 113         const_postorder_iterator postorder_end() const throw();
 114
 115         // evaluation
 116         ex eval(int level = 0) const { return bp->eval(level); }
 117         ex evalf(int level = 0) const { return bp->evalf(level); }
 118         ex evalm() const { return bp->evalm(); }
 119         ex eval_ncmul(const exvector & v) const { return bp->eval_ncmul(v); }
 120
 121         // printing
 122         void print(const print_context & c, unsigned level = 0) const;
 123         void dbgprint() const;
 124         void dbgprinttree() const;
 125
 126         // info
 127         bool info(unsigned inf) const { return bp->info(inf); }
 128
 129         // operand access
 130         size_t nops() const { return bp->nops(); }
 131         ex op(size_t i) const { return bp->op(i); }
 132         ex operator[](const ex & index) const { return (*bp)[index]; }
 133         ex operator[](size_t i) const { return (*bp)[i]; }
 134         ex & let_op(size_t i);
 135         ex & operator[](const ex & index);
 136         ex & operator[](size_t i);
 137         ex lhs() const;
 138         ex rhs() const;
 139
 140         // complex conjugation
 141         ex conjugate() const { return bp->conjugate(); }
 142
 143         // pattern matching
 144         bool has(const ex & pattern) const { return bp->has(pattern); }
 145         bool find(const ex & pattern, lst & found) const;
 146         bool match(const ex & pattern) const;
 147         bool match(const ex & pattern, lst & repl_lst) const { return bp->match(pattern, repl_lst); }
 148
 149         // substitutions
 150         ex subs(const exmap & m, unsigned options = 0) const;
 151         ex subs(const lst & ls, const lst & lr, unsigned options = 0) const;
 152         ex subs(const ex & e, unsigned options = 0) const;
 153
 154         // function mapping
 155         ex map(map_function & f) const { return bp->map(f); }
 156         ex map(ex (*f)(const ex & e)) const;
 157
 158         // visitors and tree traversal
 159         void accept(visitor & v) const { bp->accept(v); }
 160         void traverse_preorder(visitor & v) const;
 161         void traverse_postorder(visitor & v) const;
 162         void traverse(visitor & v) const { traverse_preorder(v); }
 163
 164         // degree/coeff
 165         int degree(const ex & s) const { return bp->degree(s); }
 166         int ldegree(const ex & s) const { return bp->ldegree(s); }
 167         ex coeff(const ex & s, int n = 1) const { return bp->coeff(s, n); }
 168         ex lcoeff(const ex & s) const { return coeff(s, degree(s)); }
 169         ex tcoeff(const ex & s) const { return coeff(s, ldegree(s)); }
 170
 171         // expand/collect
 172         ex expand(unsigned options=0) const;
 173         ex collect(const ex & s, bool distributed = false) const { return bp->collect(s, distributed); }
 174
 175         // differentiation and series expansion
 176         ex diff(const symbol & s, unsigned nth = 1) const;
 177         ex series(const ex & r, int order, unsigned options = 0) const;
 178
 179         // rational functions
 180         ex normal(int level = 0) const;
 181         ex to_rational(exmap & repl) const;
 182         ex to_rational(lst & repl_lst) const;
 183         ex to_polynomial(exmap & repl) const;
 184         ex to_polynomial(lst & repl_lst) const;
 185         ex numer() const;
 186         ex denom() const;
 187         ex numer_denom() const;
 188
 189         // polynomial algorithms
 190         ex unit(const ex &x) const;
 191         ex content(const ex &x) const;
 192         numeric integer_content() const;
 193         ex primpart(const ex &x) const;
 194         ex primpart(const ex &x, const ex &cont) const;
 195         ex smod(const numeric &xi) const { return bp->smod(xi); }
 196         numeric max_coefficient() const;
 197
 198         // indexed objects
 199         exvector get_free_indices() const { return bp->get_free_indices(); }
 200         ex simplify_indexed(unsigned options = 0) const;
 201         ex simplify_indexed(const scalar_products & sp, unsigned options = 0) const;
 202
 203         // comparison
 204         int compare(const ex & other) const;
 205         bool is_equal(const ex & other) const;
 206         bool is_zero() const { extern const ex _ex0; return is_equal(_ex0); }
 207
 208         // symmetry
 209         ex symmetrize() const;
 210         ex symmetrize(const lst & l) const;
 211         ex antisymmetrize() const;
 212         ex antisymmetrize(const lst & l) const;
 213         ex symmetrize_cyclic() const;
 214         ex symmetrize_cyclic(const lst & l) const;
 215
 216         // noncommutativity
 217         unsigned return_type() const { return bp->return_type(); }
 218         unsigned return_type_tinfo() const { return bp->return_type_tinfo(); }
 219
 220         unsigned gethash() const { return bp->gethash(); }
 221
 222 private:
 223         static ptr<basic> construct_from_basic(const basic & other);
 224         static basic & construct_from_int(int i);
 225         static basic & construct_from_uint(unsigned int i);
 226         static basic & construct_from_long(long i);
 227         static basic & construct_from_ulong(unsigned long i);
 228         static basic & construct_from_double(double d);
 229         static ptr<basic> construct_from_string_and_lst(const std::string &s, const ex &l);
 230         void makewriteable();
 231         void share(const ex & other) const;
 232
 233 #ifdef OBSCURE_CINT_HACK
 234 public:
 235         static bool last_created_or_assigned_bp_can_be_converted_to_ex()
 236         {
 237                 if (last_created_or_assigned_bp==0) return false;
 238                 if ((last_created_or_assigned_bp->flags &
 239                          status_flags::dynallocated)==0) return false;
 240                 if ((last_created_or_assigned_bp->flags &
 241                          status_flags::evaluated)==0) return false;
 242                 return true;
 243         }
 244 protected:
 245         void update_last_created_or_assigned_bp()
 246         {
 247                 last_created_or_assigned_bp = bp;
 248                 last_created_or_assigned_exp = (long)(void *)(this);
 249         }
 250 #endif // def OBSCURE_CINT_HACK
 251
 252 // member variables
 253
 254 private:
 255         mutable ptr<basic> bp;  ///< pointer to basic object managed by this
 256
 257 #ifdef OBSCURE_CINT_HACK
 258 public:
 259         static ptr<basic> last_created_or_assigned_bp;
 260         static basic * dummy_bp;
 261         static long last_created_or_assigned_exp;
 262 #endif // def OBSCURE_CINT_HACK
 263 };
 264
 265
 266 // performance-critical inlined method implementations
 267
 268 // This needs to be a basic* because we don't know that numeric is derived
 269 // from basic and we need a basic& for the ex default constructor
 270 extern const basic *_num0_bp;
 271
 272 inline
 273 ex::ex() throw() : bp(*const_cast<basic *>(_num0_bp))
 274 {
 275         GINAC_ASSERT(bp->flags & status_flags::dynallocated);
 276 #ifdef OBSCURE_CINT_HACK
 277         update_last_created_or_assigned_bp();
 278 #endif // def OBSCURE_CINT_HACK
 279 }
 280
 281 #ifdef OBSCURE_CINT_HACK
 282 inline
 283 ex::ex(const ex & other) : bp(other.bp)
 284 {
 285         GINAC_ASSERT((bp->flags) & status_flags::dynallocated);
 286         update_last_created_or_assigned_bp();
 287 }
 288
 289 inline
 290 ex & ex::operator=(const ex & other)
 291 {
 292         GINAC_ASSERT(bp->flags & status_flags::dynallocated);
 293         GINAC_ASSERT(other.bp->flags & status_flags::dynallocated);
 294         bp = other.bp;
 295         update_last_created_or_assigned_bp();
 296         return *this;
 297 }
 298 #endif // def OBSCURE_CINT_HACK
 299
 300 inline
 301 ex::ex(const basic & other) : bp(construct_from_basic(other))
 302 {
 303         GINAC_ASSERT(bp->flags & status_flags::dynallocated);
 304 #ifdef OBSCURE_CINT_HACK
 305         update_last_created_or_assigned_bp();
 306 #endif // def OBSCURE_CINT_HACK
 307 }
 308
 309 inline
 310 ex::ex(int i) : bp(construct_from_int(i))
 311 {
 312         GINAC_ASSERT(bp->flags & status_flags::dynallocated);
 313 #ifdef OBSCURE_CINT_HACK
 314         update_last_created_or_assigned_bp();
 315 #endif // def OBSCURE_CINT_HACK
 316 }
 317
 318 inline
 319 ex::ex(unsigned int i) : bp(construct_from_uint(i))
 320 {
 321         GINAC_ASSERT(bp->flags & status_flags::dynallocated);
 322 #ifdef OBSCURE_CINT_HACK
 323         update_last_created_or_assigned_bp();
 324 #endif // def OBSCURE_CINT_HACK
 325 }
 326
 327 inline
 328 ex::ex(long i) : bp(construct_from_long(i))
 329 {
 330         GINAC_ASSERT(bp->flags & status_flags::dynallocated);
 331 #ifdef OBSCURE_CINT_HACK
 332         update_last_created_or_assigned_bp();
 333 #endif // def OBSCURE_CINT_HACK
 334 }
 335
 336 inline
 337 ex::ex(unsigned long i) : bp(construct_from_ulong(i))
 338 {
 339         GINAC_ASSERT(bp->flags & status_flags::dynallocated);
 340 #ifdef OBSCURE_CINT_HACK
 341         update_last_created_or_assigned_bp();
 342 #endif // def OBSCURE_CINT_HACK
 343 }
 344
 345 inline
 346 ex::ex(double const d) : bp(construct_from_double(d))
 347 {
 348         GINAC_ASSERT(bp->flags & status_flags::dynallocated);
 349 #ifdef OBSCURE_CINT_HACK
 350         update_last_created_or_assigned_bp();
 351 #endif // def OBSCURE_CINT_HACK
 352 }
 353
 354 inline
 355 ex::ex(const std::string &s, const ex &l) : bp(construct_from_string_and_lst(s, l))
 356 {
 357         GINAC_ASSERT(bp->flags & status_flags::dynallocated);
 358 #ifdef OBSCURE_CINT_HACK
 359         update_last_created_or_assigned_bp();
 360 #endif // def OBSCURE_CINT_HACK
 361 }
 362
 363 inline
 364 int ex::compare(const ex & other) const
 365 {
 366         if (bp == other.bp)  // trivial case: both expressions point to same basic
 367                 return 0;
 368         const int cmpval = bp->compare(*other.bp);
 369         if (cmpval == 0) {
 370                 // Expressions point to different, but equal, trees: conserve
 371                 // memory and make subsequent compare() operations faster by
 372                 // making both expression point to the same tree.
 373                 share(other);
 374         }
 375         return cmpval;
 376 }
 377
 378 inline
 379 bool ex::is_equal(const ex & other) const
 380 {
 381         if (bp == other.bp)  // trivial case: both expressions point to same basic
 382                 return true;
 383         return bp->is_equal(*other.bp);
 384 }
 385
 386
 387 // Iterators
 388
 389 class const_iterator : public std::iterator<std::random_access_iterator_tag, ex, ptrdiff_t, const ex *, const ex &> {
 390         friend class ex;
 391         friend class const_preorder_iterator;
 392         friend class const_postorder_iterator;
 393
 394 public:
 395         const_iterator() throw() {}
 396
 397 private:
 398         const_iterator(const ex &e_, size_t i_) throw() : e(e_), i(i_) {}
 399
 400 public:
 401         // This should return an ex&, but that would be a reference to a
 402         // temporary value
 403         ex operator*() const
 404         {
 405                 return e.op(i);
 406         }
 407
 408         // This should return an ex*, but that would be a pointer to a
 409         // temporary value
 410         std::auto_ptr<ex> operator->() const
 411         {
 412                 return std::auto_ptr<ex>(new ex(operator*()));
 413         }
 414
 415         ex operator[](difference_type n) const
 416         {
 417                 return e.op(i + n);
 418         }
 419
 420         const_iterator &operator++() throw()
 421         {
 422                 ++i;
 423                 return *this;
 424         }
 425
 426         const_iterator operator++(int) throw()
 427         {
 428                 const_iterator tmp = *this;
 429                 ++i;
 430                 return tmp;
 431         }
 432
 433         const_iterator &operator+=(difference_type n) throw()
 434         {
 435                 i += n;
 436                 return *this;
 437         }
 438
 439         const_iterator operator+(difference_type n) const throw()
 440         {
 441                 return const_iterator(e, i + n);
 442         }
 443
 444         inline friend const_iterator operator+(difference_type n, const const_iterator &it) throw()
 445         {
 446                 return const_iterator(it.e, it.i + n);
 447         }
 448
 449         const_iterator &operator--() throw()
 450         {
 451                 --i;
 452                 return *this;
 453         }
 454
 455         const_iterator operator--(int) throw()
 456         {
 457                 const_iterator tmp = *this;
 458                 --i;
 459                 return tmp;
 460         }
 461
 462         const_iterator &operator-=(difference_type n) throw()
 463         {
 464                 i -= n;
 465                 return *this;
 466         }
 467
 468         const_iterator operator-(difference_type n) const throw()
 469         {
 470                 return const_iterator(e, i - n);
 471         }
 472
 473         inline friend difference_type operator-(const const_iterator &lhs, const const_iterator &rhs) throw()
 474         {
 475                 return lhs.i - rhs.i;
 476         }
 477
 478         bool operator==(const const_iterator &other) const throw()
 479         {
 480                 return are_ex_trivially_equal(e, other.e) && i == other.i;
 481         }
 482
 483         bool operator!=(const const_iterator &other) const throw()
 484         {
 485                 return !(*this == other);
 486         }
 487
 488         bool operator<(const const_iterator &other) const throw()
 489         {
 490                 return i < other.i;
 491         }
 492
 493         bool operator>(const const_iterator &other) const throw()
 494         {
 495                 return other < *this;
 496         }
 497
 498         bool operator<=(const const_iterator &other) const throw()
 499         {
 500                 return !(other < *this);
 501         }
 502
 503         bool operator>=(const const_iterator &other) const throw()
 504         {
 505                 return !(*this < other);
 506         }
 507
 508 protected:
 509         ex e; // this used to be a "const basic *", but in view of object fusion that wouldn't be safe
 510         size_t i;
 511 };
 512
 513 namespace internal {
 514
 515 struct _iter_rep {
 516         _iter_rep(const ex &e_, size_t i_, size_t i_end_) : e(e_), i(i_), i_end(i_end_) {}
 517
 518         bool operator==(const _iter_rep &other) const throw()
 519         {
 520                 return are_ex_trivially_equal(e, other.e) && i == other.i;
 521         }
 522
 523         bool operator!=(const _iter_rep &other) const throw()
 524         {
 525                 return !(*this == other);
 526         }
 527
 528         ex e;
 529         size_t i;
 530         size_t i_end;
 531 };
 532
 533 } // namespace internal
 534
 535 class const_preorder_iterator : public std::iterator<std::forward_iterator_tag, ex, ptrdiff_t, const ex *, const ex &> {
 536 public:
 537         const_preorder_iterator() throw() {}
 538
 539         const_preorder_iterator(const ex &e, size_t n)
 540         {
 541                 s.push(internal::_iter_rep(e, 0, n));
 542         }
 543
 544 public:
 545         reference operator*() const
 546         {
 547                 return s.top().e;
 548         }
 549
 550         pointer operator->() const
 551         {
 552                 return &(s.top().e);
 553         }
 554
 555         const_preorder_iterator &operator++()
 556         {
 557                 increment();
 558                 return *this;
 559         }
 560
 561         const_preorder_iterator operator++(int)
 562         {
 563                 const_preorder_iterator tmp = *this;
 564                 increment();
 565                 return tmp;
 566         }
 567
 568         bool operator==(const const_preorder_iterator &other) const throw()
 569         {
 570                 return s == other.s;
 571         }
 572
 573         bool operator!=(const const_preorder_iterator &other) const throw()
 574         {
 575                 return !(*this == other);
 576         }
 577
 578 private:
 579         std::stack<internal::_iter_rep, std::vector<internal::_iter_rep> > s;
 580
 581         void increment()
 582         {
 583                 while (!s.empty() && s.top().i == s.top().i_end) {
 584                         s.pop();
 585                         if (s.empty())
 586                                 return;
 587                         ++s.top().i;
 588                 }
 589
 590                 internal::_iter_rep & current = s.top();
 591
 592                 if (current.i != current.i_end) {
 593                         const ex & child = current.e.op(current.i);
 594                         s.push(internal::_iter_rep(child, 0, child.nops()));
 595                 }
 596         }
 597 };
 598
 599 class const_postorder_iterator : public std::iterator<std::forward_iterator_tag, ex, ptrdiff_t, const ex *, const ex &> {
 600 public:
 601         const_postorder_iterator() throw() {}
 602
 603         const_postorder_iterator(const ex &e, size_t n)
 604         {
 605                 s.push(internal::_iter_rep(e, 0, n));
 606                 descend();
 607         }
 608
 609 public:
 610         reference operator*() const
 611         {
 612                 return s.top().e;
 613         }
 614
 615         pointer operator->() const
 616         {
 617                 return &(s.top().e);
 618         }
 619
 620         const_postorder_iterator &operator++()
 621         {
 622                 increment();
 623                 return *this;
 624         }
 625
 626         const_postorder_iterator operator++(int)
 627         {
 628                 const_postorder_iterator tmp = *this;
 629                 increment();
 630                 return tmp;
 631         }
 632
 633         bool operator==(const const_postorder_iterator &other) const throw()
 634         {
 635                 return s == other.s;
 636         }
 637
 638         bool operator!=(const const_postorder_iterator &other) const throw()
 639         {
 640                 return !(*this == other);
 641         }
 642
 643 private:
 644         std::stack<internal::_iter_rep, std::vector<internal::_iter_rep> > s;
 645
 646         void descend()
 647         {
 648                 while (s.top().i != s.top().i_end) {
 649                         internal::_iter_rep & current = s.top();
 650                         const ex & child = current.e.op(current.i);
 651                         s.push(internal::_iter_rep(child, 0, child.nops()));
 652                 }
 653         }
 654
 655         void increment()
 656         {
 657                 if (s.top().i == s.top().i_end)
 658                         s.pop();
 659                 if (!s.empty()) {
 660                         ++s.top().i;
 661                         descend();
 662                 }
 663         }
 664 };
 665
 666 inline const_iterator ex::begin() const throw()
 667 {
 668         return const_iterator(*this, 0);
 669 }
 670
 671 inline const_iterator ex::end() const throw()
 672 {
 673         return const_iterator(*this, nops());
 674 }
 675
 676 inline const_preorder_iterator ex::preorder_begin() const
 677 {
 678         return const_preorder_iterator(*this, nops());
 679 }
 680
 681 inline const_preorder_iterator ex::preorder_end() const throw()
 682 {
 683         return const_preorder_iterator();
 684 }
 685
 686 inline const_postorder_iterator ex::postorder_begin() const
 687 {
 688         return const_postorder_iterator(*this, nops());
 689 }
 690
 691 inline const_postorder_iterator ex::postorder_end() const throw()
 692 {
 693         return const_postorder_iterator();
 694 }
 695
 696
 697 // utility functions
 698
 699 /** Compare two objects of class quickly without doing a deep tree traversal.
 700  *  @return "true" if they are equal
 701  *          "false" if equality cannot be established quickly (e1 and e2 may
 702  *          still be equal, in this case. */
 703 inline bool are_ex_trivially_equal(const ex &e1, const ex &e2)
 704 {
 705         return e1.bp == e2.bp;
 706 }
 707
 708 /* Function objects for STL sort() etc. */
 709 struct ex_is_less : public std::binary_function<ex, ex, bool> {
 710         bool operator() (const ex &lh, const ex &rh) const { return lh.compare(rh) < 0; }
 711 };
 712
 713 struct ex_is_equal : public std::binary_function<ex, ex, bool> {
 714         bool operator() (const ex &lh, const ex &rh) const { return lh.is_equal(rh); }
 715 };
 716
 717 struct op0_is_equal : public std::binary_function<ex, ex, bool> {
 718         bool operator() (const ex &lh, const ex &rh) const { return lh.op(0).is_equal(rh.op(0)); }
 719 };
 720
 721 struct ex_swap : public std::binary_function<ex, ex, void> {
 722         void operator() (ex &lh, ex &rh) const { lh.swap(rh); }
 723 };
 724
 725 // wrapper functions around member functions
 726 inline size_t nops(const ex & thisex)
 727 { return thisex.nops(); }
 728
 729 inline ex expand(const ex & thisex, unsigned options = 0)
 730 { return thisex.expand(options); }
 731
 732 inline bool has(const ex & thisex, const ex & pattern)
 733 { return thisex.has(pattern); }
 734
 735 inline bool find(const ex & thisex, const ex & pattern, lst & found)
 736 { return thisex.find(pattern, found); }
 737
 738 inline int degree(const ex & thisex, const ex & s)
 739 { return thisex.degree(s); }
 740
 741 inline int ldegree(const ex & thisex, const ex & s)
 742 { return thisex.ldegree(s); }
 743
 744 inline ex coeff(const ex & thisex, const ex & s, int n=1)
 745 { return thisex.coeff(s, n); }
 746
 747 inline ex numer(const ex & thisex)
 748 { return thisex.numer(); }
 749
 750 inline ex denom(const ex & thisex)
 751 { return thisex.denom(); }
 752
 753 inline ex numer_denom(const ex & thisex)
 754 { return thisex.numer_denom(); }
 755 inline ex conjugate(const ex & thisex)
 756 { return thisex.conjugate(); }
 757
 758
 759 inline ex normal(const ex & thisex, int level=0)
 760 { return thisex.normal(level); }
 761
 762 inline ex to_rational(const ex & thisex, lst & repl_lst)
 763 { return thisex.to_rational(repl_lst); }
 764
 765 inline ex to_rational(const ex & thisex, exmap & repl)
 766 { return thisex.to_rational(repl); }
 767
 768 inline ex to_polynomial(const ex & thisex, exmap & repl)
 769 { return thisex.to_polynomial(repl); }
 770
 771 inline ex to_polynomial(const ex & thisex, lst & repl_lst)
 772 { return thisex.to_polynomial(repl_lst); }
 773
 774 inline ex collect(const ex & thisex, const ex & s, bool distributed = false)
 775 { return thisex.collect(s, distributed); }
 776
 777 inline ex eval(const ex & thisex, int level = 0)
 778 { return thisex.eval(level); }
 779
 780 inline ex evalf(const ex & thisex, int level = 0)
 781 { return thisex.evalf(level); }
 782
 783 inline ex evalm(const ex & thisex)
 784 { return thisex.evalm(); }
 785
 786 inline ex diff(const ex & thisex, const symbol & s, unsigned nth = 1)
 787 { return thisex.diff(s, nth); }
 788
 789 inline ex series(const ex & thisex, const ex & r, int order, unsigned options = 0)
 790 { return thisex.series(r, order, options); }
 791
 792 inline bool match(const ex & thisex, const ex & pattern, lst & repl_lst)
 793 { return thisex.match(pattern, repl_lst); }
 794
 795 inline ex simplify_indexed(const ex & thisex, unsigned options = 0)
 796 { return thisex.simplify_indexed(options); }
 797
 798 inline ex simplify_indexed(const ex & thisex, const scalar_products & sp, unsigned options = 0)
 799 { return thisex.simplify_indexed(sp, options); }
 800
 801 inline ex symmetrize(const ex & thisex)
 802 { return thisex.symmetrize(); }
 803
 804 inline ex symmetrize(const ex & thisex, const lst & l)
 805 { return thisex.symmetrize(l); }
 806
 807 inline ex antisymmetrize(const ex & thisex)
 808 { return thisex.antisymmetrize(); }
 809
 810 inline ex antisymmetrize(const ex & thisex, const lst & l)
 811 { return thisex.antisymmetrize(l); }
 812
 813 inline ex symmetrize_cyclic(const ex & thisex)
 814 { return thisex.symmetrize_cyclic(); }
 815
 816 inline ex symmetrize_cyclic(const ex & thisex, const lst & l)
 817 { return thisex.symmetrize_cyclic(l); }
 818
 819 inline ex op(const ex & thisex, size_t i)
 820 { return thisex.op(i); }
 821
 822 inline ex lhs(const ex & thisex)
 823 { return thisex.lhs(); }
 824
 825 inline ex rhs(const ex & thisex)
 826 { return thisex.rhs(); }
 827
 828 inline bool is_zero(const ex & thisex)
 829 { return thisex.is_zero(); }
 830
 831 inline void swap(ex & e1, ex & e2)
 832 { e1.swap(e2); }
 833
 834 inline ex ex::subs(const exmap & m, unsigned options) const
 835 {
 836         return bp->subs(m, options);
 837 }
 838
 839 inline ex subs(const ex & thisex, const exmap & m, unsigned options = 0)
 840 { return thisex.subs(m, options); }
 841
 842 inline ex subs(const ex & thisex, const lst & ls, const lst & lr, unsigned options = 0)
 843 { return thisex.subs(ls, lr, options); }
 844
 845 inline ex subs(const ex & thisex, const ex & e, unsigned options = 0)
 846 { return thisex.subs(e, options); }
 847
 848
 849 /* Convert function pointer to function object suitable for map(). */
 850 class pointer_to_map_function : public map_function {
 851 protected:
 852         ex (*ptr)(const ex &);
 853 public:
 854         explicit pointer_to_map_function(ex x(const ex &)) : ptr(x) {}
 855         ex operator()(const ex & e) { return ptr(e); }
 856 };
 857
 858 template<class T1>
 859 class pointer_to_map_function_1arg : public map_function {
 860 protected:
 861         ex (*ptr)(const ex &, T1);
 862         T1 arg1;
 863 public:
 864         explicit pointer_to_map_function_1arg(ex x(const ex &, T1), T1 a1) : ptr(x), arg1(a1) {}
 865         ex operator()(const ex & e) { return ptr(e, arg1); }
 866 };
 867
 868 template<class T1, class T2>
 869 class pointer_to_map_function_2args : public map_function {
 870 protected:
 871         ex (*ptr)(const ex &, T1, T2);
 872         T1 arg1;
 873         T2 arg2;
 874 public:
 875         explicit pointer_to_map_function_2args(ex x(const ex &, T1, T2), T1 a1, T2 a2) : ptr(x), arg1(a1), arg2(a2) {}
 876         ex operator()(const ex & e) { return ptr(e, arg1, arg2); }
 877 };
 878
 879 template<class T1, class T2, class T3>
 880 class pointer_to_map_function_3args : public map_function {
 881 protected:
 882         ex (*ptr)(const ex &, T1, T2, T3);
 883         T1 arg1;
 884         T2 arg2;
 885         T3 arg3;
 886 public:
 887         explicit pointer_to_map_function_3args(ex x(const ex &, T1, T2, T3), T1 a1, T2 a2, T3 a3) : ptr(x), arg1(a1), arg2(a2), arg3(a3) {}
 888         ex operator()(const ex & e) { return ptr(e, arg1, arg2, arg3); }
 889 };
 890
 891 inline ex ex::map(ex f(const ex &)) const
 892 {
 893         pointer_to_map_function fcn(f);
 894         return bp->map(fcn);
 895 }
 896
 897 // convenience type checker template functions
 898
 899 /** Check if ex is a handle to a T, including base classes. */
 900 template <class T>
 901 inline bool is_a(const ex &obj)
 902 {
 903         return is_a<T>(*obj.bp);
 904 }
 905
 906 /** Check if ex is a handle to a T, not including base classes. */
 907 template <class T>
 908 inline bool is_exactly_a(const ex &obj)
 909 {
 910         return is_exactly_a<T>(*obj.bp);
 911 }
 912
 913 /** Return a reference to the basic-derived class T object embedded in an
 914  *  expression.  This is fast but unsafe: the result is undefined if the
 915  *  expression does not contain a T object at its top level.  Hence, you
 916  *  should generally check the type of e first.  Also, you shouldn't cache
 917  *  the returned reference because GiNaC's garbage collector may destroy
 918  *  the referenced object any time it's used in another expression.
 919  *
 920  *  @param e expression
 921  *  @return reference to object of class T
 922  *  @see is_exactly_a<class T>() */
 923 template <class T>
 924 inline const T &ex_to(const ex &e)
 925 {
 926         GINAC_ASSERT(is_a<T>(e));
 927         return static_cast<const T &>(*e.bp);
 928 }
 929
 930 } // namespace GiNaC
 931
 932
 933 // Specializations of Standard Library algorithms
 934 namespace std {
 935
 936 /** Specialization of std::swap() for ex objects. */
 937 template <>
 938 inline void swap(GiNaC::ex &a, GiNaC::ex &b)
 939 {
 940         a.swap(b);
 941 }
 942
 943 /** Specialization of std::iter_swap() for vector<ex> iterators. */
 944 template <>
 945 inline void iter_swap(vector<GiNaC::ex>::iterator i1, vector<GiNaC::ex>::iterator i2)
 946 {
 947         i1->swap(*i2);
 948 }
 949
 950 /** Specialization of std::iter_swap() for list<ex> iterators. */
 951 template <>
 952 inline void iter_swap(list<GiNaC::ex>::iterator i1, list<GiNaC::ex>::iterator i2)
 953 {
 954         i1->swap(*i2);
 955 }
 956
 957 } // namespace std
 958
 959 #endif // ndef __GINAC_EX_H__