X-Git-Url: https://www.ginac.de/ginac.git//ginac.git?p=ginac.git;a=blobdiff_plain;f=ginac%2Fbasic.h;h=51e0e909336f5a6d0791e6b6aae595194fcf1eb0;hp=9c54a67e45b2ed271a6ade82fa636dfc5d4e4fd9;hb=9d92d4b442fc4c1a95685884be4ba0494cd02bbe;hpb=ac58769a3265fa850c74f5d601b6f68077276d84 diff --git a/ginac/basic.h b/ginac/basic.h index 9c54a67e..51e0e909 100644 --- a/ginac/basic.h +++ b/ginac/basic.h @@ -3,7 +3,7 @@ * Interface to GiNaC's ABC. */ /* - * GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany + * GiNaC Copyright (C) 1999-2008 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 @@ -17,136 +17,267 @@ * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ #ifndef __GINAC_BASIC_H__ #define __GINAC_BASIC_H__ -#include +#include // for size_t #include - +#include +#include +#include // for typeid // CINT needs to work properly with #include #include "flags.h" -#include "tinfos.h" +#include "ptr.h" #include "assertion.h" #include "registrar.h" -/*#include "debugmsg.h"*/ namespace GiNaC { class ex; +class ex_is_less; class symbol; -class lst; class numeric; class relational; class archive_node; class print_context; -// Cint currently doesn't like vector<..,default_alloc> but malloc_alloc is -// unstandardized and not supported by newer GCCs. This ugly hack will go -// away soon! -#if (defined(__GNUC__) && (__GNUC__ == 2) && (__GNUC_MINOR__ < 97)) || (defined(G__GNUC) && (G__GNUC == 2) && (G__GNUC_MINOR < 97)) - typedef std::vector exvector; -#else - typedef std::vector exvector; +typedef std::vector exvector; +typedef std::set exset; +typedef std::map exmap; + +// Define this to enable some statistical output for comparisons and hashing +#undef GINAC_COMPARE_STATISTICS + +#ifdef GINAC_COMPARE_STATISTICS +class compare_statistics_t { +public: + compare_statistics_t() + : total_compares(0), nontrivial_compares(0), total_basic_compares(0), compare_same_hashvalue(0), compare_same_type(0), + total_is_equals(0), nontrivial_is_equals(0), total_basic_is_equals(0), is_equal_same_hashvalue(0), is_equal_same_type(0), + total_gethash(0), gethash_cached(0) {} + ~compare_statistics_t(); + + unsigned long total_compares; + unsigned long nontrivial_compares; + unsigned long total_basic_compares; + unsigned long compare_same_hashvalue; + unsigned long compare_same_type; + + unsigned long total_is_equals; + unsigned long nontrivial_is_equals; + unsigned long total_basic_is_equals; + unsigned long is_equal_same_hashvalue; + unsigned long is_equal_same_type; + + unsigned long total_gethash; + unsigned long gethash_cached; +}; + +extern compare_statistics_t compare_statistics; #endif -/** This class is the ABC (abstract base class) of GiNaC's class hierarchy. - * It is responsible for the reference counting. */ -class basic + +/** Function object for map(). */ +struct map_function { + virtual ~map_function() {} + typedef const ex & argument_type; + typedef ex result_type; + virtual ex operator()(const ex & e) = 0; +}; + + +/** 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. */ +class basic : public refcounted { GINAC_DECLARE_REGISTERED_CLASS_NO_CTORS(basic, void) friend class ex; - // default ctor, dtor, copy ctor assignment operator and helpers + // default constructor, destructor, copy constructor and assignment operator +protected: + basic() : flags(0) {} + public: - basic() : tinfo_key(TINFO_basic), flags(0), refcount(0) - { - /* debugmsg("basic default ctor", LOGLEVEL_CONSTRUCT); */ - } - /** basic dtor, virtual because class ex will delete objects via ptr. */ + /** basic destructor, virtual because class ex will delete objects of + * derived classes via a basic*. */ virtual ~basic() { - /* debugmsg("basic dtor", LOGLEVEL_DESTRUCT); */ - destroy(false); - GINAC_ASSERT((!(flags & status_flags::dynallocated))||(refcount==0)); + GINAC_ASSERT((!(flags & status_flags::dynallocated)) || (get_refcount() == 0)); } basic(const basic & other); const basic & operator=(const basic & other); + protected: - /** For use by copy ctor and assignment operator. */ - void copy(const basic & other) - { - flags = other.flags & ~status_flags::dynallocated; - hashvalue = other.hashvalue; - tinfo_key = other.tinfo_key; - } - /** For use by dtor and assignment operator. */ - virtual void destroy(bool call_parent) { } - - // 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 - // new virtual functions which can be overridden by derived classes public: // only const functions please (may break reference counting) - virtual basic * duplicate() const; + + /** 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; + virtual ex eval_integ() const; +protected: + virtual ex eval_ncmul(const exvector & v) const; +public: + virtual ex eval_indexed(const basic & i) const; + + // printing virtual void print(const print_context & c, unsigned level = 0) const; - virtual void dbgprint(void) const; - virtual void dbgprinttree(void) const; + virtual void dbgprint() const; + virtual void dbgprinttree() const; + virtual unsigned precedence() const; + + // info virtual bool info(unsigned inf) const; - virtual unsigned nops() const; - virtual ex op(int i) const; - virtual ex & let_op(int i); + + // operand access + virtual size_t nops() const; + virtual ex op(size_t i) const; virtual ex operator[](const ex & index) const; - virtual ex operator[](int i) const; - virtual bool has(const ex & other) 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, unsigned options = 0) const; + virtual bool match(const ex & pattern, exmap & repls) const; +protected: + virtual bool match_same_type(const basic & other) const; +public: + + // substitutions + virtual ex subs(const exmap & m, unsigned options = 0) const; + + // function mapping + virtual ex map(map_function & f) const; + + // visitors and tree traversal + virtual void accept(GiNaC::visitor & v) const + { + if (visitor *p = dynamic_cast(&v)) + p->visit(*this); + } + + // degree/coeff + virtual bool is_polynomial(const ex & var) 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; + + // expand/collect + virtual ex expand(unsigned options = 0) 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; + + // 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; - virtual ex subs(const lst & ls, const lst & lr) 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; + + // rational functions + virtual ex normal(exmap & repl, exmap & rev_lookup, int level = 0) const; + virtual ex to_rational(exmap & repl) const; + virtual ex to_polynomial(exmap & repl) const; + + // polynomial algorithms + virtual numeric integer_content() 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 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; -protected: // non-const functions should be called from class ex only - virtual ex derivative(const symbol & s) const; + + // noncommutativity + virtual unsigned return_type() const; + virtual return_type_t return_type_tinfo() const; + + // functions for complex expressions + virtual ex conjugate() const; + virtual ex real_part() const; + virtual ex imag_part() const; + + // functions that should be called from class ex only +protected: 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 unsigned calchash(void) const; - virtual ex expand(unsigned options = 0) const; + + virtual unsigned calchash() const; // non-virtual functions in this class public: - ex subs(const ex & e) const; - ex diff(const symbol & s, unsigned nth=1) const; + /** Like print(), but dispatch to the specified class. Can be used by + * implementations of print methods to dispatch to the method of the + * superclass. + * + * @see basic::print */ + template + void print_dispatch(const print_context & c, unsigned level) const + { + print_dispatch(T::get_class_info_static(), c, level); + } + + void print_dispatch(const registered_class_info & ri, const print_context & c, unsigned level) const; + + /** Save (serialize) the object into archive node. + * + * Losely speaking, this method turns an expression into a byte + * stream (which can be saved and restored later on, or sent via + * network, etc.) + */ + virtual void archive(archive_node& n) const; + /** Load (deserialize) the object from an archive node. + * + * @note This method is essentially a constructor. However, + * constructors can't be virtual. So, if unarchiving routines + * are implemented as constructors one would need to define such + * a constructor in every class, even if all it does is simply + * calling constructor of a superclass. + */ + virtual void read_archive(const archive_node& n, lst& syms); // no const + + 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(void) const; - unsigned gethash(void) const { if (flags & status_flags::hash_calculated) return hashvalue; else return calchash(); } - unsigned tinfo(void) const {return tinfo_key;} + const basic & hold() const; + + unsigned gethash() const + { +#ifdef GINAC_COMPARE_STATISTICS + compare_statistics.total_gethash++; +#endif + if (flags & status_flags::hash_calculated) { +#ifdef GINAC_COMPARE_STATISTICS + compare_statistics.gethash_cached++; +#endif + return hashvalue; + } else { + return calchash(); + } + } /** Set some status_flags. */ const basic & setflag(unsigned f) const {flags |= f; return *this;} @@ -154,44 +285,40 @@ 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; + void ensure_if_modifiable() const; + + void do_print(const print_context & c, unsigned level) const; + void do_print_tree(const print_tree & c, unsigned level) const; + void do_print_python_repr(const print_python_repr & c, unsigned level) const; // 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 -private: - unsigned refcount; ///< Number of reference counts }; + // global variables extern int max_recursion_level; -// convenience macros - -/** Check if OBJ is a TYPE, including base classes. */ -#define is_of_type(OBJ,TYPE) \ - (dynamic_cast(&OBJ)!=0) -/** Check if OBJ is a TYPE, not including base classes. */ -#define is_exactly_of_type(OBJ,TYPE) \ - ((OBJ).tinfo()==GiNaC::TINFO_##TYPE) +// convenience type checker template functions -/** Check if ex is a handle to a TYPE, including base classes. */ -#define is_ex_of_type(OBJ,TYPE) \ - (dynamic_cast((OBJ).bp)!=0) +/** Check if obj is a T, including base classes. */ +template +inline bool is_a(const basic &obj) +{ + return dynamic_cast(&obj) != 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) +/** Check if obj is a T, not including base classes. */ +template +inline bool is_exactly_a(const basic & obj) +{ + return typeid(T) == typeid(obj); +} } // namespace GiNaC