ginac/ex.h

   1 /** @file ex.h
   2  *
   3  *  Interface to GiNaC's light-weight expression handles. */
   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 #ifndef __GINAC_EX_H__
  24 #define __GINAC_EX_H__
  25
  26 #include <iosfwd>
  27 #include <functional>
  28
  29 #include "basic.h"
  30 #include "operators.h"
  31
  32 namespace GiNaC {
  33
  34 /** Helper class to initialize the library.  There must be one static object
  35  *  of this class in every object file that makes use of our flyweights in
  36  *  order to guarantee proper initialization.  Hence we put it into this
  37  *  file which is included by every relevant file anyways.  This is modeled
  38  *  after section 27.4.2.1.6 of the C++ standard, where cout and friends are
  39  *  set up.
  40  *
  41  *  @see utils.cpp */
  42 class library_init {
  43 public:
  44         library_init();
  45         ~library_init();
  46 private:
  47         static int count;
  48 };
  49 /** For construction of flyweights, etc. */
  50 static library_init library_initializer;
  51
  52 // Current versions of Cint don't link data declared extern within functions.
  53 // FIXME: Fix Cint and later remove this from here.
  54 #if defined(G__CINTVERSION)
  55 extern const class numeric *_num0_p;
  56 #endif
  57
  58
  59 class symbol;
  60 class lst;
  61 class scalar_products;
  62
  63
  64 /** Lightweight wrapper for GiNaC's symbolic objects.  Basically all it does is
  65  *  to hold a pointer to the other objects, manage the reference counting and
  66  *  provide methods for manipulation of these objects.  (Some people call such
  67  *  a thing a proxy class.) */
  68 class ex
  69 {
  70         friend class archive_node;
  71         friend bool are_ex_trivially_equal(const ex &, const ex &);
  72         template<class T> friend const T &ex_to(const ex &);
  73         template<class T> friend bool is_a(const ex &);
  74         template<class T> friend bool is_exactly_a(const ex &);
  75
  76 // member functions
  77
  78         // default ctor, dtor, copy ctor, assignment operator and helpers
  79 public:
  80         ex();
  81         ~ex();
  82         ex(const ex & other);
  83         ex & operator=(const ex & other);
  84         // other ctors
  85 public:
  86         ex(const basic & other);
  87         ex(int i);
  88         ex(unsigned int i);
  89         ex(long i);
  90         ex(unsigned long i);
  91         ex(double const d);
  92         /** Construct ex from string and a list of symbols. The input grammar is
  93          *  similar to the GiNaC output format. All symbols to be used in the
  94          *  expression must be specified in a lst in the second argument. Undefined
  95          *  symbols and other parser errors will throw an exception. */
  96         ex(const std::string &s, const ex &l);
  97
  98         // non-virtual functions in this class
  99 public:
 100         void swap(ex & other);
 101         void print(const print_context & c, unsigned level = 0) const;
 102         void printtree(std::ostream & os) const;
 103         void dbgprint(void) const;
 104         void dbgprinttree(void) const;
 105         bool info(unsigned inf) const { return bp->info(inf); }
 106         unsigned nops() const { return bp->nops(); }
 107         ex expand(unsigned options=0) const;
 108         bool has(const ex & pattern) const { return bp->has(pattern); }
 109         ex map(map_function & f) const { return bp->map(f); }
 110         ex map(ex (*f)(const ex & e)) const;
 111         bool find(const ex & pattern, lst & found) const;
 112         int degree(const ex & s) const { return bp->degree(s); }
 113         int ldegree(const ex & s) const { return bp->ldegree(s); }
 114         ex coeff(const ex & s, int n = 1) const { return bp->coeff(s, n); }
 115         ex lcoeff(const ex & s) const { return coeff(s, degree(s)); }
 116         ex tcoeff(const ex & s) const { return coeff(s, ldegree(s)); }
 117         ex numer(void) const;
 118         ex denom(void) const;
 119         ex numer_denom(void) const;
 120         ex unit(const symbol &x) const;
 121         ex content(const symbol &x) const;
 122         numeric integer_content(void) const;
 123         ex primpart(const symbol &x) const;
 124         ex primpart(const symbol &x, const ex &cont) const;
 125         ex normal(int level = 0) const;
 126         ex to_rational(lst &repl_lst) const { return bp->to_rational(repl_lst); }
 127         ex smod(const numeric &xi) const { return bp->smod(xi); }
 128         numeric max_coefficient(void) const;
 129         ex collect(const ex & s, bool distributed = false) const { return bp->collect(s, distributed); }
 130         ex eval(int level = 0) const { return bp->eval(level); }
 131         ex evalf(int level = 0) const { return bp->evalf(level); }
 132         ex evalm(void) const { return bp->evalm(); }
 133         ex diff(const symbol & s, unsigned nth = 1) const;
 134         ex series(const ex & r, int order, unsigned options = 0) const;
 135         bool match(const ex & pattern) const;
 136         bool match(const ex & pattern, lst & repl_lst) const { return bp->match(pattern, repl_lst); }
 137         ex subs(const lst & ls, const lst & lr, bool no_pattern = false) const { return bp->subs(ls, lr, no_pattern); }
 138         ex subs(const ex & e, bool no_pattern = false) const { return bp->subs(e, no_pattern); }
 139         exvector get_free_indices(void) const { return bp->get_free_indices(); }
 140         ex simplify_indexed(void) const;
 141         ex simplify_indexed(const scalar_products & sp) const;
 142         ex symmetrize(void) const;
 143         ex symmetrize(const lst & l) const;
 144         ex antisymmetrize(void) const;
 145         ex antisymmetrize(const lst & l) const;
 146         ex symmetrize_cyclic(void) const;
 147         ex symmetrize_cyclic(const lst & l) const;
 148         ex simplify_ncmul(const exvector & v) const { return bp->simplify_ncmul(v); }
 149         ex operator[](const ex & index) const;
 150         ex operator[](int i) const;
 151         ex op(int i) const { return bp->op(i); }
 152         ex & let_op(int i);
 153         ex lhs(void) const;
 154         ex rhs(void) const;
 155         int compare(const ex & other) const;
 156         bool is_equal(const ex & other) const;
 157         bool is_zero(void) const { extern const ex _ex0; return is_equal(_ex0); }
 158
 159         unsigned return_type(void) const { return bp->return_type(); }
 160         unsigned return_type_tinfo(void) const { return bp->return_type_tinfo(); }
 161         unsigned gethash(void) const { return bp->gethash(); }
 162 private:
 163         void construct_from_basic(const basic & other);
 164         void construct_from_int(int i);
 165         void construct_from_uint(unsigned int i);
 166         void construct_from_long(long i);
 167         void construct_from_ulong(unsigned long i);
 168         void construct_from_double(double d);
 169         void construct_from_string_and_lst(const std::string &s, const ex &l);
 170         void makewriteable();
 171
 172 #ifdef OBSCURE_CINT_HACK
 173 public:
 174         static bool last_created_or_assigned_bp_can_be_converted_to_ex(void)
 175         {
 176                 if (last_created_or_assigned_bp==0) return false;
 177                 if ((last_created_or_assigned_bp->flags &
 178                          status_flags::dynallocated)==0) return false;
 179                 if ((last_created_or_assigned_bp->flags &
 180                          status_flags::evaluated)==0) return false;
 181                 return true;
 182         }
 183 protected:
 184         void update_last_created_or_assigned_bp(void)
 185         {
 186                 if (last_created_or_assigned_bp!=0) {
 187                         if (--last_created_or_assigned_bp->refcount == 0) {
 188                                 delete last_created_or_assigned_bp;
 189                         }
 190                 }
 191                 last_created_or_assigned_bp = bp;
 192                 ++last_created_or_assigned_bp->refcount;
 193                 last_created_or_assigned_exp = (long)(void *)(this);
 194         }
 195 #endif // def OBSCURE_CINT_HACK
 196
 197 // member variables
 198
 199 public:
 200         basic *bp;      ///< pointer to basic object managed by this, direct manipulation deprecated
 201 #ifdef OBSCURE_CINT_HACK
 202         static basic * last_created_or_assigned_bp;
 203         static basic * dummy_bp;
 204         static long last_created_or_assigned_exp;
 205 #endif // def OBSCURE_CINT_HACK
 206 };
 207
 208
 209 // performance-critical inlined method implementations
 210
 211 inline
 212 ex::ex()
 213 {
 214         extern const class numeric *_num0_p;
 215         bp = (basic*)_num0_p;
 216         GINAC_ASSERT(bp!=0);
 217         GINAC_ASSERT(bp->flags & status_flags::dynallocated);
 218         ++bp->refcount;
 219 #ifdef OBSCURE_CINT_HACK
 220         update_last_created_or_assigned_bp();
 221 #endif // def OBSCURE_CINT_HACK
 222 }
 223
 224 inline
 225 ex::~ex()
 226 {
 227         GINAC_ASSERT(bp!=0);
 228         GINAC_ASSERT(bp->flags & status_flags::dynallocated);
 229         if (--bp->refcount == 0)
 230                 delete bp;
 231 }
 232
 233 inline
 234 ex::ex(const ex & other) : bp(other.bp)
 235 {
 236         GINAC_ASSERT(bp!=0);
 237         GINAC_ASSERT((bp->flags) & status_flags::dynallocated);
 238         ++bp->refcount;
 239 #ifdef OBSCURE_CINT_HACK
 240         update_last_created_or_assigned_bp();
 241 #endif // def OBSCURE_CINT_HACK
 242 }
 243
 244 inline
 245 ex & ex::operator=(const ex & other)
 246 {
 247         GINAC_ASSERT(bp!=0);
 248         GINAC_ASSERT(bp->flags & status_flags::dynallocated);
 249         GINAC_ASSERT(other.bp!=0);
 250         GINAC_ASSERT(other.bp->flags & status_flags::dynallocated);
 251         // NB: must first increment other.bp->refcount, since other might be *this.
 252         ++other.bp->refcount;
 253         if (--bp->refcount==0)
 254                 delete bp;
 255         bp = other.bp;
 256 #ifdef OBSCURE_CINT_HACK
 257         update_last_created_or_assigned_bp();
 258 #endif // def OBSCURE_CINT_HACK
 259         return *this;
 260 }
 261
 262 inline
 263 ex::ex(const basic & other)
 264 {
 265         construct_from_basic(other);
 266 #ifdef OBSCURE_CINT_HACK
 267         update_last_created_or_assigned_bp();
 268 #endif // def OBSCURE_CINT_HACK
 269 }
 270
 271 inline
 272 ex::ex(int i)
 273 {
 274         construct_from_int(i);
 275 #ifdef OBSCURE_CINT_HACK
 276         update_last_created_or_assigned_bp();
 277 #endif // def OBSCURE_CINT_HACK
 278 }
 279
 280 inline
 281 ex::ex(unsigned int i)
 282 {
 283         construct_from_uint(i);
 284 #ifdef OBSCURE_CINT_HACK
 285         update_last_created_or_assigned_bp();
 286 #endif // def OBSCURE_CINT_HACK
 287 }
 288
 289 inline
 290 ex::ex(long i)
 291 {
 292         construct_from_long(i);
 293 #ifdef OBSCURE_CINT_HACK
 294         update_last_created_or_assigned_bp();
 295 #endif // def OBSCURE_CINT_HACK
 296 }
 297
 298 inline
 299 ex::ex(unsigned long i)
 300 {
 301         construct_from_ulong(i);
 302 #ifdef OBSCURE_CINT_HACK
 303         update_last_created_or_assigned_bp();
 304 #endif // def OBSCURE_CINT_HACK
 305 }
 306
 307 inline
 308 ex::ex(double const d)
 309 {
 310         construct_from_double(d);
 311 #ifdef OBSCURE_CINT_HACK
 312         update_last_created_or_assigned_bp();
 313 #endif // def OBSCURE_CINT_HACK
 314 }
 315
 316 inline
 317 ex::ex(const std::string &s, const ex &l)
 318 {
 319         construct_from_string_and_lst(s, l);
 320 #ifdef OBSCURE_CINT_HACK
 321         update_last_created_or_assigned_bp();
 322 #endif // def OBSCURE_CINT_HACK
 323 }
 324
 325 inline
 326 int ex::compare(const ex & other) const
 327 {
 328         GINAC_ASSERT(bp!=0);
 329         GINAC_ASSERT(other.bp!=0);
 330         if (bp==other.bp)  // trivial case: both expressions point to same basic
 331                 return 0;
 332         return bp->compare(*other.bp);
 333 }
 334
 335 inline
 336 bool ex::is_equal(const ex & other) const
 337 {
 338         GINAC_ASSERT(bp!=0);
 339         GINAC_ASSERT(other.bp!=0);
 340         if (bp==other.bp)  // trivial case: both expressions point to same basic
 341                 return true;
 342         return bp->is_equal(*other.bp);
 343 }
 344
 345
 346 // utility functions
 347
 348 /** Compare two objects of class quickly without doing a deep tree traversal.
 349  *  @return "true" if they are equal
 350  *          "false" if equality cannot be established quickly (e1 and e2 may
 351  *          still be equal, in this case. */
 352 inline bool are_ex_trivially_equal(const ex &e1, const ex &e2)
 353 {
 354         return e1.bp == e2.bp;
 355 }
 356
 357 // wrapper functions around member functions
 358 inline unsigned nops(const ex & thisex)
 359 { return thisex.nops(); }
 360
 361 inline ex expand(const ex & thisex, unsigned options = 0)
 362 { return thisex.expand(options); }
 363
 364 inline bool has(const ex & thisex, const ex & pattern)
 365 { return thisex.has(pattern); }
 366
 367 inline bool find(const ex & thisex, const ex & pattern, lst & found)
 368 { return thisex.find(pattern, found); }
 369
 370 inline int degree(const ex & thisex, const ex & s)
 371 { return thisex.degree(s); }
 372
 373 inline int ldegree(const ex & thisex, const ex & s)
 374 { return thisex.ldegree(s); }
 375
 376 inline ex coeff(const ex & thisex, const ex & s, int n=1)
 377 { return thisex.coeff(s, n); }
 378
 379 inline ex numer(const ex & thisex)
 380 { return thisex.numer(); }
 381
 382 inline ex denom(const ex & thisex)
 383 { return thisex.denom(); }
 384
 385 inline ex numer_denom(const ex & thisex)
 386 { return thisex.numer_denom(); }
 387
 388 inline ex normal(const ex & thisex, int level=0)
 389 { return thisex.normal(level); }
 390
 391 inline ex to_rational(const ex & thisex, lst & repl_lst)
 392 { return thisex.to_rational(repl_lst); }
 393
 394 inline ex collect(const ex & thisex, const ex & s, bool distributed = false)
 395 { return thisex.collect(s, distributed); }
 396
 397 inline ex eval(const ex & thisex, int level = 0)
 398 { return thisex.eval(level); }
 399
 400 inline ex evalf(const ex & thisex, int level = 0)
 401 { return thisex.evalf(level); }
 402
 403 inline ex evalm(const ex & thisex)
 404 { return thisex.evalm(); }
 405
 406 inline ex diff(const ex & thisex, const symbol & s, unsigned nth = 1)
 407 { return thisex.diff(s, nth); }
 408
 409 inline ex series(const ex & thisex, const ex & r, int order, unsigned options = 0)
 410 { return thisex.series(r, order, options); }
 411
 412 inline bool match(const ex & thisex, const ex & pattern, lst & repl_lst)
 413 { return thisex.match(pattern, repl_lst); }
 414
 415 inline ex subs(const ex & thisex, const ex & e)
 416 { return thisex.subs(e); }
 417
 418 inline ex subs(const ex & thisex, const lst & ls, const lst & lr)
 419 { return thisex.subs(ls, lr); }
 420
 421 inline ex simplify_indexed(const ex & thisex)
 422 { return thisex.simplify_indexed(); }
 423
 424 inline ex simplify_indexed(const ex & thisex, const scalar_products & sp)
 425 { return thisex.simplify_indexed(sp); }
 426
 427 inline ex symmetrize(const ex & thisex)
 428 { return thisex.symmetrize(); }
 429
 430 inline ex symmetrize(const ex & thisex, const lst & l)
 431 { return thisex.symmetrize(l); }
 432
 433 inline ex antisymmetrize(const ex & thisex)
 434 { return thisex.antisymmetrize(); }
 435
 436 inline ex antisymmetrize(const ex & thisex, const lst & l)
 437 { return thisex.antisymmetrize(l); }
 438
 439 inline ex symmetrize_cyclic(const ex & thisex)
 440 { return thisex.symmetrize_cyclic(); }
 441
 442 inline ex symmetrize_cyclic(const ex & thisex, const lst & l)
 443 { return thisex.symmetrize_cyclic(l); }
 444
 445 inline ex op(const ex & thisex, int i)
 446 { return thisex.op(i); }
 447
 448 inline ex lhs(const ex & thisex)
 449 { return thisex.lhs(); }
 450
 451 inline ex rhs(const ex & thisex)
 452 { return thisex.rhs(); }
 453
 454 inline bool is_zero(const ex & thisex)
 455 { return thisex.is_zero(); }
 456
 457 inline void swap(ex & e1, ex & e2)
 458 { e1.swap(e2); }
 459
 460
 461 /* Function objects for STL sort() etc. */
 462 struct ex_is_less : public std::binary_function<ex, ex, bool> {
 463         bool operator() (const ex &lh, const ex &rh) const { return lh.compare(rh) < 0; }
 464 };
 465
 466 struct ex_is_equal : public std::binary_function<ex, ex, bool> {
 467         bool operator() (const ex &lh, const ex &rh) const { return lh.is_equal(rh); }
 468 };
 469
 470 struct ex_swap : public std::binary_function<ex, ex, void> {
 471         void operator() (ex &lh, ex &rh) const { lh.swap(rh); }
 472 };
 473
 474
 475 /* Convert function pointer to function object suitable for map(). */
 476 class pointer_to_map_function : public map_function {
 477 protected:
 478         ex (*ptr)(const ex &);
 479 public:
 480         explicit pointer_to_map_function(ex (*x)(const ex &)) : ptr(x) {}
 481         ex operator()(const ex & e) { return ptr(e); }
 482 };
 483
 484 template<class T1>
 485 class pointer_to_map_function_1arg : public map_function {
 486 protected:
 487         ex (*ptr)(const ex &, T1);
 488         T1 arg1;
 489 public:
 490         explicit pointer_to_map_function_1arg(ex (*x)(const ex &, T1), T1 a1) : ptr(x), arg1(a1) {}
 491         ex operator()(const ex & e) { return ptr(e, arg1); }
 492 };
 493
 494 template<class T1, class T2>
 495 class pointer_to_map_function_2args : public map_function {
 496 protected:
 497         ex (*ptr)(const ex &, T1, T2);
 498         T1 arg1;
 499         T2 arg2;
 500 public:
 501         explicit pointer_to_map_function_2args(ex (*x)(const ex &, T1, T2), T1 a1, T2 a2) : ptr(x), arg1(a1), arg2(a2) {}
 502         ex operator()(const ex & e) { return ptr(e, arg1, arg2); }
 503 };
 504
 505 template<class T1, class T2, class T3>
 506 class pointer_to_map_function_3args : public map_function {
 507 protected:
 508         ex (*ptr)(const ex &, T1, T2, T3);
 509         T1 arg1;
 510         T2 arg2;
 511         T3 arg3;
 512 public:
 513         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) {}
 514         ex operator()(const ex & e) { return ptr(e, arg1, arg2, arg3); }
 515 };
 516
 517 inline ex ex::map(ex (*f)(const ex & e)) const
 518 {
 519         pointer_to_map_function fcn(f);
 520         return bp->map(fcn);
 521 }
 522
 523
 524 } // namespace GiNaC
 525
 526 #endif // ndef __GINAC_EX_H__