X-Git-Url: https://www.ginac.de/ginac.git//ginac.git?p=ginac.git;a=blobdiff_plain;f=ginac%2Fbasic.h;h=12a958c657ee317ebe32aa9706fd771f84066fad;hp=943939041d442ffa5e681c8f6ab2d22de0a4c789;hb=d54e497297f4687c385ff8fbc91296365887c7c0;hpb=a8507b8af1c08d9b27d98d57f95c7ca1a8671e27 diff --git a/ginac/basic.h b/ginac/basic.h index 94393904..12a958c6 100644 --- a/ginac/basic.h +++ b/ginac/basic.h @@ -1,8 +1,9 @@ /** @file basic.h * - * Interface to GiNaC's ABC. - * - * GiNaC Copyright (C) 1999 Johannes Gutenberg University Mainz, Germany + * Interface to GiNaC's ABC. */ + +/* + * 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 @@ -22,232 +23,238 @@ #ifndef __GINAC_BASIC_H__ #define __GINAC_BASIC_H__ -#include -#include +#include // for size_t #include +#include +// CINT needs to work properly with +#include + +#include "flags.h" +#include "tinfos.h" +#include "ptr.h" +#include "assertion.h" +#include "registrar.h" + +namespace GiNaC { -class basic; class ex; +class ex_is_less; class symbol; -class lst; class numeric; +class relational; +class archive_node; +class print_context; -typedef vector exvector; +typedef std::vector exvector; +typedef std::map exmap; -#define INLINE_BASIC_CONSTRUCTORS -/** 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; +/** Function object for map(). */ +struct map_function { + typedef const ex & argument_type; + typedef ex result_type; + virtual ex operator()(const ex & e) = 0; +}; -// member functions - // default constructor, destructor, copy constructor assignment operator and helpers -public: - basic() -#ifdef INLINE_BASIC_CONSTRUCTORS - : tinfo_key(TINFO_BASIC), flags(0), refcount(0) - { - debugmsg("basic default constructor",LOGLEVEL_CONSTRUCT); - // nothing to do - } -#else -; -#endif // def INLINE_BASIC_CONSTRUCTORS - - virtual ~basic() -#ifdef INLINE_BASIC_CONSTRUCTORS - { - debugmsg("basic destructor",LOGLEVEL_DESTRUCT); - destroy(0); - ASSERT((!(flags & status_flags::dynallocated))||(refcount==0)); - } -#else -; -#endif // def INLINE_BASIC_CONSTRUCTORS - - basic(basic const & other) -#ifdef INLINE_BASIC_CONSTRUCTORS - { - debugmsg("basic copy constructor",LOGLEVEL_CONSTRUCT); - copy(other); - } -#else -; -#endif // def INLINE_BASIC_CONSTRUCTORS - - virtual basic const & operator=(basic const & other); - +/** 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: - 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) - { - debugmsg("basic constructor with tinfo_key",LOGLEVEL_CONSTRUCT); - // nothing to do - } -#else -; -#endif // def INLINE_BASIC_CONSTRUCTORS - - // 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 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 -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;} -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 ~visitor() {} +}; + -// member variables - +/** 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 constructor, destructor, copy constructor and assignment operator protected: - unsigned tinfo_key; - mutable unsigned flags; - mutable unsigned hashvalue; - static unsigned precedence; - static unsigned delta_indent; -private: - unsigned refcount; -}; + basic() : tinfo_key(TINFO_basic), flags(0) {} -// global constants +public: + /** basic destructor, virtual because class ex will delete objects of + * derived classes via a basic*. */ + virtual ~basic() + { + GINAC_ASSERT((!(flags & status_flags::dynallocated)) || (get_refcount() == 0)); + } + basic(const basic & other); + const basic & operator=(const basic & other); -extern const basic some_basic; -extern type_info const & typeid_basic; +protected: + /** 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) {} + + // new virtual functions which can be overridden by derived classes +public: // only const functions please (may break reference counting) -// global variables + /** 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); } -extern int max_recursion_level; + // 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: + 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: + virtual bool match_same_type(const basic & other) const; +public: -/* -#ifndef _DEBUG -*/ -#define is_of_type(OBJ,TYPE) \ - (dynamic_cast(const_cast(&OBJ))!=0) + // substitutions + virtual ex subs(const exmap & m, unsigned options = 0) const; -/* -#define is_exactly_of_type(OBJ,TYPE) \ - (typeid(OBJ)==typeid(some_##TYPE)) -*/ -#define is_exactly_of_type(OBJ,TYPE) \ - ((OBJ).tinfo()==(some_##TYPE).tinfo()) + // 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); + } - /* -#else -#define is_of_type(OBJ,TYPE) \ - (ASSERT(typeid(OBJ)!=typeid(exZERO())), \ - (dynamic_cast(const_cast(&OBJ))!=0)) + // 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; -#define is_exactly_of_type(OBJ,TYPE) \ - (ASSERT(typeid(OBJ)!=typeid(exZERO())), \ - (typeid(OBJ)==typeid(some_##TYPE)) -#endif // ndef _DEBUG -*/ + // expand/collect + virtual ex expand(unsigned options = 0) const; + virtual ex collect(const ex & s, bool distributed = false) const; -#define is_ex_of_type(OBJ,TYPE) \ - (dynamic_cast(const_cast((OBJ).bp))!=0) + // 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, 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() 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: + /** 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; + + 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;} + + /** 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;} -/* -#define is_ex_exactly_of_type(OBJ,TYPE) \ - (typeid(*(OBJ).bp)==typeid(some_##TYPE)) -*/ +protected: + void ensure_if_modifiable() const; -#define is_ex_exactly_of_type(OBJ,TYPE) \ - ((*(OBJ).bp).tinfo()==(some_##TYPE).tinfo()) + 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 +}; -#define are_ex_trivially_equal(EX1,EX2) \ - ((EX1).bp==(EX2).bp) -// global functions +// global variables -inline unsigned rotate_left_31(unsigned n) -{ - // clear highest bit and shift 1 bit to the left - n=(n & 0x7FFFFFFFU) << 1; +extern int max_recursion_level; - // overflow? clear highest bit and set lowest bit - if (n & 0x80000000U) { - n=(n & 0x7FFFFFFFU) | 0x00000001U; - } - ASSERT(n<0x80000000U); +// convenience type checker template functions - return n; +/** Check if obj is a T, including base classes. */ +template +inline bool is_a(const basic &obj) +{ + return dynamic_cast(&obj) != 0; } -inline unsigned golden_ratio_hash(unsigned n) +/** 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 +inline bool is_exactly_a(const basic &obj) { -#if 0 - // This requires ´long long´ (or an equivalent 64 bit type)---which is, - // unfortunately, not ANSI-compliant: - unsigned long long l = n * 0x4f1bbcddLL; - return (l & 0x7fffffffU) ^ (l >> 32); -#else - // This requires ´long double´ to have a mantissa of at least 64 bit--- - // which is not guaranteed by any standard: - const static long double golden_ratio=.618033988749894848204586834370; - long double m=golden_ratio*n; - return unsigned((m-int(m))*0x80000000); -#endif + return obj.tinfo() == T::get_class_info_static().options.get_id(); } +} // namespace GiNaC + #endif // ndef __GINAC_BASIC_H__