- eta(x,y) was broken all along since ages: eta(I,I) for instance ought

[ginac.git] / ginac / basic.h

diff --git a/ginac/basic.h b/ginac/basic.h
index 9199e34c5634f0101e147eaa1f597807cd08353b..28568c56025353be45b9b7d3cb5be1e0c39b7e36 100644 (file)
--- a/ginac/basic.h
+++ b/ginac/basic.h
@@ -47,7 +47,14 @@ class print_context;
 
 typedef std::vector<ex> exvector;
 
-typedef ex (*map_func)(const ex & e);
+
+/** Function object for map(). */
+struct map_function {
+       typedef const ex & argument_type;
+       typedef ex result_type;
+       virtual ex operator()(const ex & e) = 0;
+};
+
 
 /** This class is the ABC (abstract base class) of GiNaC's class hierarchy.
  *  It is responsible for the reference counting. */
@@ -89,8 +96,6 @@ protected:
        {
                /* debugmsg("basic ctor with tinfo_key", LOGLEVEL_CONSTRUCT); */
        }
-       // functions overriding virtual functions from bases classes
-       // none
        
        // new virtual functions which can be overridden by derived classes
 public: // only const functions please (may break reference counting)
@@ -105,8 +110,9 @@ public: // only const functions please (may break reference counting)
        virtual ex & let_op(int i);
        virtual ex operator[](const ex & index) const;
        virtual ex operator[](int i) const;
+       virtual ex expand(unsigned options = 0) const;
        virtual bool has(const ex & other) const;
-       virtual ex map(map_func f) const;
+       virtual ex map(map_function & f) const;
        virtual int degree(const ex & s) const;
        virtual int ldegree(const ex & s) const;
        virtual ex coeff(const ex & s, int n = 1) const;
@@ -123,19 +129,19 @@ public: // only const functions please (may break reference counting)
        virtual ex smod(const numeric &xi) const;
        virtual numeric max_coefficient(void) const;
        virtual exvector get_free_indices(void) const;
-       virtual ex simplify_ncmul(const exvector & v) const;
        virtual ex eval_indexed(const basic & i) const;
        virtual ex add_indexed(const ex & self, const ex & other) const;
        virtual ex scalar_mul_indexed(const ex & self, const numeric & other) const;
        virtual bool contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const;
-protected: // non-const functions should be called from class ex only
+       virtual unsigned return_type(void) const;
+       virtual unsigned return_type_tinfo(void) const;
+protected: // functions that should be called from class ex only
        virtual ex derivative(const symbol & s) const;
        virtual int compare_same_type(const basic & other) const;
        virtual bool is_equal_same_type(const basic & other) const;
-       virtual unsigned return_type(void) const;
-       virtual unsigned return_type_tinfo(void) const;
+       virtual bool match_same_type(const basic & other) const;
        virtual unsigned calchash(void) const;
-       virtual ex expand(unsigned options = 0) const;
+       virtual ex simplify_ncmul(const exvector & v) const;
        
        // non-virtual functions in this class
 public:
@@ -169,24 +175,66 @@ private:
 
 extern int max_recursion_level;
 
-// convenience macros
+// Obsolete convenience macros.  To be phased out soon!
+// Use the inlined template functions below instead of these macros.
 
-/** Check if OBJ is a TYPE, including base classes. */
 #define is_of_type(OBJ,TYPE) \
        (dynamic_cast<const TYPE *>(&OBJ)!=0)
 
-/** Check if OBJ is a TYPE, not including base classes. */
 #define is_exactly_of_type(OBJ,TYPE) \
        ((OBJ).tinfo()==GiNaC::TINFO_##TYPE)
 
-/** Check if ex is a handle to a TYPE, including base classes. */
 #define is_ex_of_type(OBJ,TYPE) \
        (dynamic_cast<const TYPE *>((OBJ).bp)!=0)
 
-/** Check if ex is a handle to a TYPE, not including base classes. */
 #define is_ex_exactly_of_type(OBJ,TYPE) \
        ((*(OBJ).bp).tinfo()==GiNaC::TINFO_##TYPE)
 
+// convenience type checker template functions
+
+/** Check if obj is a T, including base classes. */
+template <class T>
+inline bool is_a(const basic & obj)
+{
+       return dynamic_cast<const T *>(&obj)!=0;
+}
+
+/** Check if obj is a T, not including base classes.  This one is just an
+ *  inefficient default.  It should in all time-critical cases be overridden
+ *  by template specializations that don't create a temporary. */
+template <class T>
+inline bool is_exactly_a(const class basic & obj)
+{
+       const T foo; return foo.tinfo()==obj.tinfo();
+}
+
+/** Check if ex is a handle to a T, including base classes. */
+template <class T>
+inline bool is_a(const ex & obj)
+{
+       return is_a<T>(*obj.bp);
+}
+
+/** Check if ex is a handle to a T, not including base classes. */
+template <class T>
+inline bool is_exactly_a(const ex & obj)
+{
+       return is_exactly_a<T>(*obj.bp);
+}
+
+/** Return a reference to the basic-derived class T object embedded in an
+ *  expression.  This is fast but unsafe: the result is undefined if the
+ *  expression does not contain a T object at its top level.
+ *
+ *  @param e expression
+ *  @return reference to pseries object
+ *  @see is_exactly_a<class T>() */
+template <class T>
+inline const T &ex_to(const ex &e)
+{
+       return static_cast<const T &>(*e.bp);
+}
+
 } // namespace GiNaC
 
 #endif // ndef __GINAC_BASIC_H__