X-Git-Url: https://www.ginac.de/ginac.git//ginac.git?p=ginac.git;a=blobdiff_plain;f=ginac%2Fbasic.h;h=a5af32366c6c8a063d0f939ec170357f17a88058;hp=ae8104769fcfc4e043b6848649e6a020c2b65319;hb=5ef801553eb39aed7bd2df9dd1aff9d752c3ea9d;hpb=afdd7fa8c6c0a587f7c80789198551383e8beb7b

diff --git a/ginac/basic.h b/ginac/basic.h
index ae810476..a5af3236 100644
--- a/ginac/basic.h
+++ b/ginac/basic.h
@@ -3,7 +3,7 @@
  *  Interface to GiNaC's ABC. */
 
 /*
- *  GiNaC Copyright (C) 1999 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2003 Johannes Gutenberg University Mainz, Germany
  *
  *  This program is free software; you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License as published by
@@ -23,202 +23,254 @@
 #ifndef __GINAC_BASIC_H__
 #define __GINAC_BASIC_H__
 
-#include <iostream>
-#include <typeinfo>
+#include <cstddef> // for size_t
 #include <vector>
-
-// CINT needs <algorithm> to work properly with <vector> 
+#include <map>
+// CINT needs <algorithm> to work properly with <vector>
 #include <algorithm>
 
-#include <ginac/flags.h>
-#include <ginac/tinfos.h>
-#include <ginac/assertion.h>
+#include "flags.h"
+#include "tinfos.h"
+#include "assertion.h"
+#include "registrar.h"
 
-#ifndef NO_GINAC_NAMESPACE
 namespace GiNaC {
-#endif // ndef NO_GINAC_NAMESPACE
 
-class basic;
 class ex;
+class ex_is_less;
 class symbol;
-class lst;
 class numeric;
+class relational;
+class archive_node;
+class print_context;
+template <class> class ptr;
+
+typedef std::vector<ex> exvector;
+typedef std::map<ex, ex, ex_is_less> exmap;
+
+
+/** Function object for map(). */
+struct map_function {
+	typedef const ex & argument_type;
+	typedef ex result_type;
+	virtual ex operator()(const ex & e) = 0;
+};
 
-//typedef vector<ex> exvector;
-typedef vector<ex,malloc_alloc> exvector; // CINT does not like vector<...,default_alloc>
 
