X-Git-Url: https://www.ginac.de/ginac.git//ginac.git?p=ginac.git;a=blobdiff_plain;f=ginac%2Fbasic.h;h=d7fef59385856882a370e4f8383e67700a784e63;hp=943939041d442ffa5e681c8f6ab2d22de0a4c789;hb=2dcbb3a4955e294d62b45c3db8bdccb7d6fdf833;hpb=a8507b8af1c08d9b27d98d57f95c7ca1a8671e27 diff --git a/ginac/basic.h b/ginac/basic.h index 94393904..d7fef593 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-2002 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,195 @@ #ifndef __GINAC_BASIC_H__ #define __GINAC_BASIC_H__ -#include -#include #include +// CINT needs to work properly with +#include + +#include "flags.h" +#include "tinfos.h" +#include "assertion.h" +#include "registrar.h" + +namespace GiNaC { -class basic; class ex; class symbol; class lst; class numeric; +class relational; +class archive_node; +class print_context; -typedef vector exvector; +typedef std::vector exvector; + + +/** Function object for map(). */ +struct map_function { + typedef const ex & argument_type; + typedef ex result_type; + virtual ex operator()(const ex & e) = 0; +}; -#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; - -// member functions - - // default constructor, destructor, copy constructor assignment operator and helpers + GINAC_DECLARE_REGISTERED_CLASS_NO_CTORS(basic, void) + + friend class ex; + + // default ctor, dtor, copy ctor, 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); - + basic() : tinfo_key(TINFO_basic), flags(0), refcount(0) {} + /** basic dtor, virtual because class ex will delete objects via ptr. */ + virtual ~basic() + { + destroy(false); + 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) - { - 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 + /** 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) {} + + // 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 + virtual basic * duplicate() 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 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 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 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 bool match_same_type(const basic & other) const; + virtual unsigned calchash(void) const; + virtual ex simplify_ncmul(const exvector & v) 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; + 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;} -// member variables - + /** Clear some status_flags. */ + const basic & clearflag(unsigned f) const {flags &= ~f; return *this;} + +protected: + void ensure_if_modifiable(void) const; + + // member variables protected: - unsigned tinfo_key; - mutable unsigned flags; - mutable unsigned hashvalue; - static unsigned precedence; - static unsigned delta_indent; + unsigned tinfo_key; ///< typeinfo + mutable unsigned flags; ///< of type status_flags + mutable unsigned hashvalue; ///< hash value private: - unsigned refcount; + unsigned refcount; ///< Number of reference counts }; -// global constants - -extern const basic some_basic; -extern type_info const & typeid_basic; - // global variables extern int max_recursion_level; -/* -#ifndef _DEBUG -*/ -#define is_of_type(OBJ,TYPE) \ - (dynamic_cast(const_cast(&OBJ))!=0) - -/* -#define is_exactly_of_type(OBJ,TYPE) \ - (typeid(OBJ)==typeid(some_##TYPE)) -*/ -#define is_exactly_of_type(OBJ,TYPE) \ - ((OBJ).tinfo()==(some_##TYPE).tinfo()) - - - /* -#else -#define is_of_type(OBJ,TYPE) \ - (ASSERT(typeid(OBJ)!=typeid(exZERO())), \ - (dynamic_cast(const_cast(&OBJ))!=0)) - -#define is_exactly_of_type(OBJ,TYPE) \ - (ASSERT(typeid(OBJ)!=typeid(exZERO())), \ - (typeid(OBJ)==typeid(some_##TYPE)) -#endif // ndef _DEBUG -*/ - -#define is_ex_of_type(OBJ,TYPE) \ - (dynamic_cast(const_cast((OBJ).bp))!=0) - -/* -#define is_ex_exactly_of_type(OBJ,TYPE) \ - (typeid(*(OBJ).bp)==typeid(some_##TYPE)) -*/ - -#define is_ex_exactly_of_type(OBJ,TYPE) \ - ((*(OBJ).bp).tinfo()==(some_##TYPE).tinfo()) - -#define are_ex_trivially_equal(EX1,EX2) \ - ((EX1).bp==(EX2).bp) +// convenience type checker template functions -// global functions - -inline unsigned rotate_left_31(unsigned n) +/** Check if obj is a T, including base classes. */ +template +inline bool is_a(const basic &obj) { - // clear highest bit and shift 1 bit to the left - n=(n & 0x7FFFFFFFU) << 1; + return dynamic_cast(&obj)!=0; +} - // overflow? clear highest bit and set lowest bit - if (n & 0x80000000U) { - n=(n & 0x7FFFFFFFU) | 0x00000001U; - } +/** 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 +inline bool is_exactly_a(const class basic &obj) +{ + const T foo; return foo.tinfo()==obj.tinfo(); +} - ASSERT(n<0x80000000U); +/** Check if ex is a handle to a T, including base classes. */ +template +inline bool is_a(const ex &obj) +{ + return is_a(*obj.bp); +} - return n; +/** Check if ex is a handle to a T, not including base classes. */ +template +inline bool is_exactly_a(const ex &obj) +{ + return is_exactly_a(*obj.bp); } -inline unsigned golden_ratio_hash(unsigned n) +/** 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() */ +template +inline const T &ex_to(const ex &e) { -#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 + GINAC_ASSERT(is_a(e)); + return static_cast(*e.bp); } +} // namespace GiNaC + #endif // ndef __GINAC_BASIC_H__