- added numer_denom() to get numerator and denominator in one pass
[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 numer_denom(void) const;
95         ex unit(const symbol &x) const;
96         ex content(const symbol &x) const;
97         numeric integer_content(void) const;
98         ex primpart(const symbol &x) const;
99         ex primpart(const symbol &x, const ex &cont) const;
100         ex normal(int level = 0) const;
101         ex to_rational(lst &repl_lst) const;
102         ex smod(const numeric &xi) const;
103         numeric max_coefficient(void) const;
104         ex collect(const ex & s, bool distributed = false) const { return bp->collect(s, distributed); }
105         ex eval(int level = 0) const { return bp->eval(level); }
106         ex evalf(int level = 0) const { return bp->evalf(level); }
107         ex diff(const symbol & s, unsigned nth = 1) const;
108         ex series(const ex & r, int order, unsigned options = 0) const;
109         bool match(const ex & pattern) const;
110         bool match(const ex & pattern, lst & repl_lst) const { return bp->match(pattern, repl_lst); }
111         ex subs(const lst & ls, const lst & lr, bool no_pattern = false) const { return bp->subs(ls, lr, no_pattern); }
112         ex subs(const ex & e, bool no_pattern = false) const { return bp->subs(e, no_pattern); }
113         exvector get_free_indices(void) const { return bp->get_free_indices(); }
114         ex simplify_indexed(void) const;
115         ex simplify_indexed(const scalar_products & sp) const;
116         ex symmetrize(void) const;
117         ex symmetrize(const lst & l) const;
118         ex antisymmetrize(void) const;
119         ex antisymmetrize(const lst & l) const;
120         ex simplify_ncmul(const exvector & v) const { return bp->simplify_ncmul(v); }
121         ex operator[](const ex & index) const;
122         ex operator[](int i) const;
123         ex op(int i) const { return bp->op(i); }
124         ex & let_op(int i);
125         ex lhs(void) const;
126         ex rhs(void) const;
127         int compare(const ex & other) const;
128         bool is_equal(const ex & other) const;
129         bool is_zero(void) const { return is_equal(_ex0()); }
130         
131         unsigned return_type(void) const { return bp->return_type(); }
132         unsigned return_type_tinfo(void) const { return bp->return_type_tinfo(); }
133         unsigned gethash(void) const { return bp->gethash(); }
134 private:
135         void construct_from_basic(const basic & other);
136         void construct_from_int(int i);
137         void construct_from_uint(unsigned int i);
138         void construct_from_long(long i);
139         void construct_from_ulong(unsigned long i);
140         void construct_from_double(double d);
141         void construct_from_string_and_lst(const std::string &s, const ex &l);
142         void makewriteable();
143
144 #ifdef OBSCURE_CINT_HACK
145 public:
146         static bool last_created_or_assigned_bp_can_be_converted_to_ex(void)
147         {
148                 if (last_created_or_assigned_bp==0) return false;
149                 if ((last_created_or_assigned_bp->flags &
150                          status_flags::dynallocated)==0) return false;
151                 if ((last_created_or_assigned_bp->flags &
152                          status_flags::evaluated)==0) return false;
153                 return true;
154         }
155 protected:
156         void update_last_created_or_assigned_bp(void)
157         {
158                 if (last_created_or_assigned_bp!=0) {
159                         if (--last_created_or_assigned_bp->refcount == 0) {
160                                 delete last_created_or_assigned_bp;
161                         }
162                 }
163                 last_created_or_assigned_bp = bp;
164                 ++last_created_or_assigned_bp->refcount;
165                 last_created_or_assigned_exp = (long)(void *)(this);
166         }
167 #endif // def OBSCURE_CINT_HACK
168
169 // member variables
170
171 public:
172         basic *bp;      ///< pointer to basic object managed by this
173 #ifdef OBSCURE_CINT_HACK
174         static basic * last_created_or_assigned_bp;
175         static basic * dummy_bp;
176         static long last_created_or_assigned_exp;
177 #endif // def OBSCURE_CINT_HACK
178 };
179
180
181 // performance-critical inlined method implementations
182
183 inline
184 ex::ex() : bp(_ex0().bp)
185 {
186         /*debugmsg("ex default ctor",LOGLEVEL_CONSTRUCT);*/
187         GINAC_ASSERT(_ex0().bp!=0);
188         GINAC_ASSERT(_ex0().bp->flags & status_flags::dynallocated);
189         GINAC_ASSERT(bp!=0);
190         ++bp->refcount;
191 #ifdef OBSCURE_CINT_HACK
192         update_last_created_or_assigned_bp();
193 #endif // def OBSCURE_CINT_HACK
194 }
195
196 inline
197 ex::~ex()
198 {
199         /*debugmsg("ex dtor",LOGLEVEL_DESTRUCT);*/
200         GINAC_ASSERT(bp!=0);
201         GINAC_ASSERT(bp->flags & status_flags::dynallocated);
202         if (--bp->refcount == 0)
203                 delete bp;
204 }
205
206 inline
207 ex::ex(const ex & other) : bp(other.bp)
208 {
209         /*debugmsg("ex copy ctor",LOGLEVEL_CONSTRUCT);*/
210         GINAC_ASSERT(bp!=0);
211         GINAC_ASSERT((bp->flags) & status_flags::dynallocated);
212         ++bp->refcount;
213 #ifdef OBSCURE_CINT_HACK
214         update_last_created_or_assigned_bp();
215 #endif // def OBSCURE_CINT_HACK
216 }
217
218 inline
219 ex & ex::operator=(const ex & other)
220 {
221         /*debugmsg("ex operator=",LOGLEVEL_ASSIGNMENT);*/
222         GINAC_ASSERT(bp!=0);
223         GINAC_ASSERT(bp->flags & status_flags::dynallocated);
224         GINAC_ASSERT(other.bp!=0);
225         GINAC_ASSERT(other.bp->flags & status_flags::dynallocated);
226         // NB: must first increment other.bp->refcount, since other might be *this.
227         ++other.bp->refcount;
228         if (--bp->refcount==0)
229                 delete bp;
230         bp = other.bp;
231 #ifdef OBSCURE_CINT_HACK
232         update_last_created_or_assigned_bp();
233 #endif // def OBSCURE_CINT_HACK
234         return *this;
235 }
236
237 inline
238 ex::ex(const basic & other)
239 {
240         /*debugmsg("ex ctor from basic",LOGLEVEL_CONSTRUCT);*/
241         construct_from_basic(other);
242 #ifdef OBSCURE_CINT_HACK
243         update_last_created_or_assigned_bp();
244 #endif // def OBSCURE_CINT_HACK
245 }
246
247 inline
248 ex::ex(int i)
249 {
250         /*debugmsg("ex ctor from int",LOGLEVEL_CONSTRUCT);*/
251         construct_from_int(i);
252 #ifdef OBSCURE_CINT_HACK
253         update_last_created_or_assigned_bp();
254 #endif // def OBSCURE_CINT_HACK
255 }
256
257 inline
258 ex::ex(unsigned int i)
259 {
260         /*debugmsg("ex ctor from unsigned int",LOGLEVEL_CONSTRUCT);*/
261         construct_from_uint(i);
262 #ifdef OBSCURE_CINT_HACK
263         update_last_created_or_assigned_bp();
264 #endif // def OBSCURE_CINT_HACK
265 }
266
267 inline
268 ex::ex(long i)
269 {
270         /*debugmsg("ex ctor from long",LOGLEVEL_CONSTRUCT);*/
271         construct_from_long(i);
272 #ifdef OBSCURE_CINT_HACK
273         update_last_created_or_assigned_bp();
274 #endif // def OBSCURE_CINT_HACK
275 }
276
277 inline
278 ex::ex(unsigned long i)
279 {
280         /*debugmsg("ex ctor from unsigned long",LOGLEVEL_CONSTRUCT);*/
281         construct_from_ulong(i);
282 #ifdef OBSCURE_CINT_HACK
283         update_last_created_or_assigned_bp();
284 #endif // def OBSCURE_CINT_HACK
285 }
286
287 inline
288 ex::ex(double const d)
289 {
290         /*debugmsg("ex ctor from double",LOGLEVEL_CONSTRUCT);*/
291         construct_from_double(d);
292 #ifdef OBSCURE_CINT_HACK
293         update_last_created_or_assigned_bp();
294 #endif // def OBSCURE_CINT_HACK
295 }
296
297 inline
298 ex::ex(const std::string &s, const ex &l)
299 {
300         /*debugmsg("ex ctor from string,lst",LOGLEVEL_CONSTRUCT);*/
301         construct_from_string_and_lst(s, l);
302 #ifdef OBSCURE_CINT_HACK
303         update_last_created_or_assigned_bp();
304 #endif // def OBSCURE_CINT_HACK
305 }
306
307 inline
308 int ex::compare(const ex & other) const
309 {
310         GINAC_ASSERT(bp!=0);
311         GINAC_ASSERT(other.bp!=0);
312         if (bp==other.bp)  // trivial case: both expressions point to same basic
313                 return 0;
314         return bp->compare(*other.bp);
315 }
316
317 inline
318 bool ex::is_equal(const ex & other) const
319 {
320         GINAC_ASSERT(bp!=0);
321         GINAC_ASSERT(other.bp!=0);
322         if (bp==other.bp)  // trivial case: both expressions point to same basic
323                 return true;
324         return bp->is_equal(*other.bp);
325 }
326
327
328 // utility functions
329 inline bool are_ex_trivially_equal(const ex &e1, const ex &e2)
330 {
331         return e1.bp == e2.bp;
332 }
333
334 // wrapper functions around member functions
335 inline unsigned nops(const ex & thisex)
336 { return thisex.nops(); }
337
338 inline ex expand(const ex & thisex, unsigned options = 0)
339 { return thisex.expand(options); }
340
341 inline bool has(const ex & thisex, const ex & other)
342 { return thisex.has(other); }
343
344 inline int degree(const ex & thisex, const ex & s)
345 { return thisex.degree(s); }
346
347 inline int ldegree(const ex & thisex, const ex & s)
348 { return thisex.ldegree(s); }
349
350 inline ex coeff(const ex & thisex, const ex & s, int n=1)
351 { return thisex.coeff(s, n); }
352
353 inline ex numer(const ex & thisex)
354 { return thisex.numer(); }
355
356 inline ex denom(const ex & thisex)
357 { return thisex.denom(); }
358
359 inline ex numer_denom(const ex & thisex)
360 { return thisex.numer_denom(); }
361
362 inline ex normal(const ex & thisex, int level=0)
363 { return thisex.normal(level); }
364
365 inline ex to_rational(const ex & thisex, lst & repl_lst)
366 { return thisex.to_rational(repl_lst); }
367
368 inline ex collect(const ex & thisex, const ex & s, bool distributed = false)
369 { return thisex.collect(s, distributed); }
370
371 inline ex eval(const ex & thisex, int level = 0)
372 { return thisex.eval(level); }
373
374 inline ex evalf(const ex & thisex, int level = 0)
375 { return thisex.evalf(level); }
376
377 inline ex diff(const ex & thisex, const symbol & s, unsigned nth = 1)
378 { return thisex.diff(s, nth); }
379
380 inline ex series(const ex & thisex, const ex & r, int order, unsigned options = 0)
381 { return thisex.series(r, order, options); }
382
383 inline bool match(const ex & thisex, const ex & pattern, lst & repl_lst)
384 { return thisex.match(pattern, repl_lst); }
385
386 inline ex subs(const ex & thisex, const ex & e)
387 { return thisex.subs(e); }
388
389 inline ex subs(const ex & thisex, const lst & ls, const lst & lr)
390 { return thisex.subs(ls, lr); }
391
392 inline ex simplify_indexed(const ex & thisex)
393 { return thisex.simplify_indexed(); }
394
395 inline ex simplify_indexed(const ex & thisex, const scalar_products & sp)
396 { return thisex.simplify_indexed(sp); }
397
398 inline ex symmetrize(const ex & thisex)
399 { return thisex.symmetrize(); }
400
401 inline ex symmetrize(const ex & thisex, const lst & l)
402 { return thisex.symmetrize(l); }
403
404 inline ex antisymmetrize(const ex & thisex)
405 { return thisex.antisymmetrize(); }
406
407 inline ex antisymmetrize(const ex & thisex, const lst & l)
408 { return thisex.antisymmetrize(l); }
409
410 inline ex op(const ex & thisex, int i)
411 { return thisex.op(i); }
412
413 inline ex lhs(const ex & thisex)
414 { return thisex.lhs(); }
415
416 inline ex rhs(const ex & thisex)
417 { return thisex.rhs(); }
418
419 inline bool is_zero(const ex & thisex)
420 { return thisex.is_zero(); }
421
422 inline void swap(ex & e1, ex & e2)
423 { e1.swap(e2); }
424
425 } // namespace GiNaC
426
427 #endif // ndef __GINAC_EX_H__