-#define INLINE_BASIC_CONSTRUCTORS
+/** Degenerate base class for visitors. basic and derivative classes
+ *  support Robert C. Martin's Acyclic Visitor pattern (cf.
+ *  http://objectmentor.com/publications/acv.pdf). */
+class visitor {
+protected:
+	virtual ~visitor() {}
+};
+
 
 /** This class is the ABC (abstract base class) of GiNaC's class hierarchy.
  *  It is responsible for the reference counting. */
 class basic
 {
-    friend class ex;
-
-// member functions
+	GINAC_DECLARE_REGISTERED_CLASS_NO_CTORS(basic, void)
+	
+	friend class ex;
+	friend class ptr<basic>;
+	
+	// default constructor, destructor, copy constructor and assignment operator
+protected:
+	basic() : tinfo_key(TINFO_basic), flags(0), refcount(0) {}
 
-    // default constructor, destructor, copy constructor assignment operator and helpers
 public:
-    basic()
-#ifdef INLINE_BASIC_CONSTRUCTORS
-    : tinfo_key(TINFO_basic), flags(0), refcount(0)
-    {
-    }
-#else
-;
-#endif // def INLINE_BASIC_CONSTRUCTORS
-
-    virtual ~basic()
-#ifdef INLINE_BASIC_CONSTRUCTORS
-    {
-        destroy(0);
-        GINAC_ASSERT((!(flags & status_flags::dynallocated))||(refcount==0));
-    }
-#else
-;
-#endif // def INLINE_BASIC_CONSTRUCTORS
-
-    basic(basic const & other)
-#ifdef INLINE_BASIC_CONSTRUCTORS
-    {
-        copy(other);
-    }
-#else
-;
-#endif // def INLINE_BASIC_CONSTRUCTORS
-
-    virtual basic const & operator=(basic const & other);
-    
+	/** basic destructor, virtual because class ex will delete objects of
+	 *  derived classes via a basic*. */
+	virtual ~basic()
+	{
+		GINAC_ASSERT((!(flags & status_flags::dynallocated))||(refcount==0));
+	}
+	basic(const basic & other);
+	const basic & operator=(const basic & other);
+
 protected:
-    void copy(basic const & other)
-    {
-        flags = other.flags & ~status_flags::dynallocated;
-        hashvalue = other.hashvalue;
-        tinfo_key = other.tinfo_key;
-    }
-    void destroy(bool call_parent) {}
-
-    // other constructors
-    basic(unsigned ti)
-#ifdef INLINE_BASIC_CONSTRUCTORS
-    : tinfo_key(ti), flags(0), refcount(0)
-    {
-    }
-#else
-;
-#endif // def INLINE_BASIC_CONSTRUCTORS
-
-    // functions overriding virtual functions from bases classes
-    // none
-    
-    // new virtual functions which can be overridden by derived classes
+	/** Constructor with specified tinfo_key (used by derived classes instead
+	 *  of the default constructor to avoid assigning tinfo_key twice). */
+	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)
-    virtual basic * duplicate() const;
-    virtual void printraw(ostream & os) const;
-    virtual void printtree(ostream & os, unsigned indent) const;
-    virtual void print(ostream & os,unsigned upper_precedence=0) const;
-    virtual void printcsrc(ostream & os, unsigned type, unsigned upper_precedence=0) const;
-    virtual void dbgprint(void) const;
-    virtual void dbgprinttree(void) const;
-    virtual bool info(unsigned inf) const;
-    virtual int nops() const;
-    virtual ex op(int const i) const;
-    virtual ex & let_op(int const i);
-    virtual ex operator[](ex const & index) const;
-    virtual ex operator[](int const i) const;
-    virtual bool has(ex const & other) const;
-    virtual int degree(symbol const & s) const;
-    virtual int ldegree(symbol const & s) const;
-    virtual ex coeff(symbol const & s, int const n=1) const;
-    virtual ex collect(symbol const & s) const;
-    virtual ex eval(int level=0) const;
-    virtual ex evalf(int level=0) const;
-    virtual ex diff(symbol const & s) const;
-    virtual ex series(symbol const & s, ex const & point, int order) const;
-    virtual ex subs(lst const & ls, lst const & lr) const;
-    virtual ex normal(lst &sym_lst, lst &repl_lst, int level=0) const;
-    virtual numeric integer_content(void) const;
-    virtual ex smod(numeric const &xi) const;
-    virtual numeric max_coefficient(void) const;
-    virtual exvector get_indices(void) const;
-    virtual ex simplify_ncmul(exvector const & v) const;
-protected: // non-const functions should be called from class ex only
-    virtual int compare_same_type(basic const & other) const;
-    virtual bool is_equal_same_type(basic const & other) const;
-    virtual unsigned return_type(void) const;
-    virtual unsigned return_type_tinfo(void) const;
-    virtual unsigned calchash(void) const;
-    virtual ex expand(unsigned options=0) const;
-
-    // non-virtual functions in this class
+
+	/** Create a clone of this object on the heap.  One can think of this as
+	 *  simulating a virtual copy constructor which is needed for instance by
+	 *  the refcounted construction of an ex from a basic. */
+	virtual basic * duplicate() const { return new basic(*this); }
+
+	// evaluation
+	virtual ex eval(int level = 0) const;
+	virtual ex evalf(int level = 0) const;
+	virtual ex evalm() const;
+protected:
+	virtual ex eval_ncmul(const exvector & v) const;
 public:
-    ex subs(ex const & e) const;
-    int compare(basic const & other) const;
-    bool is_equal(basic const & other) const;
-    basic const & 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;}
+	virtual ex eval_indexed(const basic & i) const;
+
+	// printing
+	virtual void print(const print_context & c, unsigned level = 0) const;
+	virtual void dbgprint() const;
+	virtual void dbgprinttree() const;
+	virtual unsigned precedence() const;
+
+	// info
+	virtual bool info(unsigned inf) const;
+
+	// operand access
+	virtual size_t nops() const;
+	virtual ex op(size_t i) const;
+	virtual ex operator[](const ex & index) const;
+	virtual ex operator[](size_t i) const;
+	virtual ex & let_op(size_t i);
+	virtual ex & operator[](const ex & index);
+	virtual ex & operator[](size_t i);
+
+	// pattern matching
+	virtual bool has(const ex & other) const;
+	virtual bool match(const ex & pattern, lst & repl_lst) const;
 protected:
-    basic const & setflag(unsigned f) const {flags |= f; return *this;}
-    basic const & clearflag(unsigned f) const {flags &= ~f; return *this;}
-    void ensure_if_modifiable(void) const;
+	virtual bool match_same_type(const basic & other) const;
+public:
 
-// member variables
-    
-protected:
-    unsigned tinfo_key;
-    mutable unsigned flags;
-    mutable unsigned hashvalue;
-    static unsigned precedence;
-    static unsigned delta_indent;
-private:
-    unsigned refcount;
-};
+	// substitutions
+	virtual ex subs(const exmap & m, unsigned options = 0) const;
 
