the input parser now handles (simple) indexed objects; the indices to be used
[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-2002 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 <iosfwd>
27 #include <functional>
28
29 #include "basic.h"
30 #include "operators.h"
31
32 namespace GiNaC {
33
34 /** Helper class to initialize the library.  There must be one static object
35  *  of this class in every object file that makes use of our flyweights in
36  *  order to guarantee proper initialization.  Hence we put it into this
37  *  file which is included by every relevant file anyways.  This is modeled
38  *  after section 27.4.2.1.6 of the C++ standard, where cout and friends are
39  *  set up.
40  *
41  *  @see utils.cpp */
42 class library_init {
43 public:
44         library_init();
45         ~library_init();
46 private:
47         static int count;
48 };
49 /** For construction of flyweights, etc. */
50 static library_init library_initializer;
51
52 // Current versions of Cint don't link data declared extern within functions.
53 // FIXME: Fix Cint and later remove this from here.
54 #if defined(G__CINTVERSION)
55 extern const class numeric *_num0_p;
56 #endif
57
58
59 class symbol;
60 class lst;
61 class scalar_products;
62
63
64 /** Lightweight wrapper for GiNaC's symbolic objects.  Basically all it does is
65  *  to hold a pointer to the other objects, manage the reference counting and
66  *  provide methods for manipulation of these objects.  (Some people call such
67  *  a thing a proxy class.) */
68 class ex
69 {
70         friend class archive_node;
71         friend bool are_ex_trivially_equal(const ex &, const ex &);
72         template<class T> friend const T &ex_to(const ex &);
73         template<class T> friend bool is_a(const ex &);
74         template<class T> friend bool is_exactly_a(const ex &);
75         
76 // member functions
77         
78         // default ctor, dtor, copy ctor, assignment operator and helpers
79 public:
80         ex();
81         ~ex();
82         ex(const ex & other);
83         ex & operator=(const ex & other);
84         // other ctors
85 public:
86         ex(const basic & other);
87         ex(int i);
88         ex(unsigned int i);
89         ex(long i);
90         ex(unsigned long i);
91         ex(double const d);
92
93         /** Construct ex from string and a list of symbols. The input grammar is
94          *  similar to the GiNaC output format. All symbols and indices to be used
95          *  in the expression must be specified in a lst in the second argument.
96          *  Undefined symbols and other parser errors will throw an exception. */
97         ex(const std::string &s, const ex &l);
98         
99         // non-virtual functions in this class
100 public:
101         /** Efficiently swap the contents of two expressions. */
102         void swap(ex & other)
103         {
104                 GINAC_ASSERT(bp!=0);
105                 GINAC_ASSERT(bp->flags & status_flags::dynallocated);
106                 GINAC_ASSERT(other.bp!=0);
107                 GINAC_ASSERT(other.bp->flags & status_flags::dynallocated);
108         
109                 basic * tmpbp = bp;
110                 bp = other.bp;
111                 other.bp = tmpbp;
112         }
113
114         void print(const print_context & c, unsigned level = 0) const;
115         void printtree(std::ostream & os) const;
116         void dbgprint(void) const;
117         void dbgprinttree(void) const;
118         bool info(unsigned inf) const { return bp->info(inf); }
119         unsigned nops() const { return bp->nops(); }
120         ex expand(unsigned options=0) const;
121         bool has(const ex & pattern) const { return bp->has(pattern); }
122         ex map(map_function & f) const { return bp->map(f); }
123         ex map(ex (*f)(const ex & e)) const;
124         bool find(const ex & pattern, lst & found) const;
125         int degree(const ex & s) const { return bp->degree(s); }
126         int ldegree(const ex & s) const { return bp->ldegree(s); }
127         ex coeff(const ex & s, int n = 1) const { return bp->coeff(s, n); }
128         ex lcoeff(const ex & s) const { return coeff(s, degree(s)); }
129         ex tcoeff(const ex & s) const { return coeff(s, ldegree(s)); }
130         ex numer(void) const;
131         ex denom(void) const;
132         ex numer_denom(void) const;
133         ex unit(const symbol &x) const;
134         ex content(const symbol &x) const;
135         numeric integer_content(void) const;
136         ex primpart(const symbol &x) const;
137         ex primpart(const symbol &x, const ex &cont) const;
138         ex normal(int level = 0) const;
139         ex to_rational(lst &repl_lst) const { return bp->to_rational(repl_lst); }
140         ex smod(const numeric &xi) const { return bp->smod(xi); }
141         numeric max_coefficient(void) const;
142         ex collect(const ex & s, bool distributed = false) const { return bp->collect(s, distributed); }
143         ex eval(int level = 0) const { return bp->eval(level); }
144         ex evalf(int level = 0) const { return bp->evalf(level); }
145         ex evalm(void) const { return bp->evalm(); }
146         ex diff(const symbol & s, unsigned nth = 1) const;
147         ex series(const ex & r, int order, unsigned options = 0) const;
148         bool match(const ex & pattern) const;
149         bool match(const ex & pattern, lst & repl_lst) const { return bp->match(pattern, repl_lst); }
150         ex subs(const lst & ls, const lst & lr, bool no_pattern = false) const { return bp->subs(ls, lr, no_pattern); }
151         ex subs(const ex & e, bool no_pattern = false) const { return bp->subs(e, no_pattern); }
152         exvector get_free_indices(void) const { return bp->get_free_indices(); }
153         ex simplify_indexed(void) const;
154         ex simplify_indexed(const scalar_products & sp) const;
155         ex symmetrize(void) const;
156         ex symmetrize(const lst & l) const;
157         ex antisymmetrize(void) const;
158         ex antisymmetrize(const lst & l) const;
159         ex symmetrize_cyclic(void) const;
160         ex symmetrize_cyclic(const lst & l) const;
161         ex simplify_ncmul(const exvector & v) const { return bp->simplify_ncmul(v); }
162         ex operator[](const ex & index) const;
163         ex operator[](int i) const;
164         ex op(int i) const { return bp->op(i); }
165         ex & let_op(int i);
166         ex lhs(void) const;
167         ex rhs(void) const;
168         int compare(const ex & other) const;
169         bool is_equal(const ex & other) const;
170         bool is_zero(void) const { extern const ex _ex0; return is_equal(_ex0); }
171         
172         unsigned return_type(void) const { return bp->return_type(); }
173         unsigned return_type_tinfo(void) const { return bp->return_type_tinfo(); }
174         unsigned gethash(void) const { return bp->gethash(); }
175 private:
176         void construct_from_basic(const basic & other);
177         void construct_from_int(int i);
178         void construct_from_uint(unsigned int i);
179         void construct_from_long(long i);
180         void construct_from_ulong(unsigned long i);
181         void construct_from_double(double d);
182         void construct_from_string_and_lst(const std::string &s, const ex &l);
183         void makewriteable();
184
185 #ifdef OBSCURE_CINT_HACK
186 public:
187         static bool last_created_or_assigned_bp_can_be_converted_to_ex(void)
188         {
189                 if (last_created_or_assigned_bp==0) return false;
190                 if ((last_created_or_assigned_bp->flags &
191                          status_flags::dynallocated)==0) return false;
192                 if ((last_created_or_assigned_bp->flags &
193                          status_flags::evaluated)==0) return false;
194                 return true;
195         }
196 protected:
197         void update_last_created_or_assigned_bp(void)
198         {
199                 if (last_created_or_assigned_bp!=0) {
200                         if (--last_created_or_assigned_bp->refcount == 0) {
201                                 delete last_created_or_assigned_bp;
202                         }
203                 }
204                 last_created_or_assigned_bp = bp;
205                 ++last_created_or_assigned_bp->refcount;
206                 last_created_or_assigned_exp = (long)(void *)(this);
207         }
208 #endif // def OBSCURE_CINT_HACK
209
210 // member variables
211
212 public:
213         basic *bp;      ///< pointer to basic object managed by this, direct manipulation deprecated
214 #ifdef OBSCURE_CINT_HACK
215         static basic * last_created_or_assigned_bp;
216         static basic * dummy_bp;
217         static long last_created_or_assigned_exp;
218 #endif // def OBSCURE_CINT_HACK
219 };
220
221
222 // performance-critical inlined method implementations
223
224 inline
225 ex::ex()
226 {
227         extern const class numeric *_num0_p;
228         bp = (basic*)_num0_p;
229         GINAC_ASSERT(bp!=0);
230         GINAC_ASSERT(bp->flags & status_flags::dynallocated);
231         ++bp->refcount;
232 #ifdef OBSCURE_CINT_HACK
233         update_last_created_or_assigned_bp();
234 #endif // def OBSCURE_CINT_HACK
235 }
236
237 inline
238 ex::~ex()
239 {
240         GINAC_ASSERT(bp!=0);
241         GINAC_ASSERT(bp->flags & status_flags::dynallocated);
242         if (--bp->refcount == 0)
243                 delete bp;
244 }
245
246 inline
247 ex::ex(const ex & other) : bp(other.bp)
248 {
249         GINAC_ASSERT(bp!=0);
250         GINAC_ASSERT((bp->flags) & status_flags::dynallocated);
251         ++bp->refcount;
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::operator=(const ex & other)
259 {
260         GINAC_ASSERT(bp!=0);
261         GINAC_ASSERT(bp->flags & status_flags::dynallocated);
262         GINAC_ASSERT(other.bp!=0);
263         GINAC_ASSERT(other.bp->flags & status_flags::dynallocated);
264         // NB: must first increment other.bp->refcount, since other might be *this.
265         ++other.bp->refcount;
266         if (--bp->refcount==0)
267                 delete bp;
268         bp = other.bp;
269 #ifdef OBSCURE_CINT_HACK
270         update_last_created_or_assigned_bp();
271 #endif // def OBSCURE_CINT_HACK
272         return *this;
273 }
274
275 inline
276 ex::ex(const basic & other)
277 {
278         construct_from_basic(other);
279 #ifdef OBSCURE_CINT_HACK
280         update_last_created_or_assigned_bp();
281 #endif // def OBSCURE_CINT_HACK
282 }
283
284 inline
285 ex::ex(int i)
286 {
287         construct_from_int(i);
288 #ifdef OBSCURE_CINT_HACK
289         update_last_created_or_assigned_bp();
290 #endif // def OBSCURE_CINT_HACK
291 }
292
293 inline
294 ex::ex(unsigned int i)
295 {
296         construct_from_uint(i);
297 #ifdef OBSCURE_CINT_HACK
298         update_last_created_or_assigned_bp();
299 #endif // def OBSCURE_CINT_HACK
300 }
301
302 inline
303 ex::ex(long i)
304 {
305         construct_from_long(i);
306 #ifdef OBSCURE_CINT_HACK
307         update_last_created_or_assigned_bp();
308 #endif // def OBSCURE_CINT_HACK
309 }
310
311 inline
312 ex::ex(unsigned long i)
313 {
314         construct_from_ulong(i);
315 #ifdef OBSCURE_CINT_HACK
316         update_last_created_or_assigned_bp();
317 #endif // def OBSCURE_CINT_HACK
318 }
319
320 inline
321 ex::ex(double const d)
322 {
323         construct_from_double(d);
324 #ifdef OBSCURE_CINT_HACK
325         update_last_created_or_assigned_bp();
326 #endif // def OBSCURE_CINT_HACK
327 }
328
329 inline
330 ex::ex(const std::string &s, const ex &l)
331 {
332         construct_from_string_and_lst(s, l);
333 #ifdef OBSCURE_CINT_HACK
334         update_last_created_or_assigned_bp();
335 #endif // def OBSCURE_CINT_HACK
336 }
337
338 inline
339 int ex::compare(const ex & other) const
340 {
341         GINAC_ASSERT(bp!=0);
342         GINAC_ASSERT(other.bp!=0);
343         if (bp==other.bp)  // trivial case: both expressions point to same basic
344                 return 0;
345         return bp->compare(*other.bp);
346 }
347
348 inline
349 bool ex::is_equal(const ex & other) const
350 {
351         GINAC_ASSERT(bp!=0);
352         GINAC_ASSERT(other.bp!=0);
353         if (bp==other.bp)  // trivial case: both expressions point to same basic
354                 return true;
355         return bp->is_equal(*other.bp);
356 }
357
358
359 // utility functions
360
361 /** Compare two objects of class quickly without doing a deep tree traversal.
362  *  @return "true" if they are equal
363  *          "false" if equality cannot be established quickly (e1 and e2 may
364  *          still be equal, in this case. */
365 inline bool are_ex_trivially_equal(const ex &e1, const ex &e2)
366 {
367         return e1.bp == e2.bp;
368 }
369
370 // wrapper functions around member functions
371 inline unsigned nops(const ex & thisex)
372 { return thisex.nops(); }
373
374 inline ex expand(const ex & thisex, unsigned options = 0)
375 { return thisex.expand(options); }
376
377 inline bool has(const ex & thisex, const ex & pattern)
378 { return thisex.has(pattern); }
379
380 inline bool find(const ex & thisex, const ex & pattern, lst & found)
381 { return thisex.find(pattern, found); }
382
383 inline int degree(const ex & thisex, const ex & s)
384 { return thisex.degree(s); }
385
386 inline int ldegree(const ex & thisex, const ex & s)
387 { return thisex.ldegree(s); }
388
389 inline ex coeff(const ex & thisex, const ex & s, int n=1)
390 { return thisex.coeff(s, n); }
391
392 inline ex numer(const ex & thisex)
393 { return thisex.numer(); }
394
395 inline ex denom(const ex & thisex)
396 { return thisex.denom(); }
397
398 inline ex numer_denom(const ex & thisex)
399 { return thisex.numer_denom(); }
400
401 inline ex normal(const ex & thisex, int level=0)
402 { return thisex.normal(level); }
403
404 inline ex to_rational(const ex & thisex, lst & repl_lst)
405 { return thisex.to_rational(repl_lst); }
406
407 inline ex collect(const ex & thisex, const ex & s, bool distributed = false)
408 { return thisex.collect(s, distributed); }
409
410 inline ex eval(const ex & thisex, int level = 0)
411 { return thisex.eval(level); }
412
413 inline ex evalf(const ex & thisex, int level = 0)
414 { return thisex.evalf(level); }
415
416 inline ex evalm(const ex & thisex)
417 { return thisex.evalm(); }
418
419 inline ex diff(const ex & thisex, const symbol & s, unsigned nth = 1)
420 { return thisex.diff(s, nth); }
421
422 inline ex series(const ex & thisex, const ex & r, int order, unsigned options = 0)
423 { return thisex.series(r, order, options); }
424
425 inline bool match(const ex & thisex, const ex & pattern, lst & repl_lst)
426 { return thisex.match(pattern, repl_lst); }
427
428 inline ex subs(const ex & thisex, const ex & e)
429 { return thisex.subs(e); }
430
431 inline ex subs(const ex & thisex, const lst & ls, const lst & lr)
432 { return thisex.subs(ls, lr); }
433
434 inline ex simplify_indexed(const ex & thisex)
435 { return thisex.simplify_indexed(); }
436
437 inline ex simplify_indexed(const ex & thisex, const scalar_products & sp)
438 { return thisex.simplify_indexed(sp); }
439
440 inline ex symmetrize(const ex & thisex)
441 { return thisex.symmetrize(); }
442
443 inline ex symmetrize(const ex & thisex, const lst & l)
444 { return thisex.symmetrize(l); }
445
446 inline ex antisymmetrize(const ex & thisex)
447 { return thisex.antisymmetrize(); }
448
449 inline ex antisymmetrize(const ex & thisex, const lst & l)
450 { return thisex.antisymmetrize(l); }
451
452 inline ex symmetrize_cyclic(const ex & thisex)
453 { return thisex.symmetrize_cyclic(); }
454
455 inline ex symmetrize_cyclic(const ex & thisex, const lst & l)
456 { return thisex.symmetrize_cyclic(l); }
457
458 inline ex op(const ex & thisex, int i)
459 { return thisex.op(i); }
460
461 inline ex lhs(const ex & thisex)
462 { return thisex.lhs(); }
463
464 inline ex rhs(const ex & thisex)
465 { return thisex.rhs(); }
466
467 inline bool is_zero(const ex & thisex)
468 { return thisex.is_zero(); }
469
470 inline void swap(ex & e1, ex & e2)
471 { e1.swap(e2); }
472
473 // This makes STL algorithms use the more efficient swap operation for ex objects
474 inline void iter_swap(std::vector<ex>::iterator i1, std::vector<ex>::iterator i2)
475 { i1->swap(*i2); }
476
477
478 /* Function objects for STL sort() etc. */
479 struct ex_is_less : public std::binary_function<ex, ex, bool> {
480         bool operator() (const ex &lh, const ex &rh) const { return lh.compare(rh) < 0; }
481 };
482
483 struct ex_is_equal : public std::binary_function<ex, ex, bool> {
484         bool operator() (const ex &lh, const ex &rh) const { return lh.is_equal(rh); }
485 };
486
487 struct ex_swap : public std::binary_function<ex, ex, void> {
488         void operator() (ex &lh, ex &rh) const { lh.swap(rh); }
489 };
490
491
492 /* Convert function pointer to function object suitable for map(). */
493 class pointer_to_map_function : public map_function {
494 protected:
495         ex (*ptr)(const ex &);
496 public:
497         explicit pointer_to_map_function(ex (*x)(const ex &)) : ptr(x) {}
498         ex operator()(const ex & e) { return ptr(e); }
499 };
500
501 template<class T1>
502 class pointer_to_map_function_1arg : public map_function {
503 protected:
504         ex (*ptr)(const ex &, T1);
505         T1 arg1;
506 public:
507         explicit pointer_to_map_function_1arg(ex (*x)(const ex &, T1), T1 a1) : ptr(x), arg1(a1) {}
508         ex operator()(const ex & e) { return ptr(e, arg1); }
509 };
510
511 template<class T1, class T2>
512 class pointer_to_map_function_2args : public map_function {
513 protected:
514         ex (*ptr)(const ex &, T1, T2);
515         T1 arg1;
516         T2 arg2;
517 public:
518         explicit pointer_to_map_function_2args(ex (*x)(const ex &, T1, T2), T1 a1, T2 a2) : ptr(x), arg1(a1), arg2(a2) {}
519         ex operator()(const ex & e) { return ptr(e, arg1, arg2); }
520 };
521
522 template<class T1, class T2, class T3>
523 class pointer_to_map_function_3args : public map_function {
524 protected:
525         ex (*ptr)(const ex &, T1, T2, T3);
526         T1 arg1;
527         T2 arg2;
528         T3 arg3;
529 public:
530         explicit pointer_to_map_function_3args(ex (*x)(const ex &, T1, T2, T3), T1 a1, T2 a2, T3 a3) : ptr(x), arg1(a1), arg2(a2), arg3(a3) {}
531         ex operator()(const ex & e) { return ptr(e, arg1, arg2, arg3); }
532 };
533
534 inline ex ex::map(ex (*f)(const ex & e)) const
535 {
536         pointer_to_map_function fcn(f);
537         return bp->map(fcn);
538 }
539
540
541 } // namespace GiNaC
542
543 #endif // ndef __GINAC_EX_H__