]> www.ginac.de Git - ginac.git/blobdiff - ginac/basic.h
* Bump up version, fix typos.
[ginac.git] / ginac / basic.h
index 9895902b5d85be488acf4c2a5a209254f81ca966..6320e075ecce3a5f0f2e7d9a806ceeea64f1b8d7 100644 (file)
@@ -23,9 +23,7 @@
 #ifndef __GINAC_BASIC_H__
 #define __GINAC_BASIC_H__
 
-#include <iostream>
 #include <vector>
-
 // CINT needs <algorithm> to work properly with <vector>
 #include <algorithm>
 
@@ -33,7 +31,6 @@
 #include "tinfos.h"
 #include "assertion.h"
 #include "registrar.h"
-/*#include "debugmsg.h"*/
 
 namespace GiNaC {
 
@@ -45,13 +42,16 @@ class relational;
 class archive_node;
 class print_context;
 
-// Cint doesn't like vector<..,default_alloc> but malloc_alloc is
-// unstandardized and not supported by newer GCCs.
-#if defined(__GNUC__) && ((__GNUC__ == 2) && (__GNUC_MINOR__ < 97))
-  typedef std::vector<ex,malloc_alloc> exvector;
-#else
-  typedef std::vector<ex> exvector;
-#endif
+typedef std::vector<ex> exvector;
+
+
+/** 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. */
@@ -61,16 +61,12 @@ class basic
        
        friend class ex;
        
-       // default ctor, dtor, copy ctor assignment operator and helpers
+       // default ctor, dtor, copy ctor, assignment operator and helpers
 public:
-       basic() : tinfo_key(TINFO_basic), flags(0), refcount(0)
-       {
-               /* debugmsg("basic default ctor", LOGLEVEL_CONSTRUCT); */
-       }
+       basic() : tinfo_key(TINFO_basic), flags(0), refcount(0) {}
        /** basic dtor, virtual because class ex will delete objects via ptr. */
        virtual ~basic()
        {
-               /* debugmsg("basic dtor", LOGLEVEL_DESTRUCT); */
                destroy(false);
                GINAC_ASSERT((!(flags & status_flags::dynallocated))||(refcount==0));
        }
@@ -89,12 +85,7 @@ protected:
        
        // other ctors
        /** ctor with specified tinfo_key */
-       basic(unsigned ti) : tinfo_key(ti), flags(0), refcount(0)
-       {
-               /* debugmsg("basic ctor with tinfo_key", LOGLEVEL_CONSTRUCT); */
-       }
-       // functions overriding virtual functions from bases classes
-       // none
+       basic(unsigned ti) : tinfo_key(ti), flags(0), refcount(0) {}
        
        // new virtual functions which can be overridden by derived classes
 public: // only const functions please (may break reference counting)
@@ -102,44 +93,49 @@ public: // only const functions please (may break reference counting)
        virtual void print(const print_context & c, unsigned level = 0) const;
        virtual void dbgprint(void) const;
        virtual void dbgprinttree(void) const;
+       virtual unsigned precedence(void) const;
        virtual bool info(unsigned inf) const;
        virtual unsigned nops() const;
        virtual ex op(int i) const;
        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_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;
-       virtual ex collect(const ex & s) const;
+       virtual ex collect(const ex & s, bool distributed = false) const;
        virtual ex eval(int level = 0) const;
        virtual ex evalf(int level = 0) const;
+       virtual ex evalm(void) const;
        virtual ex series(const relational & r, int order, unsigned options = 0) const;
-       virtual ex subs(const lst & ls, const lst & lr) const;
+       virtual bool match(const ex & pattern, lst & repl_lst) const;
+       virtual ex subs(const lst & ls, const lst & lr, bool no_pattern = false) const;
        virtual ex normal(lst &sym_lst, lst &repl_lst, int level = 0) const;
        virtual ex to_rational(lst &repl_lst) const;
        virtual numeric integer_content(void) const;
        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:
-       ex subs(const ex & e) const;
+       ex subs(const ex & e, bool no_pattern = false) const;
        ex diff(const symbol & s, unsigned nth=1) const;
        int compare(const basic & other) const;
        bool is_equal(const basic & other) const;
@@ -153,10 +149,6 @@ public:
        /** Clear some status_flags. */
        const basic & clearflag(unsigned f) const {flags &= ~f; return *this;}
 
-       /** Get relative precedence level (useful for implementing pretty-printed
-        *  output). */
-       unsigned get_precedence(void) const {return precedence;}
-
 protected:
        void ensure_if_modifiable(void) const;
        
@@ -165,7 +157,6 @@ protected:
        unsigned tinfo_key;                 ///< typeinfo
        mutable unsigned flags;             ///< of type status_flags
        mutable unsigned hashvalue;         ///< hash value
-       static unsigned precedence;         ///< precedence for printing parens
 private:
        unsigned refcount;                  ///< Number of reference counts
 };
@@ -174,23 +165,52 @@ private:
 
 extern int max_recursion_level;
 
-// convenience macros
+// convenience type checker template functions
 
-/** 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 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 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 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 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 T, not including base classes. */
+template <class T>
+inline bool is_exactly_a(const ex &obj)
+{
+       return is_exactly_a<T>(*obj.bp);
+}
 
-/** 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)
+/** 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.  Hence, you
+ *  should generally check the type of e first.
+ *
+ *  @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)
+{
+       GINAC_ASSERT(is_a<T>(e));
+       return static_cast<const T &>(*e.bp);
+}
 
 } // namespace GiNaC