X-Git-Url: https://www.ginac.de/ginac.git//ginac.git?p=ginac.git;a=blobdiff_plain;f=ginac%2Fex.h;h=0aa96ebc0382f69fb92b9e11fbaad9990147c7a7;hp=499229e09072e4c972a61bf691457cab0bf76b0b;hb=f263f768cf609ae8c0899560449f235a6d408193;hpb=9961dfdd7a383f09b1040e195a8817a85d945e58 diff --git a/ginac/ex.h b/ginac/ex.h index 499229e0..0aa96ebc 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-2001 Johannes Gutenberg University Mainz, Germany + * 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 @@ -23,31 +23,59 @@ #ifndef __GINAC_EX_H__ #define __GINAC_EX_H__ +#include +#include + #include "basic.h" #include "operators.h" 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; -extern const ex & _ex0(void); ///< single ex(numeric(0)) +/** Helper class to initialize the library. There must be one static object + * of this class in every object file that makes use of our flyweights in + * order to guarantee proper initialization. Hence we put it into this + * file which is included by every relevant file anyways. This is modeled + * after section 27.4.2.1.6 of the C++ standard, where cout and friends are + * set up. + * + * @see utils.cpp */ +class library_init { +public: + library_init(); + ~library_init(); +private: + static int count; +}; +/** For construction of flyweights, etc. */ +static library_init library_initializer; + +// Current versions of Cint don't link data declared extern within functions. +// FIXME: Fix Cint and later remove this from here. +#if defined(G__CINTVERSION) +extern const class numeric *_num0_p; +#endif + class symbol; class lst; 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. (Some people call such * a thing a proxy class.) */ class ex { - friend class basic; + friend class archive_node; + friend bool are_ex_trivially_equal(const ex &, const ex &); + template friend const T &ex_to(const ex &); + template friend bool is_a(const ex &); + template friend bool is_exactly_a(const ex &); // member functions - // default ctor, dtor, copy ctor assignment operator and helpers + // default ctor, dtor, copy ctor, assignment operator and helpers public: ex(); ~ex(); @@ -67,12 +95,6 @@ public: * 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); @@ -83,7 +105,10 @@ public: 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); } + bool has(const ex & pattern) const { return bp->has(pattern); } + ex map(map_function & f) const { return bp->map(f); } + ex map(ex (*f)(const ex & e)) const; + bool find(const ex & pattern, lst & found) const; 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); } @@ -98,12 +123,13 @@ public: 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; + ex to_rational(lst &repl_lst) const { return bp->to_rational(repl_lst); } + ex smod(const numeric &xi) const { return bp->smod(xi); } 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 evalm(void) const { return bp->evalm(); } 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; @@ -117,6 +143,8 @@ public: ex symmetrize(const lst & l) const; ex antisymmetrize(void) const; ex antisymmetrize(const lst & l) const; + ex symmetrize_cyclic(void) const; + ex symmetrize_cyclic(const lst & l) const; ex simplify_ncmul(const exvector & v) const { return bp->simplify_ncmul(v); } ex operator[](const ex & index) const; ex operator[](int i) const; @@ -126,7 +154,7 @@ public: 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()); } + bool is_zero(void) const { extern const ex _ex0; return is_equal(_ex0); } unsigned return_type(void) const { return bp->return_type(); } unsigned return_type_tinfo(void) const { return bp->return_type_tinfo(); } @@ -169,7 +197,7 @@ protected: // member variables public: - basic *bp; ///< pointer to basic object managed by this + basic *bp; ///< pointer to basic object managed by this, direct manipulation deprecated #ifdef OBSCURE_CINT_HACK static basic * last_created_or_assigned_bp; static basic * dummy_bp; @@ -181,12 +209,12 @@ public: // performance-critical inlined method implementations inline -ex::ex() : bp(_ex0().bp) +ex::ex() { - /*debugmsg("ex default ctor",LOGLEVEL_CONSTRUCT);*/ - GINAC_ASSERT(_ex0().bp!=0); - GINAC_ASSERT(_ex0().bp->flags & status_flags::dynallocated); + extern const class numeric *_num0_p; + bp = (basic*)_num0_p; GINAC_ASSERT(bp!=0); + GINAC_ASSERT(bp->flags & status_flags::dynallocated); ++bp->refcount; #ifdef OBSCURE_CINT_HACK update_last_created_or_assigned_bp(); @@ -196,7 +224,6 @@ ex::ex() : bp(_ex0().bp) inline ex::~ex() { - /*debugmsg("ex dtor",LOGLEVEL_DESTRUCT);*/ GINAC_ASSERT(bp!=0); GINAC_ASSERT(bp->flags & status_flags::dynallocated); if (--bp->refcount == 0) @@ -206,7 +233,6 @@ ex::~ex() 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; @@ -218,7 +244,6 @@ ex::ex(const ex & other) : bp(other.bp) 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); @@ -237,7 +262,6 @@ ex & ex::operator=(const ex & other) 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(); @@ -247,7 +271,6 @@ ex::ex(const basic & other) 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(); @@ -257,7 +280,6 @@ ex::ex(int 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(); @@ -267,7 +289,6 @@ ex::ex(unsigned int i) 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(); @@ -277,7 +298,6 @@ ex::ex(long i) 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(); @@ -287,7 +307,6 @@ ex::ex(unsigned long i) inline ex::ex(double const d) { - /*debugmsg("ex ctor from double",LOGLEVEL_CONSTRUCT);*/ construct_from_double(d); #ifdef OBSCURE_CINT_HACK update_last_created_or_assigned_bp(); @@ -297,7 +316,6 @@ ex::ex(double const d) 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 update_last_created_or_assigned_bp(); @@ -326,6 +344,11 @@ bool ex::is_equal(const ex & other) const // utility functions + +/** Compare two objects of class quickly without doing a deep tree traversal. + * @return "true" if they are equal + * "false" if equality cannot be established quickly (e1 and e2 may + * still be equal, in this case. */ inline bool are_ex_trivially_equal(const ex &e1, const ex &e2) { return e1.bp == e2.bp; @@ -338,8 +361,11 @@ inline unsigned nops(const ex & thisex) inline ex expand(const ex & thisex, unsigned options = 0) { return thisex.expand(options); } -inline bool has(const ex & thisex, const ex & other) -{ return thisex.has(other); } +inline bool has(const ex & thisex, const ex & pattern) +{ return thisex.has(pattern); } + +inline bool find(const ex & thisex, const ex & pattern, lst & found) +{ return thisex.find(pattern, found); } inline int degree(const ex & thisex, const ex & s) { return thisex.degree(s); } @@ -374,6 +400,9 @@ inline ex eval(const ex & thisex, int level = 0) inline ex evalf(const ex & thisex, int level = 0) { return thisex.evalf(level); } +inline ex evalm(const ex & thisex) +{ return thisex.evalm(); } + inline ex diff(const ex & thisex, const symbol & s, unsigned nth = 1) { return thisex.diff(s, nth); } @@ -407,6 +436,12 @@ inline ex antisymmetrize(const ex & thisex) inline ex antisymmetrize(const ex & thisex, const lst & l) { return thisex.antisymmetrize(l); } +inline ex symmetrize_cyclic(const ex & thisex) +{ return thisex.symmetrize_cyclic(); } + +inline ex symmetrize_cyclic(const ex & thisex, const lst & l) +{ return thisex.symmetrize_cyclic(l); } + inline ex op(const ex & thisex, int i) { return thisex.op(i); } @@ -422,6 +457,70 @@ inline bool is_zero(const ex & thisex) inline void swap(ex & e1, ex & e2) { e1.swap(e2); } + +/* Function objects for STL sort() etc. */ +struct ex_is_less : public std::binary_function { + bool operator() (const ex &lh, const ex &rh) const { return lh.compare(rh) < 0; } +}; + +struct ex_is_equal : public std::binary_function { + bool operator() (const ex &lh, const ex &rh) const { return lh.is_equal(rh); } +}; + +struct ex_swap : public std::binary_function { + void operator() (ex &lh, ex &rh) const { lh.swap(rh); } +}; + + +/* Convert function pointer to function object suitable for map(). */ +class pointer_to_map_function : public map_function { +protected: + ex (*ptr)(const ex &); +public: + explicit pointer_to_map_function(ex (*x)(const ex &)) : ptr(x) {} + ex operator()(const ex & e) { return ptr(e); } +}; + +template +class pointer_to_map_function_1arg : public map_function { +protected: + ex (*ptr)(const ex &, T1); + T1 arg1; +public: + explicit pointer_to_map_function_1arg(ex (*x)(const ex &, T1), T1 a1) : ptr(x), arg1(a1) {} + ex operator()(const ex & e) { return ptr(e, arg1); } +}; + +template +class pointer_to_map_function_2args : public map_function { +protected: + ex (*ptr)(const ex &, T1, T2); + T1 arg1; + T2 arg2; +public: + explicit pointer_to_map_function_2args(ex (*x)(const ex &, T1, T2), T1 a1, T2 a2) : ptr(x), arg1(a1), arg2(a2) {} + ex operator()(const ex & e) { return ptr(e, arg1, arg2); } +}; + +template +class pointer_to_map_function_3args : public map_function { +protected: + ex (*ptr)(const ex &, T1, T2, T3); + T1 arg1; + T2 arg2; + T3 arg3; +public: + explicit pointer_to_map_function_3args(ex (*x)(const ex &, T1, T2, T3), T1 a1, T2 a2, T3 a3) : ptr(x), arg1(a1), arg2(a2), arg3(a3) {} + ex operator()(const ex & e) { return ptr(e, arg1, arg2, arg3); } +}; + +inline ex ex::map(ex (*f)(const ex & e)) const +{ + pointer_to_map_function fcn(f); + return bp->map(fcn); +} + + } // namespace GiNaC #endif // ndef __GINAC_EX_H__