- ex_to<foo>(obj) is a good candidate for asserting is_a<foo>(obj).

[ginac.git] / ginac / ex.h

diff --git a/ginac/ex.h b/ginac/ex.h
index 34ce8b8c489634528271e1612585d734f12036c5..88f4e2ef40fd439e5afa349f57a3fe28dc60ebe3 100644 (file)
--- a/ginac/ex.h
+++ b/ginac/ex.h
@@ -26,6 +26,8 @@
 #include "basic.h"
 #include "operators.h"
 
+#include <functional>
+
 namespace GiNaC {
 
 // Sorry, this is the only constant to pollute the global scope, the other ones
@@ -37,6 +39,7 @@ class symbol;
 class lst;
 class scalar_products;
 
+
 /** Lightweight wrapper for GiNaC's symbolic objects.  Basically all it does is
  *  to hold a pointer to the other objects, manage the reference counting and
  *  provide methods for manipulation of these objects.  (Some people call such
@@ -67,12 +70,6 @@ public:
         *  symbols and other parser errors will throw an exception. */
        ex(const std::string &s, const ex &l);
        
-       // functions overriding virtual functions from bases classes
-       // none
-       
-       // new virtual functions which can be overridden by derived classes
-       // none
-
        // non-virtual functions in this class
 public:
        void swap(ex & other);
@@ -83,7 +80,10 @@ public:
        bool info(unsigned inf) const { return bp->info(inf); }
        unsigned nops() const { return bp->nops(); }
        ex expand(unsigned options=0) const;
-       bool has(const ex & other) const { return bp->has(other); }
+       bool has(const ex & pattern) const { return bp->has(pattern); }
+       ex map(map_function & f) const { return bp->map(f); }
+       ex map(ex (*f)(const ex & e)) const;
+       bool find(const ex & pattern, lst & found) const;
        int degree(const ex & s) const { return bp->degree(s); }
        int ldegree(const ex & s) const { return bp->ldegree(s); }
        ex coeff(const ex & s, int n = 1) const { return bp->coeff(s, n); }
@@ -91,6 +91,7 @@ public:
        ex tcoeff(const ex & s) const { return coeff(s, ldegree(s)); }
        ex numer(void) const;
        ex denom(void) const;
+       ex numer_denom(void) const;
        ex unit(const symbol &x) const;
        ex content(const symbol &x) const;
        numeric integer_content(void) const;
@@ -103,6 +104,7 @@ public:
        ex collect(const ex & s, bool distributed = false) const { return bp->collect(s, distributed); }
        ex eval(int level = 0) const { return bp->eval(level); }
        ex evalf(int level = 0) const { return bp->evalf(level); }
+       ex evalm(void) const { return bp->evalm(); }
        ex diff(const symbol & s, unsigned nth = 1) const;
        ex series(const ex & r, int order, unsigned options = 0) const;
        bool match(const ex & pattern) const;
@@ -112,6 +114,12 @@ public:
        exvector get_free_indices(void) const { return bp->get_free_indices(); }
        ex simplify_indexed(void) const;
        ex simplify_indexed(const scalar_products & sp) const;
+       ex symmetrize(void) const;
+       ex symmetrize(const lst & l) const;
+       ex antisymmetrize(void) const;
+       ex antisymmetrize(const lst & l) const;
+       ex symmetrize_cyclic(void) const;
+       ex symmetrize_cyclic(const lst & l) const;
        ex simplify_ncmul(const exvector & v) const { return bp->simplify_ncmul(v); }
        ex operator[](const ex & index) const;
        ex operator[](int i) const;
@@ -333,8 +341,11 @@ inline unsigned nops(const ex & thisex)
 inline ex expand(const ex & thisex, unsigned options = 0)
 { return thisex.expand(options); }
 
-inline bool has(const ex & thisex, const ex & other)
-{ return thisex.has(other); }
+inline bool has(const ex & thisex, const ex & pattern)
+{ return thisex.has(pattern); }
+
+inline bool find(const ex & thisex, const ex & pattern, lst & found)
+{ return thisex.find(pattern, found); }
 
 inline int degree(const ex & thisex, const ex & s)
 { return thisex.degree(s); }
@@ -351,6 +362,9 @@ inline ex numer(const ex & thisex)
 inline ex denom(const ex & thisex)
 { return thisex.denom(); }
 
+inline ex numer_denom(const ex & thisex)
+{ return thisex.numer_denom(); }
+
 inline ex normal(const ex & thisex, int level=0)
 { return thisex.normal(level); }
 
@@ -366,6 +380,9 @@ inline ex eval(const ex & thisex, int level = 0)
 inline ex evalf(const ex & thisex, int level = 0)
 { return thisex.evalf(level); }
 
+inline ex evalm(const ex & thisex)
+{ return thisex.evalm(); }
+
 inline ex diff(const ex & thisex, const symbol & s, unsigned nth = 1)
 { return thisex.diff(s, nth); }
 
@@ -381,6 +398,30 @@ inline ex subs(const ex & thisex, const ex & e)
 inline ex subs(const ex & thisex, const lst & ls, const lst & lr)
 { return thisex.subs(ls, lr); }
 
+inline ex simplify_indexed(const ex & thisex)
+{ return thisex.simplify_indexed(); }
+
+inline ex simplify_indexed(const ex & thisex, const scalar_products & sp)
+{ return thisex.simplify_indexed(sp); }
+
+inline ex symmetrize(const ex & thisex)
+{ return thisex.symmetrize(); }
+
+inline ex symmetrize(const ex & thisex, const lst & l)
+{ return thisex.symmetrize(l); }
+
+inline ex antisymmetrize(const ex & thisex)
+{ return thisex.antisymmetrize(); }
+
+inline ex antisymmetrize(const ex & thisex, const lst & l)
+{ return thisex.antisymmetrize(l); }
+
+inline ex symmetrize_cyclic(const ex & thisex)
+{ return thisex.symmetrize_cyclic(); }
+
+inline ex symmetrize_cyclic(const ex & thisex, const lst & l)
+{ return thisex.symmetrize_cyclic(l); }
+
 inline ex op(const ex & thisex, int i)
 { return thisex.op(i); }
 
@@ -396,6 +437,70 @@ inline bool is_zero(const ex & thisex)
 inline void swap(ex & e1, ex & e2)
 { e1.swap(e2); }
 
+
+/* Function objects for STL sort() etc. */
+struct ex_is_less : public std::binary_function<ex, ex, bool> {
+       bool operator() (const ex &lh, const ex &rh) const { return lh.compare(rh) < 0; }
+};
+
+struct ex_is_equal : public std::binary_function<ex, ex, bool> {
+       bool operator() (const ex &lh, const ex &rh) const { return lh.is_equal(rh); }
+};
+
+struct ex_swap : public std::binary_function<ex, ex, void> {
+       void operator() (ex &lh, ex &rh) const { lh.swap(rh); }
+};
+
+
+/* Convert function pointer to function object suitable for map(). */
+class pointer_to_map_function : public map_function {
+protected:
+       ex (*ptr)(const ex &);
+public:
+       explicit pointer_to_map_function(ex (*x)(const ex &)) : ptr(x) {}
+       ex operator()(const ex & e) { return ptr(e); }
+};
+
+template<class T1>
+class pointer_to_map_function_1arg : public map_function {
+protected:
+       ex (*ptr)(const ex &, T1);
+       T1 arg1;
+public:
+       explicit pointer_to_map_function_1arg(ex (*x)(const ex &, T1), T1 a1) : ptr(x), arg1(a1) {}
+       ex operator()(const ex & e) { return ptr(e, arg1); }
+};
+
+template<class T1, class T2>
+class pointer_to_map_function_2args : public map_function {
+protected:
+       ex (*ptr)(const ex &, T1, T2);
+       T1 arg1;
+       T2 arg2;
+public:
+       explicit pointer_to_map_function_2args(ex (*x)(const ex &, T1, T2), T1 a1, T2 a2) : ptr(x), arg1(a1), arg2(a2) {}
+       ex operator()(const ex & e) { return ptr(e, arg1, arg2); }
+};
+
+template<class T1, class T2, class T3>
+class pointer_to_map_function_3args : public map_function {
+protected:
+       ex (*ptr)(const ex &, T1, T2, T3);
+       T1 arg1;
+       T2 arg2;
+       T3 arg3;
+public:
+       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) {}
+       ex operator()(const ex & e) { return ptr(e, arg1, arg2, arg3); }
+};
+
+inline ex ex::map(ex (*f)(const ex & e)) const
+{
+       pointer_to_map_function fcn(f);
+       return bp->map(fcn);
+}
+
+
 } // namespace GiNaC
 
 #endif // ndef __GINAC_EX_H__