-// global constants
+	// function mapping
+	virtual ex map(map_function & f) const;
 
-extern const basic some_basic;
-extern type_info const & typeid_basic;
+	// visitors and tree traversal
+	virtual void accept(GiNaC::visitor & v) const
+	{
+		if (visitor *p = dynamic_cast<visitor *>(&v))
+			p->visit(*this);
+	}
 
-// global variables
+	// degree/coeff
+	virtual int degree(const ex & s) const;
+	virtual int ldegree(const ex & s) const;
+	virtual ex coeff(const ex & s, int n = 1) const;
 
-extern int max_recursion_level;
+	// expand/collect
+	virtual ex expand(unsigned options = 0) const;
+	virtual ex collect(const ex & s, bool distributed = false) const;
+
+	// differentiation and series expansion
+protected:
+	virtual ex derivative(const symbol & s) const;
+public:
+	virtual ex series(const relational & r, int order, unsigned options = 0) const;
+
+	// rational functions
+	virtual ex normal(exmap & repl, int level = 0) const;
+	virtual ex to_rational(lst &repl_lst) const;
+	virtual ex to_polynomial(lst &repl_lst) const;
+
+	// polynomial algorithms
+	virtual numeric integer_content() const;
+	virtual ex smod(const numeric &xi) const;
+	virtual numeric max_coefficient() const;
+
+	// indexed objects
+	virtual exvector get_free_indices() 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;
+
+	// noncommutativity
+	virtual unsigned return_type() const;
+	virtual unsigned return_type_tinfo() const;
+
+protected: // functions that should be called from class ex only
+	virtual int compare_same_type(const basic & other) const;
+	virtual bool is_equal_same_type(const basic & other) const;
+
+	virtual unsigned calchash() const;
+	
+	// non-virtual functions in this class
+public:
+	ex subs_one_level(const exmap & m, unsigned options) 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() const;
+	unsigned gethash() const { if (flags & status_flags::hash_calculated) return hashvalue; else return calchash(); }
+	unsigned tinfo() const {return tinfo_key;}
 
-// convenience macros
+	/** Set some status_flags. */
+	const basic & setflag(unsigned f) const {flags |= f; return *this;}
 
-#ifndef NO_GINAC_NAMESPACE
+	/** Clear some status_flags. */
+	const basic & clearflag(unsigned f) const {flags &= ~f; return *this;}
 
-#define is_of_type(OBJ,TYPE) \
-    (dynamic_cast<TYPE *>(const_cast<GiNaC::basic *>(&OBJ))!=0)
+protected:
+	void ensure_if_modifiable() const;
+	
+	// member variables
+protected:
+	unsigned tinfo_key;                 ///< typeinfo
+	mutable unsigned flags;             ///< of type status_flags
+	mutable unsigned hashvalue;         ///< hash value
+private:
+	size_t refcount;                    ///< reference counter, managed by ptr<basic>
+};
 
-#define is_exactly_of_type(OBJ,TYPE) \
-    ((OBJ).tinfo()==GiNaC::TINFO_##TYPE)
 
-#define is_ex_of_type(OBJ,TYPE) \
-    (dynamic_cast<TYPE *>(const_cast<GiNaC::basic *>((OBJ).bp))!=0)
+// global variables
 
-#define is_ex_exactly_of_type(OBJ,TYPE) \
-    ((*(OBJ).bp).tinfo()==GiNaC::TINFO_##TYPE)
+extern int max_recursion_level;
 
-#else // ndef NO_GINAC_NAMESPACE
 
-#define is_of_type(OBJ,TYPE) \
-    (dynamic_cast<TYPE *>(const_cast<basic *>(&OBJ))!=0)
+// convenience type checker template functions
 
-#define is_exactly_of_type(OBJ,TYPE) \
-    ((OBJ).tinfo()==TINFO_##TYPE)
+/** 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 use the TINFO_* constants directly. */
+template <class T>
+inline bool is_exactly_a(const class basic &obj)
+{
+	return obj.tinfo() == T::reg_info.tinfo_key;
+}
 
-#define is_ex_of_type(OBJ,TYPE) \
-    (dynamic_cast<TYPE *>(const_cast<basic *>((OBJ).bp))!=0)
+/** 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);
+}
 
-#define is_ex_exactly_of_type(OBJ,TYPE) \
-    ((*(OBJ).bp).tinfo()==TINFO_##TYPE)
+/** 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);
+}
 
-#endif // ndef NO_GINAC_NAMESPACE
+/** 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);
+}
 
-#ifndef NO_GINAC_NAMESPACE
 } // namespace GiNaC
-#endif // ndef NO_GINAC_NAMESPACE
 
 #endif // ndef __GINAC_BASIC_H__
-