Merge branch 'master' of git://ffmssmsc.jinr.ru:443/varg/ginac
[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-2008 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
21  */
22
23 #ifndef __GINAC_EX_H__
24 #define __GINAC_EX_H__
25
26 #include <iosfwd>
27 #include <iterator>
28 #include <functional>
29 #include <stack>
30
31 #include "basic.h"
32 #include "ptr.h"
33
34 namespace GiNaC {
35
36
37 /** Helper class to initialize the library.  There must be one static object
38  *  of this class in every object file that makes use of our flyweights in
39  *  order to guarantee proper initialization.  Hence we put it into this
40  *  file which is included by every relevant file anyways.  This is modeled
41  *  after section 27.4.2.1.6 of the C++ standard, where cout and friends are
42  *  set up.
43  *
44  *  @see utils.cpp */
45 class library_init {
46 public:
47         library_init();
48         ~library_init();
49 private:
50         static int count;
51 };
52 /** For construction of flyweights, etc. */
53 static library_init library_initializer;
54
55 class scalar_products;
56 class const_iterator;
57 class const_preorder_iterator;
58 class const_postorder_iterator;
59
60
61 /** Lightweight wrapper for GiNaC's symbolic objects.  It holds a pointer to
62  *  the other object in order to do garbage collection by the method of
63  *  reference counting.  I.e., it is a smart pointer.  Also, the constructor
64  *  ex::ex(const basic & other) calls the methods that do automatic
65  *  evaluation.  E.g., x-x turns automatically into 0. */
66 class ex {
67         friend class archive_node;
68         friend inline bool are_ex_trivially_equal(const ex &, const ex &);
69         template<class T> friend inline const T &ex_to(const ex &);
70         template<class T> friend inline bool is_a(const ex &);
71         template<class T> friend inline bool is_exactly_a(const ex &);
72         
73         // default constructor, copy constructor and assignment operator
74 public:
75         ex() throw();
76
77         // other constructors
78 public:
79         ex(const basic & other);
80         ex(int i);
81         ex(unsigned int i);
82         ex(long i);
83         ex(unsigned long i);
84         ex(double const d);
85
86         /** Construct ex from string and a list of symbols. The input grammar is
87          *  similar to the GiNaC output format. All symbols and indices to be used
88          *  in the expression must be specified in a lst in the second argument.
89          *  Undefined symbols and other parser errors will throw an exception. */
90         ex(const std::string &s, const ex &l);
91         
92 public:
93         // non-virtual functions in this class
94 public:
95         /** Efficiently swap the contents of two expressions. */
96         void swap(ex & other) throw()
97         {
98                 GINAC_ASSERT(bp->flags & status_flags::dynallocated);
99                 GINAC_ASSERT(other.bp->flags & status_flags::dynallocated);
100                 bp.swap(other.bp);
101         }
102
103         // iterators
104         const_iterator begin() const throw();
105         const_iterator end() const throw();
106         const_preorder_iterator preorder_begin() const;
107         const_preorder_iterator preorder_end() const throw();
108         const_postorder_iterator postorder_begin() const;
109         const_postorder_iterator postorder_end() const throw();
110
111         // evaluation
112         ex eval(int level = 0) const { return bp->eval(level); }
113         ex evalf(int level = 0) const { return bp->evalf(level); }
114         ex evalm() const { return bp->evalm(); }
115         ex eval_ncmul(const exvector & v) const { return bp->eval_ncmul(v); }
116         ex eval_integ() const { return bp->eval_integ(); }
117
118         // printing
119         void print(const print_context & c, unsigned level = 0) const;
120         void dbgprint() const;
121         void dbgprinttree() const;
122
123         // info
124         bool info(unsigned inf) const { return bp->info(inf); }
125
126         // operand access
127         size_t nops() const { return bp->nops(); }
128         ex op(size_t i) const { return bp->op(i); }
129         ex operator[](const ex & index) const { return (*bp)[index]; }
130         ex operator[](size_t i) const { return (*bp)[i]; }
131         ex & let_op(size_t i);
132         ex & operator[](const ex & index);
133         ex & operator[](size_t i);
134         ex lhs() const;
135         ex rhs() const;
136
137         // function for complex expressions
138         ex conjugate() const { return bp->conjugate(); }
139         ex real_part() const { return bp->real_part(); }
140         ex imag_part() const { return bp->imag_part(); }
141
142         // pattern matching
143         bool has(const ex & pattern, unsigned options = 0) const { return bp->has(pattern, options); }
144         bool find(const ex & pattern, exset& found) const;
145         bool match(const ex & pattern) const;
146         bool match(const ex & pattern, exmap & repls) const { return bp->match(pattern, repls); }
147
148         // substitutions
149         ex subs(const exmap & m, unsigned options = 0) const;
150         ex subs(const lst & ls, const lst & lr, unsigned options = 0) const;
151         ex subs(const ex & e, unsigned options = 0) const;
152
153         // function mapping
154         ex map(map_function & f) const { return bp->map(f); }
155         ex map(ex (*f)(const ex & e)) const;
156
157         // visitors and tree traversal
158         void accept(visitor & v) const { bp->accept(v); }
159         void traverse_preorder(visitor & v) const;
160         void traverse_postorder(visitor & v) const;
161         void traverse(visitor & v) const { traverse_preorder(v); }
162
163         // degree/coeff
164         bool is_polynomial(const ex & vars) const;
165         int degree(const ex & s) const { return bp->degree(s); }
166         int ldegree(const ex & s) const { return bp->ldegree(s); }
167         ex coeff(const ex & s, int n = 1) const { return bp->coeff(s, n); }
168         ex lcoeff(const ex & s) const { return coeff(s, degree(s)); }
169         ex tcoeff(const ex & s) const { return coeff(s, ldegree(s)); }
170
171         // expand/collect
172         ex expand(unsigned options=0) const;
173         ex collect(const ex & s, bool distributed = false) const { return bp->collect(s, distributed); }
174
175         // differentiation and series expansion
176         ex diff(const symbol & s, unsigned nth = 1) const;
177         ex series(const ex & r, int order, unsigned options = 0) const;
178
179         // rational functions
180         ex normal(int level = 0) const;
181         ex to_rational(exmap & repl) const;
182         ex to_rational(lst & repl_lst) const;
183         ex to_polynomial(exmap & repl) const;
184         ex to_polynomial(lst & repl_lst) const;
185         ex numer() const;
186         ex denom() const;
187         ex numer_denom() const;
188
189         // polynomial algorithms
190         ex unit(const ex &x) const;
191         ex content(const ex &x) const;
192         numeric integer_content() const;
193         ex primpart(const ex &x) const;
194         ex primpart(const ex &x, const ex &cont) const;
195         void unitcontprim(const ex &x, ex &u, ex &c, ex &p) const;
196         ex smod(const numeric &xi) const { return bp->smod(xi); }
197         numeric max_coefficient() const;
198
199         // indexed objects
200         exvector get_free_indices() const { return bp->get_free_indices(); }
201         ex simplify_indexed(unsigned options = 0) const;
202         ex simplify_indexed(const scalar_products & sp, unsigned options = 0) const;
203
204         // comparison
205         int compare(const ex & other) const;
206         bool is_equal(const ex & other) const;
207         bool is_zero() const { extern const ex _ex0; return is_equal(_ex0); }
208         bool is_zero_matrix() const;
209         
210         // symmetry
211         ex symmetrize() const;
212         ex symmetrize(const lst & l) const;
213         ex antisymmetrize() const;
214         ex antisymmetrize(const lst & l) const;
215         ex symmetrize_cyclic() const;
216         ex symmetrize_cyclic(const lst & l) const;
217
218         // noncommutativity
219         unsigned return_type() const { return bp->return_type(); }
220         tinfo_t return_type_tinfo() const { return bp->return_type_tinfo(); }
221
222         unsigned gethash() const { return bp->gethash(); }
223
224 private:
225         static ptr<basic> construct_from_basic(const basic & other);
226         static basic & construct_from_int(int i);
227         static basic & construct_from_uint(unsigned int i);
228         static basic & construct_from_long(long i);
229         static basic & construct_from_ulong(unsigned long i);
230         static basic & construct_from_double(double d);
231         static ptr<basic> construct_from_string_and_lst(const std::string &s, const ex &l);
232         void makewriteable();
233         void share(const ex & other) const;
234
235 // member variables
236
237 private:
238         mutable ptr<basic> bp;  ///< pointer to basic object managed by this
239 };
240
241
242 // performance-critical inlined method implementations
243
244 // This needs to be a basic* because we don't know that numeric is derived
245 // from basic and we need a basic& for the ex default constructor
246 extern const basic *_num0_bp;
247
248 inline
249 ex::ex() throw() : bp(*const_cast<basic *>(_num0_bp))
250 {
251         GINAC_ASSERT(bp->flags & status_flags::dynallocated);
252 }
253
254 inline
255 ex::ex(const basic & other) : bp(construct_from_basic(other))
256 {
257         GINAC_ASSERT(bp->flags & status_flags::dynallocated);
258 }
259
260 inline
261 ex::ex(int i) : bp(construct_from_int(i))
262 {
263         GINAC_ASSERT(bp->flags & status_flags::dynallocated);
264 }
265
266 inline
267 ex::ex(unsigned int i) : bp(construct_from_uint(i))
268 {
269         GINAC_ASSERT(bp->flags & status_flags::dynallocated);
270 }
271
272 inline
273 ex::ex(long i) : bp(construct_from_long(i))
274 {
275         GINAC_ASSERT(bp->flags & status_flags::dynallocated);
276 }
277
278 inline
279 ex::ex(unsigned long i) : bp(construct_from_ulong(i))
280 {
281         GINAC_ASSERT(bp->flags & status_flags::dynallocated);
282 }
283
284 inline
285 ex::ex(double const d) : bp(construct_from_double(d))
286 {
287         GINAC_ASSERT(bp->flags & status_flags::dynallocated);
288 }
289
290 inline
291 ex::ex(const std::string &s, const ex &l) : bp(construct_from_string_and_lst(s, l))
292 {
293         GINAC_ASSERT(bp->flags & status_flags::dynallocated);
294 }
295
296 inline
297 int ex::compare(const ex & other) const
298 {
299 #ifdef GINAC_COMPARE_STATISTICS
300         compare_statistics.total_compares++;
301 #endif
302         if (bp == other.bp)  // trivial case: both expressions point to same basic
303                 return 0;
304 #ifdef GINAC_COMPARE_STATISTICS
305         compare_statistics.nontrivial_compares++;
306 #endif
307         const int cmpval = bp->compare(*other.bp);
308 #if 1
309         if (cmpval == 0) {
310                 // Expressions point to different, but equal, trees: conserve
311                 // memory and make subsequent compare() operations faster by
312                 // making both expressions point to the same tree.
313                 share(other);
314         }
315 #endif
316         return cmpval;
317 }
318
319 inline
320 bool ex::is_equal(const ex & other) const
321 {
322 #ifdef GINAC_COMPARE_STATISTICS
323         compare_statistics.total_is_equals++;
324 #endif
325         if (bp == other.bp)  // trivial case: both expressions point to same basic
326                 return true;
327 #ifdef GINAC_COMPARE_STATISTICS
328         compare_statistics.nontrivial_is_equals++;
329 #endif
330         const bool equal = bp->is_equal(*other.bp);
331 #if 0
332         if (equal) {
333                 // Expressions point to different, but equal, trees: conserve
334                 // memory and make subsequent compare() operations faster by
335                 // making both expressions point to the same tree.
336                 share(other);
337         }
338 #endif
339         return equal;
340 }
341
342
343 // Iterators
344
345 class const_iterator : public std::iterator<std::random_access_iterator_tag, ex, ptrdiff_t, const ex *, const ex &> {
346         friend class ex;
347         friend class const_preorder_iterator;
348         friend class const_postorder_iterator;
349
350 public:
351         const_iterator() throw() {}
352
353 private:
354         const_iterator(const ex &e_, size_t i_) throw() : e(e_), i(i_) {}
355
356 public:
357         // This should return an ex&, but that would be a reference to a
358         // temporary value
359         ex operator*() const
360         {
361                 return e.op(i);
362         }
363
364         // This should return an ex*, but that would be a pointer to a
365         // temporary value
366         std::auto_ptr<ex> operator->() const
367         {
368                 return std::auto_ptr<ex>(new ex(operator*()));
369         }
370
371         ex operator[](difference_type n) const
372         {
373                 return e.op(i + n);
374         }
375
376         const_iterator &operator++() throw()
377         {
378                 ++i;
379                 return *this;
380         }
381
382         const_iterator operator++(int) throw()
383         {
384                 const_iterator tmp = *this;
385                 ++i;
386                 return tmp;
387         }
388
389         const_iterator &operator+=(difference_type n) throw()
390         {
391                 i += n;
392                 return *this;
393         }
394
395         const_iterator operator+(difference_type n) const throw()
396         {
397                 return const_iterator(e, i + n);
398         }
399
400         inline friend const_iterator operator+(difference_type n, const const_iterator &it) throw()
401         {
402                 return const_iterator(it.e, it.i + n);
403         }
404
405         const_iterator &operator--() throw()
406         {
407                 --i;
408                 return *this;
409         }
410
411         const_iterator operator--(int) throw()
412         {
413                 const_iterator tmp = *this;
414                 --i;
415                 return tmp;
416         }
417
418         const_iterator &operator-=(difference_type n) throw()
419         {
420                 i -= n;
421                 return *this;
422         }
423
424         const_iterator operator-(difference_type n) const throw()
425         {
426                 return const_iterator(e, i - n);
427         }
428
429         inline friend difference_type operator-(const const_iterator &lhs, const const_iterator &rhs) throw()
430         {
431                 return lhs.i - rhs.i;
432         }
433
434         bool operator==(const const_iterator &other) const throw()
435         {
436                 return are_ex_trivially_equal(e, other.e) && i == other.i;
437         }
438
439         bool operator!=(const const_iterator &other) const throw()
440         {
441                 return !(*this == other);
442         }
443
444         bool operator<(const const_iterator &other) const throw()
445         {
446                 return i < other.i;
447         }
448
449         bool operator>(const const_iterator &other) const throw()
450         {
451                 return other < *this;
452         }
453
454         bool operator<=(const const_iterator &other) const throw()
455         {
456                 return !(other < *this);
457         }
458
459         bool operator>=(const const_iterator &other) const throw()
460         {
461                 return !(*this < other);
462         }
463
464 protected:
465         ex e; // this used to be a "const basic *", but in view of object fusion that wouldn't be safe
466         size_t i;
467 };
468
469 namespace internal {
470
471 struct _iter_rep {
472         _iter_rep(const ex &e_, size_t i_, size_t i_end_) : e(e_), i(i_), i_end(i_end_) {}
473
474         bool operator==(const _iter_rep &other) const throw()
475         {
476                 return are_ex_trivially_equal(e, other.e) && i == other.i;
477         }
478
479         bool operator!=(const _iter_rep &other) const throw()
480         {
481                 return !(*this == other);
482         }
483
484         ex e;
485         size_t i;
486         size_t i_end;
487 };
488
489 } // namespace internal
490
491 class const_preorder_iterator : public std::iterator<std::forward_iterator_tag, ex, ptrdiff_t, const ex *, const ex &> {
492 public:
493         const_preorder_iterator() throw() {}
494
495         const_preorder_iterator(const ex &e, size_t n)
496         {
497                 s.push(internal::_iter_rep(e, 0, n));
498         }
499
500 public:
501         reference operator*() const
502         {
503                 return s.top().e;
504         }
505
506         pointer operator->() const
507         {
508                 return &(s.top().e);
509         }
510
511         const_preorder_iterator &operator++()
512         {
513                 increment();
514                 return *this;
515         }
516
517         const_preorder_iterator operator++(int)
518         {
519                 const_preorder_iterator tmp = *this;
520                 increment();
521                 return tmp;
522         }
523
524         bool operator==(const const_preorder_iterator &other) const throw()
525         {
526                 return s == other.s;
527         }
528
529         bool operator!=(const const_preorder_iterator &other) const throw()
530         {
531                 return !(*this == other);
532         }
533
534 private:
535         std::stack<internal::_iter_rep, std::vector<internal::_iter_rep> > s;
536
537         void increment()
538         {
539                 while (!s.empty() && s.top().i == s.top().i_end) {
540                         s.pop();
541                         if (s.empty())
542                                 return;
543                         ++s.top().i;
544                 }
545
546                 internal::_iter_rep & current = s.top();
547
548                 if (current.i != current.i_end) {
549                         const ex & child = current.e.op(current.i);
550                         s.push(internal::_iter_rep(child, 0, child.nops()));
551                 }
552         }
553 };
554
555 class const_postorder_iterator : public std::iterator<std::forward_iterator_tag, ex, ptrdiff_t, const ex *, const ex &> {
556 public:
557         const_postorder_iterator() throw() {}
558
559         const_postorder_iterator(const ex &e, size_t n)
560         {
561                 s.push(internal::_iter_rep(e, 0, n));
562                 descend();
563         }
564
565 public:
566         reference operator*() const
567         {
568                 return s.top().e;
569         }
570
571         pointer operator->() const
572         {
573                 return &(s.top().e);
574         }
575
576         const_postorder_iterator &operator++()
577         {
578                 increment();
579                 return *this;
580         }
581
582         const_postorder_iterator operator++(int)
583         {
584                 const_postorder_iterator tmp = *this;
585                 increment();
586                 return tmp;
587         }
588
589         bool operator==(const const_postorder_iterator &other) const throw()
590         {
591                 return s == other.s;
592         }
593
594         bool operator!=(const const_postorder_iterator &other) const throw()
595         {
596                 return !(*this == other);
597         }
598
599 private:
600         std::stack<internal::_iter_rep, std::vector<internal::_iter_rep> > s;
601
602         void descend()
603         {
604                 while (s.top().i != s.top().i_end) {
605                         internal::_iter_rep & current = s.top();
606                         const ex & child = current.e.op(current.i);
607                         s.push(internal::_iter_rep(child, 0, child.nops()));
608                 }
609         }
610
611         void increment()
612         {
613                 if (s.top().i == s.top().i_end)
614                         s.pop();
615                 if (!s.empty()) {
616                         ++s.top().i;
617                         descend();
618                 }
619         }
620 };
621
622 inline const_iterator ex::begin() const throw()
623 {
624         return const_iterator(*this, 0);
625 }
626
627 inline const_iterator ex::end() const throw()
628 {
629         return const_iterator(*this, nops());
630 }
631
632 inline const_preorder_iterator ex::preorder_begin() const
633 {
634         return const_preorder_iterator(*this, nops());
635 }
636
637 inline const_preorder_iterator ex::preorder_end() const throw()
638 {
639         return const_preorder_iterator();
640 }
641
642 inline const_postorder_iterator ex::postorder_begin() const
643 {
644         return const_postorder_iterator(*this, nops());
645 }
646
647 inline const_postorder_iterator ex::postorder_end() const throw()
648 {
649         return const_postorder_iterator();
650 }
651
652
653 // utility functions
654
655 /** Compare two objects of class quickly without doing a deep tree traversal.
656  *  @return "true" if they are equal
657  *          "false" if equality cannot be established quickly (e1 and e2 may
658  *          still be equal, in this case. */
659 inline bool are_ex_trivially_equal(const ex &e1, const ex &e2)
660 {
661         return e1.bp == e2.bp;
662 }
663
664 /* Function objects for STL sort() etc. */
665 struct ex_is_less : public std::binary_function<ex, ex, bool> {
666         bool operator() (const ex &lh, const ex &rh) const { return lh.compare(rh) < 0; }
667 };
668
669 struct ex_is_equal : public std::binary_function<ex, ex, bool> {
670         bool operator() (const ex &lh, const ex &rh) const { return lh.is_equal(rh); }
671 };
672
673 struct op0_is_equal : public std::binary_function<ex, ex, bool> {
674         bool operator() (const ex &lh, const ex &rh) const { return lh.op(0).is_equal(rh.op(0)); }
675 };
676
677 struct ex_swap : public std::binary_function<ex, ex, void> {
678         void operator() (ex &lh, ex &rh) const { lh.swap(rh); }
679 };
680
681 // Make it possible to print exvectors and exmaps
682 std::ostream & operator<<(std::ostream & os, const exvector & e);
683 std::ostream & operator<<(std::ostream & os, const exset & e);
684 std::ostream & operator<<(std::ostream & os, const exmap & e);
685
686 // wrapper functions around member functions
687 inline size_t nops(const ex & thisex)
688 { return thisex.nops(); }
689
690 inline ex expand(const ex & thisex, unsigned options = 0)
691 { return thisex.expand(options); }
692
693 inline ex conjugate(const ex & thisex)
694 { return thisex.conjugate(); }
695
696 inline ex real_part(const ex & thisex)
697 { return thisex.real_part(); }
698
699 inline ex imag_part(const ex & thisex)
700 { return thisex.imag_part(); }
701
702 inline bool has(const ex & thisex, const ex & pattern, unsigned options = 0)
703 { return thisex.has(pattern, options); }
704
705 inline bool find(const ex & thisex, const ex & pattern, exset& found)
706 { return thisex.find(pattern, found); }
707
708 inline bool is_polynomial(const ex & thisex, const ex & vars)
709 { return thisex.is_polynomial(vars); }
710
711 inline int degree(const ex & thisex, const ex & s)
712 { return thisex.degree(s); }
713
714 inline int ldegree(const ex & thisex, const ex & s)
715 { return thisex.ldegree(s); }
716
717 inline ex coeff(const ex & thisex, const ex & s, int n=1)
718 { return thisex.coeff(s, n); }
719
720 inline ex numer(const ex & thisex)
721 { return thisex.numer(); }
722
723 inline ex denom(const ex & thisex)
724 { return thisex.denom(); }
725
726 inline ex numer_denom(const ex & thisex)
727 { return thisex.numer_denom(); }
728
729 inline ex normal(const ex & thisex, int level=0)
730 { return thisex.normal(level); }
731
732 inline ex to_rational(const ex & thisex, lst & repl_lst)
733 { return thisex.to_rational(repl_lst); }
734
735 inline ex to_rational(const ex & thisex, exmap & repl)
736 { return thisex.to_rational(repl); }
737
738 inline ex to_polynomial(const ex & thisex, exmap & repl)
739 { return thisex.to_polynomial(repl); }
740
741 inline ex to_polynomial(const ex & thisex, lst & repl_lst)
742 { return thisex.to_polynomial(repl_lst); }
743
744 inline ex collect(const ex & thisex, const ex & s, bool distributed = false)
745 { return thisex.collect(s, distributed); }
746
747 inline ex eval(const ex & thisex, int level = 0)
748 { return thisex.eval(level); }
749
750 inline ex evalf(const ex & thisex, int level = 0)
751 { return thisex.evalf(level); }
752
753 inline ex evalm(const ex & thisex)
754 { return thisex.evalm(); }
755
756 inline ex eval_integ(const ex & thisex)
757 { return thisex.eval_integ(); }
758
759 inline ex diff(const ex & thisex, const symbol & s, unsigned nth = 1)
760 { return thisex.diff(s, nth); }
761
762 inline ex series(const ex & thisex, const ex & r, int order, unsigned options = 0)
763 { return thisex.series(r, order, options); }
764
765 inline bool match(const ex & thisex, const ex & pattern, exmap& repl_lst)
766 { return thisex.match(pattern, repl_lst); }
767
768 inline ex simplify_indexed(const ex & thisex, unsigned options = 0)
769 { return thisex.simplify_indexed(options); }
770
771 inline ex simplify_indexed(const ex & thisex, const scalar_products & sp, unsigned options = 0)
772 { return thisex.simplify_indexed(sp, options); }
773
774 inline ex symmetrize(const ex & thisex)
775 { return thisex.symmetrize(); }
776
777 inline ex symmetrize(const ex & thisex, const lst & l)
778 { return thisex.symmetrize(l); }
779
780 inline ex antisymmetrize(const ex & thisex)
781 { return thisex.antisymmetrize(); }
782
783 inline ex antisymmetrize(const ex & thisex, const lst & l)
784 { return thisex.antisymmetrize(l); }
785
786 inline ex symmetrize_cyclic(const ex & thisex)
787 { return thisex.symmetrize_cyclic(); }
788
789 inline ex symmetrize_cyclic(const ex & thisex, const lst & l)
790 { return thisex.symmetrize_cyclic(l); }
791
792 inline ex op(const ex & thisex, size_t i)
793 { return thisex.op(i); }
794
795 inline ex lhs(const ex & thisex)
796 { return thisex.lhs(); }
797
798 inline ex rhs(const ex & thisex)
799 { return thisex.rhs(); }
800
801 inline bool is_zero(const ex & thisex)
802 { return thisex.is_zero(); }
803
804 inline void swap(ex & e1, ex & e2)
805 { e1.swap(e2); }
806
807 inline ex ex::subs(const exmap & m, unsigned options) const
808 {
809         return bp->subs(m, options);
810 }
811
812 inline ex subs(const ex & thisex, const exmap & m, unsigned options = 0)
813 { return thisex.subs(m, options); }
814
815 inline ex subs(const ex & thisex, const lst & ls, const lst & lr, unsigned options = 0)
816 { return thisex.subs(ls, lr, options); }
817
818 inline ex subs(const ex & thisex, const ex & e, unsigned options = 0)
819 { return thisex.subs(e, options); }
820
821
822 /* Convert function pointer to function object suitable for map(). */
823 class pointer_to_map_function : public map_function {
824 protected:
825         ex (*ptr)(const ex &);
826 public:
827         explicit pointer_to_map_function(ex x(const ex &)) : ptr(x) {}
828         ex operator()(const ex & e) { return ptr(e); }
829 };
830
831 template<class T1>
832 class pointer_to_map_function_1arg : public map_function {
833 protected:
834         ex (*ptr)(const ex &, T1);
835         T1 arg1;
836 public:
837         explicit pointer_to_map_function_1arg(ex x(const ex &, T1), T1 a1) : ptr(x), arg1(a1) {}
838         ex operator()(const ex & e) { return ptr(e, arg1); }
839 };
840
841 template<class T1, class T2>
842 class pointer_to_map_function_2args : public map_function {
843 protected:
844         ex (*ptr)(const ex &, T1, T2);
845         T1 arg1;
846         T2 arg2;
847 public:
848         explicit pointer_to_map_function_2args(ex x(const ex &, T1, T2), T1 a1, T2 a2) : ptr(x), arg1(a1), arg2(a2) {}
849         ex operator()(const ex & e) { return ptr(e, arg1, arg2); }
850 };
851
852 template<class T1, class T2, class T3>
853 class pointer_to_map_function_3args : public map_function {
854 protected:
855         ex (*ptr)(const ex &, T1, T2, T3);
856         T1 arg1;
857         T2 arg2;
858         T3 arg3;
859 public:
860         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) {}
861         ex operator()(const ex & e) { return ptr(e, arg1, arg2, arg3); }
862 };
863
864 template<class C>
865 class pointer_to_member_to_map_function : public map_function {
866 protected:
867         ex (C::*ptr)(const ex &);
868         C &c;
869 public:
870         explicit pointer_to_member_to_map_function(ex (C::*member)(const ex &), C &obj) : ptr(member), c(obj) {}
871         ex operator()(const ex & e) { return (c.*ptr)(e); }
872 };
873
874 template<class C, class T1>
875 class pointer_to_member_to_map_function_1arg : public map_function {
876 protected:
877         ex (C::*ptr)(const ex &, T1);
878         C &c;
879         T1 arg1;
880 public:
881         explicit pointer_to_member_to_map_function_1arg(ex (C::*member)(const ex &, T1), C &obj, T1 a1) : ptr(member), c(obj), arg1(a1) {}
882         ex operator()(const ex & e) { return (c.*ptr)(e, arg1); }
883 };
884
885 template<class C, class T1, class T2>
886 class pointer_to_member_to_map_function_2args : public map_function {
887 protected:
888         ex (C::*ptr)(const ex &, T1, T2);
889         C &c;
890         T1 arg1;
891         T2 arg2;
892 public:
893         explicit pointer_to_member_to_map_function_2args(ex (C::*member)(const ex&, T1, T2), C &obj, T1 a1, T2 a2) : ptr(member), c(obj), arg1(a1), arg2(a2) {}
894         ex operator()(const ex & e) { return (c.*ptr)(e, arg1, arg2); }
895 };
896
897 template<class C, class T1, class T2, class T3>
898 class pointer_to_member_to_map_function_3args : public map_function {
899 protected:
900         ex (C::*ptr)(const ex &, T1, T2, T3);
901         C &c;
902         T1 arg1;
903         T2 arg2;
904         T3 arg3;
905 public:
906         explicit pointer_to_member_to_map_function_3args(ex (C::*member)(const ex &, T1, T2, T3), C &obj, T1 a1, T2 a2, T3 a3) : ptr(member), c(obj), arg1(a1), arg2(a2), arg3(a3) {}
907         ex operator()(const ex & e) { return (c.*ptr)(e, arg1, arg2, arg3); }
908 };
909
910 inline ex ex::map(ex f(const ex &)) const
911 {
912         pointer_to_map_function fcn(f);
913         return bp->map(fcn);
914 }
915
916 // convenience type checker template functions
917
918 /** Check if ex is a handle to a T, including base classes. */
919 template <class T>
920 inline bool is_a(const ex &obj)
921 {
922         return is_a<T>(*obj.bp);
923 }
924
925 /** Check if ex is a handle to a T, not including base classes. */
926 template <class T>
927 inline bool is_exactly_a(const ex &obj)
928 {
929         return is_exactly_a<T>(*obj.bp);
930 }
931
932 /** Return a reference to the basic-derived class T object embedded in an
933  *  expression.  This is fast but unsafe: the result is undefined if the
934  *  expression does not contain a T object at its top level.  Hence, you
935  *  should generally check the type of e first.  Also, you shouldn't cache
936  *  the returned reference because GiNaC's garbage collector may destroy
937  *  the referenced object any time it's used in another expression.
938  *
939  *  @param e expression
940  *  @return reference to object of class T
941  *  @see is_exactly_a<class T>() */
942 template <class T>
943 inline const T &ex_to(const ex &e)
944 {
945         GINAC_ASSERT(is_a<T>(e));
946         return static_cast<const T &>(*e.bp);
947 }
948
949 } // namespace GiNaC
950
951
952 // Specializations of Standard Library algorithms
953 namespace std {
954
955 /** Specialization of std::swap() for ex objects. */
956 template <>
957 inline void swap(GiNaC::ex &a, GiNaC::ex &b)
958 {
959         a.swap(b);
960 }
961
962 /** Specialization of std::iter_swap() for vector<ex> iterators. */
963 template <>
964 inline void iter_swap(vector<GiNaC::ex>::iterator i1, vector<GiNaC::ex>::iterator i2)
965 {
966         i1->swap(*i2);
967 }
968
969 /** Specialization of std::iter_swap() for list<ex> iterators. */
970 template <>
971 inline void iter_swap(list<GiNaC::ex>::iterator i1, list<GiNaC::ex>::iterator i2)
972 {
973         i1->swap(*i2);
974 }
975
976 } // namespace std
977
978 #endif // ndef __GINAC_EX_H__