X-Git-Url: https://www.ginac.de/ginac.git//ginac.git?p=ginac.git;a=blobdiff_plain;f=ginac%2Fex.h;h=34ce8b8c489634528271e1612585d734f12036c5;hp=b5e511e6e51f9330904e63908456148d77ec48b8;hb=df5f8db62815995d87ebd4f97a5dbc0d1a327b94;hpb=af0c47009ca7a15af966430bdf1a72fe05c1c6f9 diff --git a/ginac/ex.h b/ginac/ex.h index b5e511e6..34ce8b8c 100644 --- a/ginac/ex.h +++ b/ginac/ex.h @@ -3,7 +3,7 @@ * Interface to GiNaC's light-weight expression handles. */ /* - * GiNaC Copyright (C) 1999-2000 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 @@ -23,365 +23,302 @@ #ifndef __GINAC_EX_H__ #define __GINAC_EX_H__ -#include #include "basic.h" #include "operators.h" -#ifndef NO_NAMESPACE_GINAC namespace GiNaC { -#endif // ndef NO_NAMESPACE_GINAC +// Sorry, this is the only constant to pollute the global scope, the other ones +// are defined in utils.h and not visible from outside. class ex; -class expand_options; -class status_flags; +extern const ex & _ex0(void); ///< single ex(numeric(0)) class symbol; class lst; - -// Sorry, this is the only constant to pollute the global scope, the other ones -// are defined in utils.h and not visible from outside. -extern const ex & _ex0(void); // single ex(numeric(0)) - -#define INLINE_EX_CONSTRUCTORS +class scalar_products; /** Lightweight wrapper for GiNaC's symbolic objects. Basically all it does is * to hold a pointer to the other objects, manage the reference counting and - * provide methods for manipulation of these objects. */ + * provide methods for manipulation of these objects. (Some people call such + * a thing a proxy class.) */ class ex { - friend class basic; - + friend class basic; + // member functions - - // default constructor, destructor, copy constructor assignment operator and helpers + + // default ctor, dtor, copy ctor assignment operator and helpers +public: + ex(); + ~ex(); + ex(const ex & other); + ex & operator=(const ex & other); + // other ctors public: - ex() -#ifdef INLINE_EX_CONSTRUCTORS - : bp(_ex0().bp) - { - GINAC_ASSERT(_ex0().bp!=0); - GINAC_ASSERT(_ex0().bp->flags & status_flags::dynallocated); - GINAC_ASSERT(bp!=0); - ++bp->refcount; + ex(const basic & other); + ex(int i); + ex(unsigned int i); + ex(long i); + ex(unsigned long i); + ex(double const d); + /** Construct ex from string and a list of symbols. The input grammar is + * similar to the GiNaC output format. All symbols to be used in the + * expression must be specified in a lst in the second argument. Undefined + * symbols and other parser errors will throw an exception. */ + ex(const std::string &s, const ex &l); + + // functions overriding virtual functions from bases classes + // none + + // new virtual functions which can be overridden by derived classes + // none + + // non-virtual functions in this class +public: + void swap(ex & other); + void print(const print_context & c, unsigned level = 0) const; + void printtree(std::ostream & os) const; + void dbgprint(void) const; + void dbgprinttree(void) const; + bool info(unsigned inf) const { return bp->info(inf); } + unsigned nops() const { return bp->nops(); } + ex expand(unsigned options=0) const; + bool has(const ex & other) const { return bp->has(other); } + int degree(const ex & s) const { return bp->degree(s); } + int ldegree(const ex & s) const { return bp->ldegree(s); } + ex coeff(const ex & s, int n = 1) const { return bp->coeff(s, n); } + ex lcoeff(const ex & s) const { return coeff(s, degree(s)); } + ex tcoeff(const ex & s) const { return coeff(s, ldegree(s)); } + ex numer(void) const; + ex denom(void) const; + ex unit(const symbol &x) const; + ex content(const symbol &x) const; + numeric integer_content(void) const; + ex primpart(const symbol &x) const; + ex primpart(const symbol &x, const ex &cont) const; + ex normal(int level = 0) const; + ex to_rational(lst &repl_lst) const; + ex smod(const numeric &xi) const; + numeric max_coefficient(void) const; + ex collect(const ex & s, bool distributed = false) const { return bp->collect(s, distributed); } + ex eval(int level = 0) const { return bp->eval(level); } + ex evalf(int level = 0) const { return bp->evalf(level); } + ex diff(const symbol & s, unsigned nth = 1) const; + ex series(const ex & r, int order, unsigned options = 0) const; + bool match(const ex & pattern) const; + bool match(const ex & pattern, lst & repl_lst) const { return bp->match(pattern, repl_lst); } + ex subs(const lst & ls, const lst & lr, bool no_pattern = false) const { return bp->subs(ls, lr, no_pattern); } + ex subs(const ex & e, bool no_pattern = false) const { return bp->subs(e, no_pattern); } + exvector get_free_indices(void) const { return bp->get_free_indices(); } + ex simplify_indexed(void) const; + ex simplify_indexed(const scalar_products & sp) const; + ex simplify_ncmul(const exvector & v) const { return bp->simplify_ncmul(v); } + ex operator[](const ex & index) const; + ex operator[](int i) const; + ex op(int i) const { return bp->op(i); } + ex & let_op(int i); + ex lhs(void) const; + ex rhs(void) const; + int compare(const ex & other) const; + bool is_equal(const ex & other) const; + bool is_zero(void) const { return is_equal(_ex0()); } + + unsigned return_type(void) const { return bp->return_type(); } + unsigned return_type_tinfo(void) const { return bp->return_type_tinfo(); } + unsigned gethash(void) const { return bp->gethash(); } +private: + void construct_from_basic(const basic & other); + void construct_from_int(int i); + void construct_from_uint(unsigned int i); + void construct_from_long(long i); + void construct_from_ulong(unsigned long i); + void construct_from_double(double d); + void construct_from_string_and_lst(const std::string &s, const ex &l); + void makewriteable(); + #ifdef OBSCURE_CINT_HACK - update_last_created_or_assigned_bp(); +public: + static bool last_created_or_assigned_bp_can_be_converted_to_ex(void) + { + if (last_created_or_assigned_bp==0) return false; + if ((last_created_or_assigned_bp->flags & + status_flags::dynallocated)==0) return false; + if ((last_created_or_assigned_bp->flags & + status_flags::evaluated)==0) return false; + return true; + } +protected: + void update_last_created_or_assigned_bp(void) + { + if (last_created_or_assigned_bp!=0) { + if (--last_created_or_assigned_bp->refcount == 0) { + delete last_created_or_assigned_bp; + } + } + last_created_or_assigned_bp = bp; + ++last_created_or_assigned_bp->refcount; + last_created_or_assigned_exp = (long)(void *)(this); + } #endif // def OBSCURE_CINT_HACK - } -#else -; -#endif // def INLINE_EX_CONSTRUCTORS - - ~ex() -#ifdef INLINE_EX_CONSTRUCTORS - { - GINAC_ASSERT(bp!=0); - GINAC_ASSERT(bp->flags & status_flags::dynallocated); - if (--bp->refcount == 0) { - delete bp; - } - } -#else -; -#endif // def INLINE_EX_CONSTRUCTORS - - ex(const ex & other) -#ifdef INLINE_EX_CONSTRUCTORS - : bp(other.bp) - { - GINAC_ASSERT(bp!=0); - GINAC_ASSERT((bp->flags) & status_flags::dynallocated); - ++bp->refcount; + +// member variables + +public: + basic *bp; ///< pointer to basic object managed by this #ifdef OBSCURE_CINT_HACK - update_last_created_or_assigned_bp(); + static basic * last_created_or_assigned_bp; + static basic * dummy_bp; + static long last_created_or_assigned_exp; #endif // def OBSCURE_CINT_HACK - } -#else -; -#endif // def INLINE_EX_CONSTRUCTORS - - const ex & operator=(const ex & other) -#ifdef INLINE_EX_CONSTRUCTORS - { - GINAC_ASSERT(bp!=0); - GINAC_ASSERT(bp->flags & status_flags::dynallocated); - GINAC_ASSERT(other.bp!=0); - GINAC_ASSERT(other.bp->flags & status_flags::dynallocated); - ++other.bp->refcount; - basic * tmpbp=other.bp; - if (--bp->refcount==0) { - delete bp; - } - bp=tmpbp; +}; + + +// performance-critical inlined method implementations + +inline +ex::ex() : bp(_ex0().bp) +{ + /*debugmsg("ex default ctor",LOGLEVEL_CONSTRUCT);*/ + GINAC_ASSERT(_ex0().bp!=0); + GINAC_ASSERT(_ex0().bp->flags & status_flags::dynallocated); + GINAC_ASSERT(bp!=0); + ++bp->refcount; #ifdef OBSCURE_CINT_HACK - update_last_created_or_assigned_bp(); + update_last_created_or_assigned_bp(); #endif // def OBSCURE_CINT_HACK - return *this; - } -#else -; -#endif // def INLINE_EX_CONSTRUCTORS - -#ifdef CINT_CONVERSION_WORKAROUND - // workaround to fix the missing automatic derived->basic->ex conversion - const ex & operator=(const basic & other) - { - return *this=ex(other); - } -#endif // def CINT_CONVERSION_WORKAROUND - - // other constructors -public: - ex(const basic & other) -#ifdef INLINE_EX_CONSTRUCTORS - { - construct_from_basic(other); +} + +inline +ex::~ex() +{ + /*debugmsg("ex dtor",LOGLEVEL_DESTRUCT);*/ + GINAC_ASSERT(bp!=0); + GINAC_ASSERT(bp->flags & status_flags::dynallocated); + if (--bp->refcount == 0) + delete bp; +} + +inline +ex::ex(const ex & other) : bp(other.bp) +{ + /*debugmsg("ex copy ctor",LOGLEVEL_CONSTRUCT);*/ + GINAC_ASSERT(bp!=0); + GINAC_ASSERT((bp->flags) & status_flags::dynallocated); + ++bp->refcount; #ifdef OBSCURE_CINT_HACK - update_last_created_or_assigned_bp(); + update_last_created_or_assigned_bp(); #endif // def OBSCURE_CINT_HACK - } -#else -; -#endif // def INLINE_EX_CONSTRUCTORS - - ex(int i) -#ifdef INLINE_EX_CONSTRUCTORS - { - construct_from_int(i); +} + +inline +ex & ex::operator=(const ex & other) +{ + /*debugmsg("ex operator=",LOGLEVEL_ASSIGNMENT);*/ + GINAC_ASSERT(bp!=0); + GINAC_ASSERT(bp->flags & status_flags::dynallocated); + GINAC_ASSERT(other.bp!=0); + GINAC_ASSERT(other.bp->flags & status_flags::dynallocated); + // NB: must first increment other.bp->refcount, since other might be *this. + ++other.bp->refcount; + if (--bp->refcount==0) + delete bp; + bp = other.bp; #ifdef OBSCURE_CINT_HACK - update_last_created_or_assigned_bp(); + update_last_created_or_assigned_bp(); #endif // def OBSCURE_CINT_HACK - } -#else -; -#endif // def INLINE_EX_CONSTRUCTORS - - ex(unsigned int i) -#ifdef INLINE_EX_CONSTRUCTORS - { - construct_from_uint(i); + return *this; +} + +inline +ex::ex(const basic & other) +{ + /*debugmsg("ex ctor from basic",LOGLEVEL_CONSTRUCT);*/ + construct_from_basic(other); #ifdef OBSCURE_CINT_HACK - update_last_created_or_assigned_bp(); + update_last_created_or_assigned_bp(); #endif // def OBSCURE_CINT_HACK - } -#else -; -#endif // def INLINE_EX_CONSTRUCTORS - - ex(long i) -#ifdef INLINE_EX_CONSTRUCTORS - { - construct_from_long(i); +} + +inline +ex::ex(int i) +{ + /*debugmsg("ex ctor from int",LOGLEVEL_CONSTRUCT);*/ + construct_from_int(i); #ifdef OBSCURE_CINT_HACK - update_last_created_or_assigned_bp(); + update_last_created_or_assigned_bp(); #endif // def OBSCURE_CINT_HACK - } -#else -; -#endif // def INLINE_EX_CONSTRUCTORS - - ex(unsigned long i) -#ifdef INLINE_EX_CONSTRUCTORS - { - construct_from_ulong(i); +} + +inline +ex::ex(unsigned int i) +{ + /*debugmsg("ex ctor from unsigned int",LOGLEVEL_CONSTRUCT);*/ + construct_from_uint(i); #ifdef OBSCURE_CINT_HACK - update_last_created_or_assigned_bp(); + update_last_created_or_assigned_bp(); #endif // def OBSCURE_CINT_HACK - } -#else -; -#endif // def INLINE_EX_CONSTRUCTORS - - ex(double const d) -#ifdef INLINE_EX_CONSTRUCTORS - { - construct_from_double(d); +} + +inline +ex::ex(long i) +{ + /*debugmsg("ex ctor from long",LOGLEVEL_CONSTRUCT);*/ + construct_from_long(i); #ifdef OBSCURE_CINT_HACK - update_last_created_or_assigned_bp(); + update_last_created_or_assigned_bp(); #endif // def OBSCURE_CINT_HACK - } -#else -; -#endif // def INLINE_EX_CONSTRUCTORS - - /** Construct ex from string and a list of symbols. The input grammar is - * similar to the GiNaC output format. All symbols to be used in the - * expression must be specified in a lst in the second argument. Undefined - * symbols and other parser errors will throw an exception. */ - ex(const string &s, const ex &l) -#ifdef INLINE_EX_CONSTRUCTORS - { - construct_from_string_and_lst(s, l); +} + +inline +ex::ex(unsigned long i) +{ + /*debugmsg("ex ctor from unsigned long",LOGLEVEL_CONSTRUCT);*/ + construct_from_ulong(i); #ifdef OBSCURE_CINT_HACK - update_last_created_or_assigned_bp(); + update_last_created_or_assigned_bp(); #endif // def OBSCURE_CINT_HACK - } -#else -; -#endif // def INLINE_EX_CONSTRUCTORS - - - // functions overriding virtual functions from bases classes - // none - - // new virtual functions which can be overridden by derived classes - // none - - // non-virtual functions in this class -public: - void swap(ex & other); - void printraw(ostream & os) const; - void printtree(ostream & os, unsigned indent=0) const; - void print(ostream & os, unsigned upper_precedence=0) const; - void printcsrc(ostream & os, unsigned type, const char *var_name) const; - void dbgprint(void) const; - void dbgprinttree(void) const; - bool info(unsigned inf) const; - unsigned nops() const; - ex expand(unsigned options=0) const; - bool has(const ex & other) const; -#ifdef CINT_CONVERSION_WORKAROUND - bool has(basic const & other) const { return has(ex(other)); } -#endif // def CINT_CONVERSION_WORKAROUND - int degree(const symbol & s) const; - int ldegree(const symbol & s) const; - ex coeff(const symbol & s, int n=1) const; - ex lcoeff(const symbol & s) const { return coeff(s, degree(s)); } - ex tcoeff(const symbol & s) const { return coeff(s, ldegree(s)); } - ex numer(void) const; - ex denom(void) const; - ex unit(const symbol &x) const; - ex content(const symbol &x) const; - numeric integer_content(void) const; - ex primpart(const symbol &x) const; - ex primpart(const symbol &x, const ex &cont) const; -#ifdef CINT_CONVERSION_WORKAROUND - ex primpart(const symbol &x, const basic &cont) const { return primpart(x,ex(cont)); } -#endif // def CINT_CONVERSION_WORKAROUND - ex normal(int level = 0) const; - ex to_rational(lst &repl_lst) const; - ex smod(const numeric &xi) const; - numeric max_coefficient(void) const; - ex collect(const symbol & s) const; - ex eval(int level = 0) const; - ex evalf(int level = 0) const; - ex diff(const symbol & s, unsigned nth = 1) const; - ex series(const ex & r, int order) const; -#ifdef CINT_CONVERSION_WORKAROUND - ex series(const basic & r, int order) const { return series(ex(r),order); } -#endif // def CINT_CONVERSION_WORKAROUND - ex subs(const lst & ls, const lst & lr) const; - ex subs(const ex & e) const; -#ifdef CINT_CONVERSION_WORKAROUND - ex subs(const basic & e) const { return subs(ex(e)); } -#endif // def CINT_CONVERSION_WORKAROUND - exvector get_indices(void) const; - ex simplify_ncmul(const exvector & v) const; - ex operator[](const ex & index) const; -#ifdef CINT_CONVERSION_WORKAROUND - ex operator[](const basic & index) const { return operator[](ex(index)); } -#endif // def CINT_CONVERSION_WORKAROUND - ex operator[](int i) const; - ex op(int i) const; - ex & let_op(int i); - ex lhs(void) const; - ex rhs(void) const; - int compare(const ex & other) const -#ifdef INLINE_EX_CONSTRUCTORS - { - GINAC_ASSERT(bp!=0); - GINAC_ASSERT(other.bp!=0); - if (bp==other.bp) { - // special case: both expression point to same basic, trivially equal - return 0; - } - return bp->compare(*other.bp); - } -#else -; -#endif // def INLINE_EX_CONSTRUCTORS -#ifdef CINT_CONVERSION_WORKAROUND - int compare(const basic & other) const { return compare(ex(other)); } -#endif // def CINT_CONVERSION_WORKAROUND - bool is_equal(const ex & other) const -#ifdef INLINE_EX_CONSTRUCTORS - { - GINAC_ASSERT(bp!=0); - GINAC_ASSERT(other.bp!=0); - if (bp==other.bp) { - // special case: both expression point to same basic, trivially equal - return true; - } - return bp->is_equal(*other.bp); - } -#else -; -#endif // def INLINE_EX_CONSTRUCTORS -#ifdef CINT_CONVERSION_WORKAROUND - bool is_equal(const basic & other) const { return is_equal(ex(other)); } -#endif // def CINT_CONVERSION_WORKAROUND - bool is_zero(void) const {return compare(_ex0())==0;}; - - unsigned return_type(void) const; - unsigned return_type_tinfo(void) const; - unsigned gethash(void) const; - - ex exadd(const ex & rh) const; -#ifdef CINT_CONVERSION_WORKAROUND - ex exadd(const basic & rh) const { return exadd(ex(rh)); } -#endif // def CINT_CONVERSION_WORKAROUND - ex exmul(const ex & rh) const; -#ifdef CINT_CONVERSION_WORKAROUND - ex exmul(const basic & rh) const { return exmul(ex(rh)); } -#endif // def CINT_CONVERSION_WORKAROUND - ex exncmul(const ex & rh) const; -#ifdef CINT_CONVERSION_WORKAROUND - ex exncmul(const basic & rh) const { return exncmul(ex(rh)); } -#endif // def CINT_CONVERSION_WORKAROUND -private: - void construct_from_basic(const basic & other); - void construct_from_int(int i); - void construct_from_uint(unsigned int i); - void construct_from_long(long i); - void construct_from_ulong(unsigned long i); - void construct_from_double(double d); - void construct_from_string_and_lst(const string &s, const ex &l); - void makewriteable(); +} +inline +ex::ex(double const d) +{ + /*debugmsg("ex ctor from double",LOGLEVEL_CONSTRUCT);*/ + construct_from_double(d); #ifdef OBSCURE_CINT_HACK -public: - static bool last_created_or_assigned_bp_can_be_converted_to_ex(void) - { - if (last_created_or_assigned_bp==0) return false; - if ((last_created_or_assigned_bp->flags & - status_flags::dynallocated)==0) return false; - if ((last_created_or_assigned_bp->flags & - status_flags::evaluated)==0) return false; - return true; - } -protected: - void update_last_created_or_assigned_bp(void) - { - if (last_created_or_assigned_bp!=0) { - if (--last_created_or_assigned_bp->refcount == 0) { - delete last_created_or_assigned_bp; - } - } - last_created_or_assigned_bp=bp; - ++last_created_or_assigned_bp->refcount; - last_created_or_assigned_exp=(long)(void *)(this); - } + update_last_created_or_assigned_bp(); #endif // def OBSCURE_CINT_HACK +} -// member variables - -public: - basic *bp; +inline +ex::ex(const std::string &s, const ex &l) +{ + /*debugmsg("ex ctor from string,lst",LOGLEVEL_CONSTRUCT);*/ + construct_from_string_and_lst(s, l); #ifdef OBSCURE_CINT_HACK - static basic * last_created_or_assigned_bp; - static basic * dummy_bp; - static long last_created_or_assigned_exp; + update_last_created_or_assigned_bp(); #endif // def OBSCURE_CINT_HACK -}; +} + +inline +int ex::compare(const ex & other) const +{ + GINAC_ASSERT(bp!=0); + GINAC_ASSERT(other.bp!=0); + if (bp==other.bp) // trivial case: both expressions point to same basic + return 0; + return bp->compare(*other.bp); +} + +inline +bool ex::is_equal(const ex & other) const +{ + GINAC_ASSERT(bp!=0); + GINAC_ASSERT(other.bp!=0); + if (bp==other.bp) // trivial case: both expressions point to same basic + return true; + return bp->is_equal(*other.bp); +} + // utility functions inline bool are_ex_trivially_equal(const ex &e1, const ex &e2) @@ -399,13 +336,13 @@ inline ex expand(const ex & thisex, unsigned options = 0) inline bool has(const ex & thisex, const ex & other) { return thisex.has(other); } -inline int degree(const ex & thisex, const symbol & s) +inline int degree(const ex & thisex, const ex & s) { return thisex.degree(s); } -inline int ldegree(const ex & thisex, const symbol & s) +inline int ldegree(const ex & thisex, const ex & s) { return thisex.ldegree(s); } -inline ex coeff(const ex & thisex, const symbol & s, int n=1) +inline ex coeff(const ex & thisex, const ex & s, int n=1) { return thisex.coeff(s, n); } inline ex numer(const ex & thisex) @@ -420,8 +357,8 @@ inline ex normal(const ex & thisex, int level=0) inline ex to_rational(const ex & thisex, lst & repl_lst) { return thisex.to_rational(repl_lst); } -inline ex collect(const ex & thisex, const symbol & s) -{ return thisex.collect(s); } +inline ex collect(const ex & thisex, const ex & s, bool distributed = false) +{ return thisex.collect(s, distributed); } inline ex eval(const ex & thisex, int level = 0) { return thisex.eval(level); } @@ -432,8 +369,11 @@ inline ex evalf(const ex & thisex, int level = 0) inline ex diff(const ex & thisex, const symbol & s, unsigned nth = 1) { return thisex.diff(s, nth); } -inline ex series(const ex & thisex, const ex & r, int order) -{ return thisex.series(r, order); } +inline ex series(const ex & thisex, const ex & r, int order, unsigned options = 0) +{ return thisex.series(r, order, options); } + +inline bool match(const ex & thisex, const ex & pattern, lst & repl_lst) +{ return thisex.match(pattern, repl_lst); } inline ex subs(const ex & thisex, const ex & e) { return thisex.subs(e); } @@ -456,9 +396,6 @@ inline bool is_zero(const ex & thisex) inline void swap(ex & e1, ex & e2) { e1.swap(e2); } -#ifndef NO_NAMESPACE_GINAC } // namespace GiNaC -#endif // ndef NO_NAMESPACE_GINAC #endif // ndef __GINAC_EX_H__ -