X-Git-Url: https://www.ginac.de/ginac.git//ginac.git?p=ginac.git;a=blobdiff_plain;f=ginac%2Fbasic.h;h=9895902b5d85be488acf4c2a5a209254f81ca966;hp=87dc1deee5669b729dffc5a980c64411acfa3a8d;hb=a8030df4915df6a1ea0312cbffb79ace4795c865;hpb=26741891dadf23162799009b6fd57b4984bd4ce5 diff --git a/ginac/basic.h b/ginac/basic.h index 87dc1dee..9895902b 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-2001 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 @@ -24,201 +24,174 @@ #define __GINAC_BASIC_H__ #include -#include #include -// CINT needs to work properly with +// CINT needs to work properly with #include -#include -#include -#include +#include "flags.h" +#include "tinfos.h" +#include "assertion.h" +#include "registrar.h" +/*#include "debugmsg.h"*/ -#ifndef NO_GINAC_NAMESPACE namespace GiNaC { -#endif // ndef NO_GINAC_NAMESPACE -class basic; class ex; class symbol; class lst; class numeric; - -//typedef vector exvector; -typedef vector exvector; // CINT does not like vector<...,default_alloc> - -#define INLINE_BASIC_CONSTRUCTORS +class relational; +class archive_node; +class print_context; + +// 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 exvector; +#else + typedef std::vector exvector; +#endif /** 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) - { - } -#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() : 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. */ + virtual ~basic() + { + /* debugmsg("basic dtor", LOGLEVEL_DESTRUCT); */ + 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) - { - } -#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) + { + /* 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(ostream & os,unsigned upper_precedence=0) const; - virtual void printraw(ostream & os) const; - virtual void printtree(ostream & os, unsigned indent) 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; + 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 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 bool has(const ex & other) 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) const; + virtual ex eval(int level = 0) const; + virtual ex evalf(int level = 0) const; + 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; + 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 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 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 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 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; + ex subs(const ex & e) 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;} + + /** Get relative precedence level (useful for implementing pretty-printed + * output). */ + unsigned get_precedence(void) const {return precedence;} -// member variables - protected: - unsigned tinfo_key; - mutable unsigned flags; - mutable unsigned hashvalue; - static unsigned precedence; - static unsigned delta_indent; + void ensure_if_modifiable(void) 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; + 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; // convenience macros -#ifndef NO_GINAC_NAMESPACE - +/** Check if OBJ is a TYPE, including base classes. */ #define is_of_type(OBJ,TYPE) \ - (dynamic_cast(const_cast(&OBJ))!=0) + (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) + ((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_cast((OBJ).bp))!=0) + (dynamic_cast((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) + ((*(OBJ).bp).tinfo()==GiNaC::TINFO_##TYPE) -#else // ndef NO_GINAC_NAMESPACE - -#define is_of_type(OBJ,TYPE) \ - (dynamic_cast(const_cast(&OBJ))!=0) - -#define is_exactly_of_type(OBJ,TYPE) \ - ((OBJ).tinfo()==TINFO_##TYPE) - -#define is_ex_of_type(OBJ,TYPE) \ - (dynamic_cast(const_cast((OBJ).bp))!=0) - -#define is_ex_exactly_of_type(OBJ,TYPE) \ - ((*(OBJ).bp).tinfo()==TINFO_##TYPE) - -#endif // ndef NO_GINAC_NAMESPACE - -#ifndef NO_GINAC_NAMESPACE } // namespace GiNaC -#endif // ndef NO_GINAC_NAMESPACE #endif // ndef __GINAC_BASIC_H__ -