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