]> www.ginac.de Git - ginac.git/blobdiff - ginac/basic.h
- in LaTeX context, fractions now print as \frac{n}{d}.
[ginac.git] / ginac / basic.h
index e1325745c93cbb12212bb191b826b9712ad5c3dd..28568c56025353be45b9b7d3cb5be1e0c39b7e36 100644 (file)
@@ -24,7 +24,6 @@
 #define __GINAC_BASIC_H__
 
 #include <iostream>
-#include <typeinfo>
 #include <vector>
 
 // CINT needs <algorithm> to work properly with <vector>
@@ -44,14 +43,18 @@ class lst;
 class numeric;
 class relational;
 class archive_node;
+class print_context;
+
+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;
+};
 
-// 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
 
 /** This class is the ABC (abstract base class) of GiNaC's class hierarchy.
  *  It is responsible for the reference counting. */
@@ -61,8 +64,6 @@ class basic
        
        friend class ex;
        
-// member functions
-       
        // default ctor, dtor, copy ctor assignment operator and helpers
 public:
        basic() : tinfo_key(TINFO_basic), flags(0), refcount(0)
@@ -95,73 +96,77 @@ 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)
        virtual basic * duplicate() const;
-       virtual void print(std::ostream & os,unsigned upper_precedence = 0) const;
-       virtual void printraw(std::ostream & os) const;
-       virtual void printtree(std::ostream & os, unsigned indent) const;
-       virtual void printcsrc(std::ostream & os, unsigned type, unsigned upper_precedence = 0) const;
+       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 int degree(const symbol & s) const;
-       virtual int ldegree(const symbol & s) const;
-       virtual ex coeff(const symbol & s, int n = 1) const;
-       virtual ex collect(const symbol & s) 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, 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_indices(void) const;
-       virtual ex simplify_ncmul(const exvector & v) const;
-protected: // non-const functions should be called from class ex only
+       virtual exvector get_free_indices(void) 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;
+       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;
        const basic & hold(void) const;
        unsigned gethash(void) const { if (flags & status_flags::hash_calculated) return hashvalue; else return calchash(); }
        unsigned tinfo(void) const {return tinfo_key;}
+
        /** Set some status_flags. */
        const basic & setflag(unsigned f) const {flags |= f; return *this;}
+
        /** Clear some status_flags. */
        const basic & clearflag(unsigned f) const {flags &= ~f; return *this;}
+
 protected:
        void ensure_if_modifiable(void) const;
        
-// member variables
-       
+       // member variables
 protected:
        unsigned tinfo_key;                 ///< typeinfo
        mutable unsigned flags;             ///< of type status_flags
        mutable unsigned hashvalue;         ///< hash value
-       static unsigned precedence;         ///< precedence for printing parens
-       static unsigned delta_indent;       ///< precedence for printtree
 private:
        unsigned refcount;                  ///< Number of reference counts
 };
@@ -170,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__