ginac/ex.h

   1 /** @file ex.h
   2  *
   3  *  Interface to GiNaC's light-weight expression handles. */
   4
   5 /*
   6  *  GiNaC Copyright (C) 1999-2000 Johannes Gutenberg University Mainz, Germany
   7  *
   8  *  This program is free software; you can redistribute it and/or modify
   9  *  it under the terms of the GNU General Public License as published by
  10  *  the Free Software Foundation; either version 2 of the License, or
  11  *  (at your option) any later version.
  12  *
  13  *  This program is distributed in the hope that it will be useful,
  14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  *  GNU General Public License for more details.
  17  *
  18  *  You should have received a copy of the GNU General Public License
  19  *  along with this program; if not, write to the Free Software
  20  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 #ifndef __GINAC_EX_H__
  24 #define __GINAC_EX_H__
  25
  26 #include <iostream>
  27 #include "basic.h"
  28 #include "operators.h"
  29
  30 #ifndef NO_NAMESPACE_GINAC
  31 namespace GiNaC {
  32 #endif // ndef NO_NAMESPACE_GINAC
  33
  34 class ex;
  35 class expand_options;
  36 class status_flags;
  37
  38 class symbol;
  39 class lst;
  40
  41 // Sorry, this is the only constant to pollute the global scope, the other ones
  42 // are defined in utils.h and not visible from outside.
  43 extern const ex & _ex0(void);     //  single ex(numeric(0))
  44
  45 // typedef vector<ex> exvector;
  46
  47 #define INLINE_EX_CONSTRUCTORS
  48
  49 /** Lightweight wrapper for GiNaC's symbolic objects.  Basically all it does is
  50  *  to hold a pointer to the other objects, manage the reference counting and
  51  *  provide methods for manipulation of these objects. */
  52 class ex
  53 {
  54     friend class basic;
  55
  56 // member functions
  57
  58     // default constructor, destructor, copy constructor assignment operator and helpers
  59 public:
  60     ex()
  61 #ifdef INLINE_EX_CONSTRUCTORS
  62     : bp(_ex0().bp)
  63         {
  64             GINAC_ASSERT(_ex0().bp!=0);
  65             GINAC_ASSERT(_ex0().bp->flags & status_flags::dynallocated);
  66             GINAC_ASSERT(bp!=0);
  67             ++bp->refcount;
  68 #ifdef OBSCURE_CINT_HACK
  69             update_last_created_or_assigned_bp();
  70 #endif // def OBSCURE_CINT_HACK
  71         }
  72 #else
  73 ;
  74 #endif // def INLINE_EX_CONSTRUCTORS
  75
  76     ~ex()
  77 #ifdef INLINE_EX_CONSTRUCTORS
  78         {
  79             GINAC_ASSERT(bp!=0);
  80             GINAC_ASSERT(bp->flags & status_flags::dynallocated);
  81             if (--bp->refcount == 0) {
  82                 delete bp;
  83             }
  84         }
  85 #else
  86 ;
  87 #endif // def INLINE_EX_CONSTRUCTORS
  88
  89     ex(const ex & other)
  90 #ifdef INLINE_EX_CONSTRUCTORS
  91     : bp(other.bp)
  92         {
  93             GINAC_ASSERT(bp!=0);
  94             GINAC_ASSERT((bp->flags) & status_flags::dynallocated);
  95             ++bp->refcount;
  96 #ifdef OBSCURE_CINT_HACK
  97             update_last_created_or_assigned_bp();
  98 #endif // def OBSCURE_CINT_HACK
  99         }
 100 #else
 101 ;
 102 #endif // def INLINE_EX_CONSTRUCTORS
 103
 104     const ex & operator=(const ex & other)
 105 #ifdef INLINE_EX_CONSTRUCTORS
 106         {
 107             GINAC_ASSERT(bp!=0);
 108             GINAC_ASSERT(bp->flags & status_flags::dynallocated);
 109             GINAC_ASSERT(other.bp!=0);
 110             GINAC_ASSERT(other.bp->flags & status_flags::dynallocated);
 111             ++other.bp->refcount;
 112             basic * tmpbp=other.bp;
 113             if (--bp->refcount==0) {
 114                 delete bp;
 115             }
 116             bp=tmpbp;
 117 #ifdef OBSCURE_CINT_HACK
 118             update_last_created_or_assigned_bp();
 119 #endif // def OBSCURE_CINT_HACK
 120             return *this;
 121         }
 122 #else
 123 ;
 124 #endif // def INLINE_EX_CONSTRUCTORS
 125
 126 #ifdef CINT_CONVERSION_WORKAROUND
 127     // workaround to fix the missing automatic derived->basic->ex conversion
 128     const ex & operator=(const basic & other)
 129         {
 130             return *this=ex(other);
 131         }
 132 #endif // def CINT_CONVERSION_WORKAROUND
 133
 134     // other constructors
 135 public:
 136     ex(const basic & other)
 137 #ifdef INLINE_EX_CONSTRUCTORS
 138         {
 139             construct_from_basic(other);
 140 #ifdef OBSCURE_CINT_HACK
 141             update_last_created_or_assigned_bp();
 142 #endif // def OBSCURE_CINT_HACK
 143         }
 144 #else
 145 ;
 146 #endif // def INLINE_EX_CONSTRUCTORS
 147
 148     ex(int i)
 149 #ifdef INLINE_EX_CONSTRUCTORS
 150         {
 151             construct_from_int(i);
 152 #ifdef OBSCURE_CINT_HACK
 153             update_last_created_or_assigned_bp();
 154 #endif // def OBSCURE_CINT_HACK
 155         }
 156 #else
 157 ;
 158 #endif // def INLINE_EX_CONSTRUCTORS
 159
 160     ex(unsigned int i)
 161 #ifdef INLINE_EX_CONSTRUCTORS
 162         {
 163             construct_from_uint(i);
 164 #ifdef OBSCURE_CINT_HACK
 165             update_last_created_or_assigned_bp();
 166 #endif // def OBSCURE_CINT_HACK
 167         }
 168 #else
 169 ;
 170 #endif // def INLINE_EX_CONSTRUCTORS
 171
 172     ex(long i)
 173 #ifdef INLINE_EX_CONSTRUCTORS
 174         {
 175             construct_from_long(i);
 176 #ifdef OBSCURE_CINT_HACK
 177             update_last_created_or_assigned_bp();
 178 #endif // def OBSCURE_CINT_HACK
 179         }
 180 #else
 181 ;
 182 #endif // def INLINE_EX_CONSTRUCTORS
 183
 184     ex(unsigned long i)
 185 #ifdef INLINE_EX_CONSTRUCTORS
 186         {
 187             construct_from_ulong(i);
 188 #ifdef OBSCURE_CINT_HACK
 189             update_last_created_or_assigned_bp();
 190 #endif // def OBSCURE_CINT_HACK
 191         }
 192 #else
 193 ;
 194 #endif // def INLINE_EX_CONSTRUCTORS
 195
 196     ex(double const d)
 197 #ifdef INLINE_EX_CONSTRUCTORS
 198         {
 199             construct_from_double(d);
 200 #ifdef OBSCURE_CINT_HACK
 201             update_last_created_or_assigned_bp();
 202 #endif // def OBSCURE_CINT_HACK
 203         }
 204 #else
 205 ;
 206 #endif // def INLINE_EX_CONSTRUCTORS
 207
 208     /** Construct ex from string and a list of symbols. The input grammar is
 209      *  similar to the GiNaC output format. All symbols to be used in the
 210      *  expression must be specified in a lst in the second argument. Undefined
 211      *  symbols and other parser errors will throw an exception. */
 212     ex(const string &s, const ex &l)
 213 #ifdef INLINE_EX_CONSTRUCTORS
 214         {
 215             construct_from_string_and_lst(s, l);
 216 #ifdef OBSCURE_CINT_HACK
 217             update_last_created_or_assigned_bp();
 218 #endif // def OBSCURE_CINT_HACK
 219         }
 220 #else
 221 ;
 222 #endif // def INLINE_EX_CONSTRUCTORS
 223
 224
 225     // functions overriding virtual functions from bases classes
 226     // none
 227
 228     // new virtual functions which can be overridden by derived classes
 229     // none
 230
 231     // non-virtual functions in this class
 232 public:
 233     void swap(ex & other);
 234     void printraw(ostream & os) const;
 235     void printtree(ostream & os, unsigned indent=0) const;
 236     void print(ostream & os, unsigned upper_precedence=0) const;
 237     void printcsrc(ostream & os, unsigned type, const char *var_name) const;
 238     void dbgprint(void) const;
 239     void dbgprinttree(void) const;
 240     bool info(unsigned inf) const;
 241     unsigned nops() const;
 242     ex expand(unsigned options=0) const;
 243     bool has(const ex & other) const;
 244 #ifdef CINT_CONVERSION_WORKAROUND
 245     bool has(basic const & other) const { return has(ex(other)); }
 246 #endif // def CINT_CONVERSION_WORKAROUND
 247     int degree(const symbol & s) const;
 248     int ldegree(const symbol & s) const;
 249     ex coeff(const symbol & s, int n=1) const;
 250     ex lcoeff(const symbol & s) const { return coeff(s, degree(s)); }
 251     ex tcoeff(const symbol & s) const { return coeff(s, ldegree(s)); }
 252     ex numer(void) const;
 253     ex denom(void) const;
 254     ex unit(const symbol &x) const;
 255     ex content(const symbol &x) const;
 256     numeric integer_content(void) const;
 257     ex primpart(const symbol &x) const;
 258     ex primpart(const symbol &x, const ex &cont) const;
 259 #ifdef CINT_CONVERSION_WORKAROUND
 260     ex primpart(const symbol &x, const basic &cont) const { return primpart(x,ex(cont)); }
 261 #endif // def CINT_CONVERSION_WORKAROUND
 262     ex normal(int level = 0) const;
 263     ex smod(const numeric &xi) const;
 264     numeric max_coefficient(void) const;
 265     ex collect(const symbol & s) const;
 266     ex eval(int level = 0) const;
 267     ex evalf(int level = 0) const;
 268     ex diff(const symbol & s, unsigned nth = 1) const;
 269     ex series(const ex & r, int order) const;
 270 #ifdef CINT_CONVERSION_WORKAROUND
 271     ex series(const basic & r, int order) const { return series(ex(r),order); }
 272 #endif // def CINT_CONVERSION_WORKAROUND
 273     ex subs(const lst & ls, const lst & lr) const;
 274     ex subs(const ex & e) const;
 275 #ifdef CINT_CONVERSION_WORKAROUND
 276     ex subs(const basic & e) const { return subs(ex(e)); }
 277 #endif // def CINT_CONVERSION_WORKAROUND
 278     exvector get_indices(void) const;
 279     ex simplify_ncmul(const exvector & v) const;
 280     ex operator[](const ex & index) const;
 281 #ifdef CINT_CONVERSION_WORKAROUND
 282     ex operator[](const basic & index) const { return operator[](ex(index)); }
 283 #endif // def CINT_CONVERSION_WORKAROUND
 284     ex operator[](int i) const;
 285     ex op(int i) const;
 286     ex & let_op(int i);
 287     ex lhs(void) const;
 288     ex rhs(void) const;
 289     int compare(const ex & other) const
 290 #ifdef INLINE_EX_CONSTRUCTORS
 291         {
 292             GINAC_ASSERT(bp!=0);
 293             GINAC_ASSERT(other.bp!=0);
 294             if (bp==other.bp) {
 295                 // special case: both expression point to same basic, trivially equal
 296                 return 0;
 297             }
 298             return bp->compare(*other.bp);
 299         }
 300 #else
 301 ;
 302 #endif // def INLINE_EX_CONSTRUCTORS
 303 #ifdef CINT_CONVERSION_WORKAROUND
 304     int compare(const basic & other) const { return compare(ex(other)); }
 305 #endif // def CINT_CONVERSION_WORKAROUND
 306     bool is_equal(const ex & other) const
 307 #ifdef INLINE_EX_CONSTRUCTORS
 308         {
 309             GINAC_ASSERT(bp!=0);
 310             GINAC_ASSERT(other.bp!=0);
 311             if (bp==other.bp) {
 312                 // special case: both expression point to same basic, trivially equal
 313                 return true;
 314             }
 315             return bp->is_equal(*other.bp);
 316         }
 317 #else
 318 ;
 319 #endif // def INLINE_EX_CONSTRUCTORS
 320 #ifdef CINT_CONVERSION_WORKAROUND
 321     bool is_equal(const basic & other) const { return is_equal(ex(other)); }
 322 #endif // def CINT_CONVERSION_WORKAROUND
 323     bool is_zero(void) const {return compare(_ex0())==0;};
 324
 325     unsigned return_type(void) const;
 326     unsigned return_type_tinfo(void) const;
 327     unsigned gethash(void) const;
 328
 329     ex exadd(const ex & rh) const;
 330 #ifdef CINT_CONVERSION_WORKAROUND
 331     ex exadd(const basic & rh) const { return exadd(ex(rh)); }
 332 #endif // def CINT_CONVERSION_WORKAROUND
 333     ex exmul(const ex & rh) const;
 334 #ifdef CINT_CONVERSION_WORKAROUND
 335     ex exmul(const basic & rh) const { return exmul(ex(rh)); }
 336 #endif // def CINT_CONVERSION_WORKAROUND
 337     ex exncmul(const ex & rh) const;
 338 #ifdef CINT_CONVERSION_WORKAROUND
 339     ex exncmul(const basic & rh) const { return exncmul(ex(rh)); }
 340 #endif // def CINT_CONVERSION_WORKAROUND
 341 private:
 342     void construct_from_basic(const basic & other);
 343     void construct_from_int(int i);
 344     void construct_from_uint(unsigned int i);
 345     void construct_from_long(long i);
 346     void construct_from_ulong(unsigned long i);
 347     void construct_from_double(double d);
 348     void construct_from_string_and_lst(const string &s, const ex &l);
 349     void makewriteable();
 350
 351 #ifdef OBSCURE_CINT_HACK
 352 public:
 353     static bool last_created_or_assigned_bp_can_be_converted_to_ex(void)
 354         {
 355             if (last_created_or_assigned_bp==0) return false;
 356             if ((last_created_or_assigned_bp->flags &
 357                  status_flags::dynallocated)==0) return false;
 358             if ((last_created_or_assigned_bp->flags &
 359                  status_flags::evaluated)==0) return false;
 360             return true;
 361         }
 362 protected:
 363     void update_last_created_or_assigned_bp(void)
 364         {
 365             if (last_created_or_assigned_bp!=0) {
 366                 if (--last_created_or_assigned_bp->refcount == 0) {
 367                     delete last_created_or_assigned_bp;
 368                 }
 369             }
 370             last_created_or_assigned_bp=bp;
 371             ++last_created_or_assigned_bp->refcount;
 372             last_created_or_assigned_exp=(long)(void *)(this);
 373         }
 374 #endif // def OBSCURE_CINT_HACK
 375
 376 // member variables
 377
 378 public:
 379     basic *bp;
 380 #ifdef OBSCURE_CINT_HACK
 381     static basic * last_created_or_assigned_bp;
 382     static basic * dummy_bp;
 383     static long last_created_or_assigned_exp;
 384 #endif // def OBSCURE_CINT_HACK
 385 };
 386
 387 // utility functions
 388 inline bool are_ex_trivially_equal(const ex &e1, const ex &e2)
 389 {
 390         return e1.bp == e2.bp;
 391 }
 392
 393 // wrapper functions around member functions
 394 inline unsigned nops(const ex & thisex)
 395 { return thisex.nops(); }
 396
 397 inline ex expand(const ex & thisex, unsigned options = 0)
 398 { return thisex.expand(options); }
 399
 400 inline bool has(const ex & thisex, const ex & other)
 401 { return thisex.has(other); }
 402
 403 inline int degree(const ex & thisex, const symbol & s)
 404 { return thisex.degree(s); }
 405
 406 inline int ldegree(const ex & thisex, const symbol & s)
 407 { return thisex.ldegree(s); }
 408
 409 inline ex coeff(const ex & thisex, const symbol & s, int n=1)
 410 { return thisex.coeff(s, n); }
 411
 412 inline ex numer(const ex & thisex)
 413 { return thisex.numer(); }
 414
 415 inline ex denom(const ex & thisex)
 416 { return thisex.denom(); }
 417
 418 inline ex normal(const ex & thisex, int level=0)
 419 { return thisex.normal(level); }
 420
 421 inline ex collect(const ex & thisex, const symbol & s)
 422 { return thisex.collect(s); }
 423
 424 inline ex eval(const ex & thisex, int level = 0)
 425 { return thisex.eval(level); }
 426
 427 inline ex evalf(const ex & thisex, int level = 0)
 428 { return thisex.evalf(level); }
 429
 430 inline ex diff(const ex & thisex, const symbol & s, unsigned nth = 1)
 431 { return thisex.diff(s, nth); }
 432
 433 inline ex series(const ex & thisex, const ex & r, int order)
 434 { return thisex.series(r, order); }
 435
 436 inline ex subs(const ex & thisex, const ex & e)
 437 { return thisex.subs(e); }
 438
 439 inline ex subs(const ex & thisex, const lst & ls, const lst & lr)
 440 { return thisex.subs(ls, lr); }
 441
 442 inline ex op(const ex & thisex, int i)
 443 { return thisex.op(i); }
 444
 445 inline ex lhs(const ex & thisex)
 446 { return thisex.lhs(); }
 447
 448 inline ex rhs(const ex & thisex)
 449 { return thisex.rhs(); }
 450
 451 inline bool is_zero(const ex & thisex)
 452 { return thisex.is_zero(); }
 453
 454 inline void swap(ex & e1, ex & e2)
 455 { e1.swap(e2); }
 456
 457 #ifndef NO_NAMESPACE_GINAC
 458 } // namespace GiNaC
 459 #endif // ndef NO_NAMESPACE_GINAC
 460
 461 #endif // ndef __GINAC_EX_H__
 462