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     // other constructors
 127 public:
 128     ex(const basic & other)
 129 #ifdef INLINE_EX_CONSTRUCTORS
 130         {
 131             construct_from_basic(other);
 132 #ifdef OBSCURE_CINT_HACK
 133             update_last_created_or_assigned_bp();
 134 #endif // def OBSCURE_CINT_HACK
 135         }
 136 #else
 137 ;
 138 #endif // def INLINE_EX_CONSTRUCTORS
 139
 140     ex(int i)
 141 #ifdef INLINE_EX_CONSTRUCTORS
 142         {
 143             construct_from_int(i);
 144 #ifdef OBSCURE_CINT_HACK
 145             update_last_created_or_assigned_bp();
 146 #endif // def OBSCURE_CINT_HACK
 147         }
 148 #else
 149 ;
 150 #endif // def INLINE_EX_CONSTRUCTORS
 151
 152     ex(unsigned int i)
 153 #ifdef INLINE_EX_CONSTRUCTORS
 154         {
 155             construct_from_uint(i);
 156 #ifdef OBSCURE_CINT_HACK
 157             update_last_created_or_assigned_bp();
 158 #endif // def OBSCURE_CINT_HACK
 159         }
 160 #else
 161 ;
 162 #endif // def INLINE_EX_CONSTRUCTORS
 163
 164     ex(long i)
 165 #ifdef INLINE_EX_CONSTRUCTORS
 166         {
 167             construct_from_long(i);
 168 #ifdef OBSCURE_CINT_HACK
 169             update_last_created_or_assigned_bp();
 170 #endif // def OBSCURE_CINT_HACK
 171         }
 172 #else
 173 ;
 174 #endif // def INLINE_EX_CONSTRUCTORS
 175
 176     ex(unsigned long i)
 177 #ifdef INLINE_EX_CONSTRUCTORS
 178         {
 179             construct_from_ulong(i);
 180 #ifdef OBSCURE_CINT_HACK
 181             update_last_created_or_assigned_bp();
 182 #endif // def OBSCURE_CINT_HACK
 183         }
 184 #else
 185 ;
 186 #endif // def INLINE_EX_CONSTRUCTORS
 187
 188     ex(double const d)
 189 #ifdef INLINE_EX_CONSTRUCTORS
 190         {
 191             construct_from_double(d);
 192 #ifdef OBSCURE_CINT_HACK
 193             update_last_created_or_assigned_bp();
 194 #endif // def OBSCURE_CINT_HACK
 195         }
 196 #else
 197 ;
 198 #endif // def INLINE_EX_CONSTRUCTORS
 199
 200
 201     // functions overriding virtual functions from bases classes
 202     // none
 203
 204     // new virtual functions which can be overridden by derived classes
 205     // none
 206
 207     // non-virtual functions in this class
 208 public:
 209     void swap(ex & other);
 210     void printraw(ostream & os) const;
 211     void printtree(ostream & os, unsigned indent=0) const;
 212     void print(ostream & os, unsigned upper_precedence=0) const;
 213     void printcsrc(ostream & os, unsigned type, const char *var_name) const;
 214     void dbgprint(void) const;
 215     void dbgprinttree(void) const;
 216     bool info(unsigned inf) const;
 217     unsigned nops() const;
 218     ex expand(unsigned options=0) const;
 219     bool has(const ex & other) const;
 220     int degree(const symbol & s) const;
 221     int ldegree(const symbol & s) const;
 222     ex coeff(const symbol & s, int n=1) const;
 223     ex lcoeff(const symbol & s) const { return coeff(s, degree(s)); }
 224     ex tcoeff(const symbol & s) const { return coeff(s, ldegree(s)); }
 225     ex numer(bool normalize = true) const;
 226     ex denom(bool normalize = true) const;
 227     ex unit(const symbol &x) const;
 228     ex content(const symbol &x) const;
 229     numeric integer_content(void) const;
 230     ex primpart(const symbol &x) const;
 231     ex primpart(const symbol &x, const ex &cont) const;
 232     ex normal(int level = 0) const;
 233     ex smod(const numeric &xi) const;
 234     numeric max_coefficient(void) const;
 235     ex collect(const symbol & s) const;
 236     ex eval(int level = 0) const;
 237     ex evalf(int level = 0) const;
 238     ex diff(const symbol & s, unsigned nth = 1) const;
 239     ex series(const symbol & s, const ex & point, int order = 6) const;
 240     ex subs(const lst & ls, const lst & lr) const;
 241     ex subs(const ex & e) const;
 242     exvector get_indices(void) const;
 243     ex simplify_ncmul(const exvector & v) const;
 244     ex operator[](const ex & index) const;
 245     ex operator[](int i) const;
 246     ex op(int i) const;
 247     ex & let_op(int i);
 248     int compare(const ex & other) const
 249 #ifdef INLINE_EX_CONSTRUCTORS
 250         {
 251             GINAC_ASSERT(bp!=0);
 252             GINAC_ASSERT(other.bp!=0);
 253             if (bp==other.bp) {
 254                 // special case: both expression point to same basic, trivially equal
 255                 return 0;
 256             }
 257             return bp->compare(*other.bp);
 258         }
 259 #else
 260 ;
 261 #endif // def INLINE_EX_CONSTRUCTORS
 262     bool is_equal(const ex & other) const
 263 #ifdef INLINE_EX_CONSTRUCTORS
 264         {
 265             GINAC_ASSERT(bp!=0);
 266             GINAC_ASSERT(other.bp!=0);
 267             if (bp==other.bp) {
 268                 // special case: both expression point to same basic, trivially equal
 269                 return true;
 270             }
 271             return bp->is_equal(*other.bp);
 272         }
 273 #else
 274 ;
 275 #endif // def INLINE_EX_CONSTRUCTORS
 276     bool is_zero(void) const {return compare(_ex0())==0;};
 277
 278     unsigned return_type(void) const;
 279     unsigned return_type_tinfo(void) const;
 280     unsigned gethash(void) const;
 281
 282     ex exadd(const ex & rh) const;
 283     ex exmul(const ex & rh) const;
 284     ex exncmul(const ex & rh) const;
 285 private:
 286     void construct_from_basic(const basic & other);
 287     void construct_from_int(int i);
 288     void construct_from_uint(unsigned int i);
 289     void construct_from_long(long i);
 290     void construct_from_ulong(unsigned long i);
 291     void construct_from_double(double d);
 292     void makewriteable();
 293
 294 #ifdef OBSCURE_CINT_HACK
 295 public:
 296     static bool last_created_or_assigned_bp_can_be_converted_to_ex(void)
 297         {
 298             if (last_created_or_assigned_bp==0) return false;
 299             if ((last_created_or_assigned_bp->flags &
 300                  status_flags::dynallocated)==0) return false;
 301             if ((last_created_or_assigned_bp->flags &
 302                  status_flags::evaluated)==0) return false;
 303             return true;
 304         }
 305 protected:
 306     void update_last_created_or_assigned_bp(void)
 307         {
 308             if (last_created_or_assigned_bp!=0) {
 309                 if (--last_created_or_assigned_bp->refcount == 0) {
 310                     delete last_created_or_assigned_bp;
 311                 }
 312             }
 313             last_created_or_assigned_bp=bp;
 314             ++last_created_or_assigned_bp->refcount;
 315         }
 316 #endif // def OBSCURE_CINT_HACK
 317
 318 // member variables
 319
 320 public:
 321     basic *bp;
 322 #ifdef OBSCURE_CINT_HACK
 323     static basic *last_created_or_assigned_bp;
 324 #endif // def OBSCURE_CINT_HACK
 325 };
 326
 327 // utility functions
 328 inline bool are_ex_trivially_equal(const ex &e1, const ex &e2)
 329 {
 330         return e1.bp == e2.bp;
 331 }
 332
 333 // wrapper functions around member functions
 334 inline unsigned nops(const ex & thisex)
 335 { return thisex.nops(); }
 336
 337 inline ex expand(const ex & thisex, unsigned options = 0)
 338 { return thisex.expand(options); }
 339
 340 inline bool has(const ex & thisex, const ex & other)
 341 { return thisex.has(other); }
 342
 343 inline int degree(const ex & thisex, const symbol & s)
 344 { return thisex.degree(s); }
 345
 346 inline int ldegree(const ex & thisex, const symbol & s)
 347 { return thisex.ldegree(s); }
 348
 349 inline ex coeff(const ex & thisex, const symbol & s, int n=1)
 350 { return thisex.coeff(s, n); }
 351
 352 inline ex numer(const ex & thisex, bool normalize = true)
 353 { return thisex.numer(normalize); }
 354
 355 inline ex denom(const ex & thisex, bool normalize = true)
 356 { return thisex.denom(normalize); }
 357
 358 inline ex normal(const ex & thisex, int level=0)
 359 { return thisex.normal(level); }
 360
 361 inline ex collect(const ex & thisex, const symbol & s)
 362 { return thisex.collect(s); }
 363
 364 inline ex eval(const ex & thisex, int level = 0)
 365 { return thisex.eval(level); }
 366
 367 inline ex evalf(const ex & thisex, int level = 0)
 368 { return thisex.evalf(level); }
 369
 370 inline ex diff(const ex & thisex, const symbol & s, unsigned nth = 1)
 371 { return thisex.diff(s, nth); }
 372
 373 inline ex series(const ex & thisex, const symbol & s, const ex & point, int order = 6)
 374 { return thisex.series(s, point, order); }
 375
 376 inline ex subs(const ex & thisex, const ex & e)
 377 { return thisex.subs(e); }
 378
 379 inline ex subs(const ex & thisex, const lst & ls, const lst & lr)
 380 { return thisex.subs(ls, lr); }
 381
 382 inline void swap(ex & e1, ex & e2)
 383 { e1.swap(e2); }
 384
 385 #ifndef NO_NAMESPACE_GINAC
 386 } // namespace GiNaC
 387 #endif // ndef NO_NAMESPACE_GINAC
 388
 389 #endif // ndef __GINAC_EX_H__
 390