1449b63537f8b985496f7bc6ed076e284f1447b9
[ginac.git] / 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 "basic.h"
27 #include "operators.h"
28
29 namespace GiNaC {
30
31 // Sorry, this is the only constant to pollute the global scope, the other ones
32 // are defined in utils.h and not visible from outside.
33 class ex;
34 extern const ex & _ex0(void);     ///<  single ex(numeric(0))
35
36 class symbol;
37 class lst;
38 class scalar_products;
39
40 /** Lightweight wrapper for GiNaC's symbolic objects.  Basically all it does is
41  *  to hold a pointer to the other objects, manage the reference counting and
42  *  provide methods for manipulation of these objects.  (Some people call such
43  *  a thing a proxy class.) */
44 class ex
45 {
46         friend class basic;
47         
48 // member functions
49         
50         // default ctor, dtor, copy ctor assignment operator and helpers
51 public:
52         ex();
53         ~ex();
54         ex(const ex & other);
55         ex & operator=(const ex & other);
56         // other ctors
57 public:
58         ex(const basic & other);
59         ex(int i);
60         ex(unsigned int i);
61         ex(long i);
62         ex(unsigned long i);
63         ex(double const d);
64         /** Construct ex from string and a list of symbols. The input grammar is
65          *  similar to the GiNaC output format. All symbols to be used in the
66          *  expression must be specified in a lst in the second argument. Undefined
67          *  symbols and other parser errors will throw an exception. */
68         ex(const std::string &s, const ex &l);
69         
70         // functions overriding virtual functions from bases classes
71         // none
72         
73         // new virtual functions which can be overridden by derived classes
74         // none
75
76         // non-virtual functions in this class
77 public:
78         void swap(ex & other);
79         void print(const print_context & c, unsigned level = 0) const;
80         void printtree(std::ostream & os) const;
81         void dbgprint(void) const;
82         void dbgprinttree(void) const;
83         bool info(unsigned inf) const { return bp->info(inf); }
84         unsigned nops() const { return bp->nops(); }
85         ex expand(unsigned options=0) const;
86         bool has(const ex & other) const { return bp->has(other); }
87         int degree(const ex & s) const { return bp->degree(s); }
88         int ldegree(const ex & s) const { return bp->ldegree(s); }
89         ex coeff(const ex & s, int n = 1) const { return bp->coeff(s, n); }
90         ex lcoeff(const ex & s) const { return coeff(s, degree(s)); }
91         ex tcoeff(const ex & s) const { return coeff(s, ldegree(s)); }
92         ex numer(void) const;
93         ex denom(void) const;
94         ex unit(const symbol &x) const;
95         ex content(const symbol &x) const;
96         numeric integer_content(void) const;
97         ex primpart(const symbol &x) const;
98         ex primpart(const symbol &x, const ex &cont) const;
99         ex normal(int level = 0) const;
100         ex to_rational(lst &repl_lst) const;
101         ex smod(const numeric &xi) const;
102         numeric max_coefficient(void) const;
103         ex collect(const ex & s, bool distributed = false) const { return bp->collect(s, distributed); }
104         ex eval(int level = 0) const { return bp->eval(level); }
105         ex evalf(int level = 0) const { return bp->evalf(level); }
106         ex diff(const symbol & s, unsigned nth = 1) const;
107         ex series(const ex & r, int order, unsigned options = 0) const;
108         bool match(const ex & pattern, lst & repl_lst) const { return bp->match(pattern, repl_lst); }
109         ex subs(const lst & ls, const lst & lr, bool no_pattern = false) const { return bp->subs(ls, lr, no_pattern); }
110         ex subs(const ex & e, bool no_pattern = false) const { return bp->subs(e, no_pattern); }
111         exvector get_free_indices(void) const { return bp->get_free_indices(); }
112         ex simplify_indexed(void) const;
113         ex simplify_indexed(const scalar_products & sp) const;
114         ex simplify_ncmul(const exvector & v) const { return bp->simplify_ncmul(v); }
115         ex operator[](const ex & index) const;
116         ex operator[](int i) const;
117         ex op(int i) const { return bp->op(i); }
118         ex & let_op(int i);
119         ex lhs(void) const;
120         ex rhs(void) const;
121         int compare(const ex & other) const;
122         bool is_equal(const ex & other) const;
123         bool is_zero(void) const { return is_equal(_ex0()); }
124         
125         unsigned return_type(void) const { return bp->return_type(); }
126         unsigned return_type_tinfo(void) const { return bp->return_type_tinfo(); }
127         unsigned gethash(void) const { return bp->gethash(); }
128 private:
129         void construct_from_basic(const basic & other);
130         void construct_from_int(int i);
131         void construct_from_uint(unsigned int i);
132         void construct_from_long(long i);
133         void construct_from_ulong(unsigned long i);
134         void construct_from_double(double d);
135         void construct_from_string_and_lst(const std::string &s, const ex &l);
136         void makewriteable();
137
138 #ifdef OBSCURE_CINT_HACK
139 public:
140         static bool last_created_or_assigned_bp_can_be_converted_to_ex(void)
141         {
142                 if (last_created_or_assigned_bp==0) return false;
143                 if ((last_created_or_assigned_bp->flags &
144                          status_flags::dynallocated)==0) return false;
145                 if ((last_created_or_assigned_bp->flags &
146                          status_flags::evaluated)==0) return false;
147                 return true;
148         }
149 protected:
150         void update_last_created_or_assigned_bp(void)
151         {
152                 if (last_created_or_assigned_bp!=0) {
153                         if (--last_created_or_assigned_bp->refcount == 0) {
154                                 delete last_created_or_assigned_bp;
155                         }
156                 }
157                 last_created_or_assigned_bp = bp;
158                 ++last_created_or_assigned_bp->refcount;
159                 last_created_or_assigned_exp = (long)(void *)(this);
160         }
161 #endif // def OBSCURE_CINT_HACK
162
163 // member variables
164
165 public:
166         basic *bp;      ///< pointer to basic object managed by this
167 #ifdef OBSCURE_CINT_HACK
168         static basic * last_created_or_assigned_bp;
169         static basic * dummy_bp;
170         static long last_created_or_assigned_exp;
171 #endif // def OBSCURE_CINT_HACK
172 };
173
174
175 // performance-critical inlined method implementations
176
177 inline
178 ex::ex() : bp(_ex0().bp)
179 {
180         /*debugmsg("ex default ctor",LOGLEVEL_CONSTRUCT);*/
181         GINAC_ASSERT(_ex0().bp!=0);
182         GINAC_ASSERT(_ex0().bp->flags & status_flags::dynallocated);
183         GINAC_ASSERT(bp!=0);
184         ++bp->refcount;
185 #ifdef OBSCURE_CINT_HACK
186         update_last_created_or_assigned_bp();
187 #endif // def OBSCURE_CINT_HACK
188 }
189
190 inline
191 ex::~ex()
192 {
193         /*debugmsg("ex dtor",LOGLEVEL_DESTRUCT);*/
194         GINAC_ASSERT(bp!=0);
195         GINAC_ASSERT(bp->flags & status_flags::dynallocated);
196         if (--bp->refcount == 0)
197                 delete bp;
198 }
199
200 inline
201 ex::ex(const ex & other) : bp(other.bp)
202 {
203         /*debugmsg("ex copy ctor",LOGLEVEL_CONSTRUCT);*/
204         GINAC_ASSERT(bp!=0);
205         GINAC_ASSERT((bp->flags) & status_flags::dynallocated);
206         ++bp->refcount;
207 #ifdef OBSCURE_CINT_HACK
208         update_last_created_or_assigned_bp();
209 #endif // def OBSCURE_CINT_HACK
210 }
211
212 inline
213 ex & ex::operator=(const ex & other)
214 {
215         /*debugmsg("ex operator=",LOGLEVEL_ASSIGNMENT);*/
216         GINAC_ASSERT(bp!=0);
217         GINAC_ASSERT(bp->flags & status_flags::dynallocated);
218         GINAC_ASSERT(other.bp!=0);
219         GINAC_ASSERT(other.bp->flags & status_flags::dynallocated);
220         // NB: must first increment other.bp->refcount, since other might be *this.
221         ++other.bp->refcount;
222         if (--bp->refcount==0)
223                 delete bp;
224         bp = other.bp;
225 #ifdef OBSCURE_CINT_HACK
226         update_last_created_or_assigned_bp();
227 #endif // def OBSCURE_CINT_HACK
228         return *this;
229 }
230
231 inline
232 ex::ex(const basic & other)
233 {
234         /*debugmsg("ex ctor from basic",LOGLEVEL_CONSTRUCT);*/
235         construct_from_basic(other);
236 #ifdef OBSCURE_CINT_HACK
237         update_last_created_or_assigned_bp();
238 #endif // def OBSCURE_CINT_HACK
239 }
240
241 inline
242 ex::ex(int i)
243 {
244         /*debugmsg("ex ctor from int",LOGLEVEL_CONSTRUCT);*/
245         construct_from_int(i);
246 #ifdef OBSCURE_CINT_HACK
247         update_last_created_or_assigned_bp();
248 #endif // def OBSCURE_CINT_HACK
249 }
250
251 inline
252 ex::ex(unsigned int i)
253 {
254         /*debugmsg("ex ctor from unsigned int",LOGLEVEL_CONSTRUCT);*/
255         construct_from_uint(i);
256 #ifdef OBSCURE_CINT_HACK
257         update_last_created_or_assigned_bp();
258 #endif // def OBSCURE_CINT_HACK
259 }
260
261 inline
262 ex::ex(long i)
263 {
264         /*debugmsg("ex ctor from long",LOGLEVEL_CONSTRUCT);*/
265         construct_from_long(i);
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(unsigned long i)
273 {
274         /*debugmsg("ex ctor from unsigned long",LOGLEVEL_CONSTRUCT);*/
275         construct_from_ulong(i);
276 #ifdef OBSCURE_CINT_HACK
277         update_last_created_or_assigned_bp();
278 #endif // def OBSCURE_CINT_HACK
279 }
280
281 inline
282 ex::ex(double const d)
283 {
284         /*debugmsg("ex ctor from double",LOGLEVEL_CONSTRUCT);*/
285         construct_from_double(d);
286 #ifdef OBSCURE_CINT_HACK
287         update_last_created_or_assigned_bp();
288 #endif // def OBSCURE_CINT_HACK
289 }
290
291 inline
292 ex::ex(const std::string &s, const ex &l)
293 {
294         /*debugmsg("ex ctor from string,lst",LOGLEVEL_CONSTRUCT);*/
295         construct_from_string_and_lst(s, l);
296 #ifdef OBSCURE_CINT_HACK
297         update_last_created_or_assigned_bp();
298 #endif // def OBSCURE_CINT_HACK
299 }
300
301 inline
302 int ex::compare(const ex & other) const
303 {
304         GINAC_ASSERT(bp!=0);
305         GINAC_ASSERT(other.bp!=0);
306         if (bp==other.bp)  // trivial case: both expressions point to same basic
307                 return 0;
308         return bp->compare(*other.bp);
309 }
310
311 inline
312 bool ex::is_equal(const ex & other) const
313 {
314         GINAC_ASSERT(bp!=0);
315         GINAC_ASSERT(other.bp!=0);
316         if (bp==other.bp)  // trivial case: both expressions point to same basic
317                 return true;
318         return bp->is_equal(*other.bp);
319 }
320
321
322 // utility functions
323 inline bool are_ex_trivially_equal(const ex &e1, const ex &e2)
324 {
325         return e1.bp == e2.bp;
326 }
327
328 // wrapper functions around member functions
329 inline unsigned nops(const ex & thisex)
330 { return thisex.nops(); }
331
332 inline ex expand(const ex & thisex, unsigned options = 0)
333 { return thisex.expand(options); }
334
335 inline bool has(const ex & thisex, const ex & other)
336 { return thisex.has(other); }
337
338 inline int degree(const ex & thisex, const ex & s)
339 { return thisex.degree(s); }
340
341 inline int ldegree(const ex & thisex, const ex & s)
342 { return thisex.ldegree(s); }
343
344 inline ex coeff(const ex & thisex, const ex & s, int n=1)
345 { return thisex.coeff(s, n); }
346
347 inline ex numer(const ex & thisex)
348 { return thisex.numer(); }
349
350 inline ex denom(const ex & thisex)
351 { return thisex.denom(); }
352
353 inline ex normal(const ex & thisex, int level=0)
354 { return thisex.normal(level); }
355
356 inline ex to_rational(const ex & thisex, lst & repl_lst)
357 { return thisex.to_rational(repl_lst); }
358
359 inline ex collect(const ex & thisex, const ex & s, bool distributed = false)
360 { return thisex.collect(s, distributed); }
361
362 inline ex eval(const ex & thisex, int level = 0)
363 { return thisex.eval(level); }
364
365 inline ex evalf(const ex & thisex, int level = 0)
366 { return thisex.evalf(level); }
367
368 inline ex diff(const ex & thisex, const symbol & s, unsigned nth = 1)
369 { return thisex.diff(s, nth); }
370
371 inline ex series(const ex & thisex, const ex & r, int order, unsigned options = 0)
372 { return thisex.series(r, order, options); }
373
374 inline bool match(const ex & thisex, const ex & pattern, lst & repl_lst)
375 { return thisex.match(pattern, repl_lst); }
376
377 inline ex subs(const ex & thisex, const ex & e)
378 { return thisex.subs(e); }
379
380 inline ex subs(const ex & thisex, const lst & ls, const lst & lr)
381 { return thisex.subs(ls, lr); }
382
383 inline ex op(const ex & thisex, int i)
384 { return thisex.op(i); }
385
386 inline ex lhs(const ex & thisex)
387 { return thisex.lhs(); }
388
389 inline ex rhs(const ex & thisex)
390 { return thisex.rhs(); }
391
392 inline bool is_zero(const ex & thisex)
393 { return thisex.is_zero(); }
394
395 inline void swap(ex & e1, ex & e2)
396 { e1.swap(e2); }
397
398 } // namespace GiNaC
399
400 #endif // ndef __GINAC_EX_H__