X-Git-Url: https://www.ginac.de/ginac.git//ginac.git?p=ginac.git;a=blobdiff_plain;f=ginac%2Fex.h;h=f5008a0f6edd2d2121d61f6efd0f12d4570bfaa4;hp=2f5e8fe9d851a6e4c4e70964b2339f4b32f98794;hb=0c2f0f4c6d4118e817c5b9a14a9d0f3ada82e9fe;hpb=dfa384d36f986f5f8d7dbb5e20c0d3a63af42cd9 diff --git a/ginac/ex.h b/ginac/ex.h index 2f5e8fe9..f5008a0f 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-2003 Johannes Gutenberg University Mainz, Germany + * GiNaC Copyright (C) 1999-2011 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 @@ -17,22 +17,26 @@ * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ -#ifndef __GINAC_EX_H__ -#define __GINAC_EX_H__ +#ifndef GINAC_EX_H +#define GINAC_EX_H +#include "basic.h" +#include "ptr.h" + +#include #include #include -#include #include -#include "basic.h" -#include "ptr.h" - namespace GiNaC { - +#ifdef _MSC_VER + // MSVC produces a different symbol for _ex0 when it is declared inside + // ex::is_zero() than when it is declared at top level as follows + extern const ex _ex0; +#endif /** 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 @@ -43,6 +47,7 @@ namespace GiNaC { * * @see utils.cpp */ class library_init { + static void init_unarchivers(); public: library_init(); ~library_init(); @@ -52,17 +57,18 @@ private: /** For construction of flyweights, etc. */ static library_init library_initializer; - class scalar_products; class const_iterator; +class const_preorder_iterator; +class const_postorder_iterator; -/** 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 -{ +/** Lightweight wrapper for GiNaC's symbolic objects. It holds a pointer to + * the other object in order to do garbage collection by the method of + * reference counting. I.e., it is a smart pointer. Also, the constructor + * ex::ex(const basic & other) calls the methods that do automatic + * evaluation. E.g., x-x turns automatically into 0. */ +class ex { friend class archive_node; friend inline bool are_ex_trivially_equal(const ex &, const ex &); template friend inline const T &ex_to(const ex &); @@ -72,10 +78,6 @@ class ex // default constructor, copy constructor and assignment operator public: ex() throw(); -#ifdef OBSCURE_CINT_HACK - ex(const ex & other); - ex & operator=(const ex & other); -#endif // other constructors public: @@ -106,12 +108,17 @@ public: // iterators const_iterator begin() const throw(); const_iterator end() const throw(); + const_preorder_iterator preorder_begin() const; + const_preorder_iterator preorder_end() const throw(); + const_postorder_iterator postorder_begin() const; + const_postorder_iterator postorder_end() const throw(); // evaluation ex eval(int level = 0) const { return bp->eval(level); } ex evalf(int level = 0) const { return bp->evalf(level); } ex evalm() const { return bp->evalm(); } ex eval_ncmul(const exvector & v) const { return bp->eval_ncmul(v); } + ex eval_integ() const { return bp->eval_integ(); } // printing void print(const print_context & c, unsigned level = 0) const; @@ -132,11 +139,16 @@ public: ex lhs() const; ex rhs() const; + // function for complex expressions + ex conjugate() const { return bp->conjugate(); } + ex real_part() const { return bp->real_part(); } + ex imag_part() const { return bp->imag_part(); } + // pattern matching - bool has(const ex & pattern) const { return bp->has(pattern); } - bool find(const ex & pattern, lst & found) const; + bool has(const ex & pattern, unsigned options = 0) const { return bp->has(pattern, options); } + bool find(const ex & pattern, exset& found) const; bool match(const ex & pattern) const; - bool match(const ex & pattern, lst & repl_lst) const { return bp->match(pattern, repl_lst); } + bool match(const ex & pattern, exmap & repls) const { return bp->match(pattern, repls); } // substitutions ex subs(const exmap & m, unsigned options = 0) const; @@ -154,6 +166,7 @@ public: void traverse(visitor & v) const { traverse_preorder(v); } // degree/coeff + bool is_polynomial(const ex & vars) 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); } @@ -184,18 +197,25 @@ public: numeric integer_content() const; ex primpart(const ex &x) const; ex primpart(const ex &x, const ex &cont) const; + void unitcontprim(const ex &x, ex &u, ex &c, ex &p) const; ex smod(const numeric &xi) const { return bp->smod(xi); } numeric max_coefficient() const; // indexed objects exvector get_free_indices() const { return bp->get_free_indices(); } - ex simplify_indexed() const; - ex simplify_indexed(const scalar_products & sp) const; + ex simplify_indexed(unsigned options = 0) const; + ex simplify_indexed(const scalar_products & sp, unsigned options = 0) const; // comparison int compare(const ex & other) const; bool is_equal(const ex & other) const; - bool is_zero() const { extern const ex _ex0; return is_equal(_ex0); } + bool is_zero() const { +#ifndef _MSC_VER + extern const ex _ex0; +#endif + return is_equal(_ex0); + } + bool is_zero_matrix() const; // symmetry ex symmetrize() const; @@ -207,7 +227,7 @@ public: // noncommutativity unsigned return_type() const { return bp->return_type(); } - unsigned return_type_tinfo() const { return bp->return_type_tinfo(); } + return_type_t return_type_tinfo() const { return bp->return_type_tinfo(); } unsigned gethash() const { return bp->gethash(); } @@ -222,36 +242,10 @@ private: void makewriteable(); void share(const ex & other) const; -#ifdef OBSCURE_CINT_HACK -public: - static bool last_created_or_assigned_bp_can_be_converted_to_ex() - { - 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() - { - last_created_or_assigned_bp = bp; - last_created_or_assigned_exp = (long)(void *)(this); - } -#endif // def OBSCURE_CINT_HACK - // member variables private: mutable ptr bp; ///< pointer to basic object managed by this - -#ifdef OBSCURE_CINT_HACK -public: - static ptr last_created_or_assigned_bp; - static basic * dummy_bp; - static long last_created_or_assigned_exp; -#endif // def OBSCURE_CINT_HACK }; @@ -265,121 +259,100 @@ inline ex::ex() throw() : bp(*const_cast(_num0_bp)) { GINAC_ASSERT(bp->flags & status_flags::dynallocated); -#ifdef OBSCURE_CINT_HACK - update_last_created_or_assigned_bp(); -#endif // def OBSCURE_CINT_HACK } -#ifdef OBSCURE_CINT_HACK -inline -ex::ex(const ex & other) : bp(other.bp) -{ - GINAC_ASSERT((bp->flags) & status_flags::dynallocated); - update_last_created_or_assigned_bp(); -} - -inline -ex & ex::operator=(const ex & other) -{ - GINAC_ASSERT(bp->flags & status_flags::dynallocated); - GINAC_ASSERT(other.bp->flags & status_flags::dynallocated); - bp = other.bp; - update_last_created_or_assigned_bp(); - return *this; -} -#endif // def OBSCURE_CINT_HACK - inline ex::ex(const basic & other) : bp(construct_from_basic(other)) { GINAC_ASSERT(bp->flags & status_flags::dynallocated); -#ifdef OBSCURE_CINT_HACK - update_last_created_or_assigned_bp(); -#endif // def OBSCURE_CINT_HACK } inline ex::ex(int i) : bp(construct_from_int(i)) { GINAC_ASSERT(bp->flags & status_flags::dynallocated); -#ifdef OBSCURE_CINT_HACK - update_last_created_or_assigned_bp(); -#endif // def OBSCURE_CINT_HACK } inline ex::ex(unsigned int i) : bp(construct_from_uint(i)) { GINAC_ASSERT(bp->flags & status_flags::dynallocated); -#ifdef OBSCURE_CINT_HACK - update_last_created_or_assigned_bp(); -#endif // def OBSCURE_CINT_HACK } inline ex::ex(long i) : bp(construct_from_long(i)) { GINAC_ASSERT(bp->flags & status_flags::dynallocated); -#ifdef OBSCURE_CINT_HACK - update_last_created_or_assigned_bp(); -#endif // def OBSCURE_CINT_HACK } inline ex::ex(unsigned long i) : bp(construct_from_ulong(i)) { GINAC_ASSERT(bp->flags & status_flags::dynallocated); -#ifdef OBSCURE_CINT_HACK - update_last_created_or_assigned_bp(); -#endif // def OBSCURE_CINT_HACK } inline ex::ex(double const d) : bp(construct_from_double(d)) { GINAC_ASSERT(bp->flags & status_flags::dynallocated); -#ifdef OBSCURE_CINT_HACK - update_last_created_or_assigned_bp(); -#endif // def OBSCURE_CINT_HACK } inline ex::ex(const std::string &s, const ex &l) : bp(construct_from_string_and_lst(s, l)) { GINAC_ASSERT(bp->flags & status_flags::dynallocated); -#ifdef OBSCURE_CINT_HACK - update_last_created_or_assigned_bp(); -#endif // def OBSCURE_CINT_HACK } inline int ex::compare(const ex & other) const { +#ifdef GINAC_COMPARE_STATISTICS + compare_statistics.total_compares++; +#endif if (bp == other.bp) // trivial case: both expressions point to same basic return 0; +#ifdef GINAC_COMPARE_STATISTICS + compare_statistics.nontrivial_compares++; +#endif const int cmpval = bp->compare(*other.bp); +#if 1 if (cmpval == 0) { // Expressions point to different, but equal, trees: conserve // memory and make subsequent compare() operations faster by - // making both expression point to the same tree. + // making both expressions point to the same tree. share(other); } +#endif return cmpval; } inline bool ex::is_equal(const ex & other) const { +#ifdef GINAC_COMPARE_STATISTICS + compare_statistics.total_is_equals++; +#endif if (bp == other.bp) // trivial case: both expressions point to same basic return true; - return bp->is_equal(*other.bp); +#ifdef GINAC_COMPARE_STATISTICS + compare_statistics.nontrivial_is_equals++; +#endif + const bool equal = bp->is_equal(*other.bp); +#if 0 + if (equal) { + // Expressions point to different, but equal, trees: conserve + // memory and make subsequent compare() operations faster by + // making both expressions point to the same tree. + share(other); + } +#endif + return equal; } // Iterators -class const_iterator : public std::iterator -{ +class const_iterator : public std::iterator { friend class ex; friend class const_preorder_iterator; friend class const_postorder_iterator; @@ -525,28 +498,24 @@ struct _iter_rep { } // namespace internal -class const_preorder_iterator : public std::iterator -{ +class const_preorder_iterator : public std::iterator { public: const_preorder_iterator() throw() {} - // Provide implicit conversion from const_iterator, so begin() and - // end() can be used to create const_preorder_iterators - const_preorder_iterator(const const_iterator & cit) + const_preorder_iterator(const ex &e, size_t n) { - s.push(internal::_iter_rep(cit.e, cit.i, cit.e.nops())); + s.push(internal::_iter_rep(e, 0, n)); } public: - ex operator*() const + reference operator*() const { - const internal::_iter_rep & r = s.top(); - return r.e.op(r.i); + return s.top().e; } - std::auto_ptr operator->() const + pointer operator->() const { - return std::auto_ptr(new ex(operator*())); + return &(s.top().e); } const_preorder_iterator &operator++() @@ -573,48 +542,45 @@ public: } private: - std::stack s; + std::stack > s; void increment() { - internal::_iter_rep & current = s.top(); - const ex & child = current.e.op(current.i); - size_t n = child.nops(); - if (n) - s.push(internal::_iter_rep(child, 0, n)); - else - ++current.i; - - while (s.top().i == s.top().i_end && s.size() > 1) { + while (!s.empty() && s.top().i == s.top().i_end) { s.pop(); + if (s.empty()) + return; ++s.top().i; } + + internal::_iter_rep & current = s.top(); + + if (current.i != current.i_end) { + const ex & child = current.e.op(current.i); + s.push(internal::_iter_rep(child, 0, child.nops())); + } } }; -class const_postorder_iterator : public std::iterator -{ +class const_postorder_iterator : public std::iterator { public: const_postorder_iterator() throw() {} - // Provide implicit conversion from const_iterator, so begin() and - // end() can be used to create const_postorder_iterators - const_postorder_iterator(const const_iterator & cit) + const_postorder_iterator(const ex &e, size_t n) { - s.push(internal::_iter_rep(cit.e, cit.i, cit.e.nops())); + s.push(internal::_iter_rep(e, 0, n)); descend(); } public: - ex operator*() const + reference operator*() const { - const internal::_iter_rep & r = s.top(); - return r.e.op(r.i); + return s.top().e; } - std::auto_ptr operator->() const + pointer operator->() const { - return std::auto_ptr(new ex(operator*())); + return &(s.top().e); } const_postorder_iterator &operator++() @@ -641,12 +607,12 @@ public: } private: - std::stack s; + std::stack > s; void descend() { - while (s.top().i != s.top().i_end && s.top().e.op(s.top().i).nops() > 0) { - const internal::_iter_rep & current = s.top(); + while (s.top().i != s.top().i_end) { + internal::_iter_rep & current = s.top(); const ex & child = current.e.op(current.i); s.push(internal::_iter_rep(child, 0, child.nops())); } @@ -654,10 +620,12 @@ private: void increment() { - ++s.top().i; - descend(); - if (s.top().i == s.top().i_end && s.size() > 1) + if (s.top().i == s.top().i_end) s.pop(); + if (!s.empty()) { + ++s.top().i; + descend(); + } } }; @@ -671,6 +639,26 @@ inline const_iterator ex::end() const throw() return const_iterator(*this, nops()); } +inline const_preorder_iterator ex::preorder_begin() const +{ + return const_preorder_iterator(*this, nops()); +} + +inline const_preorder_iterator ex::preorder_end() const throw() +{ + return const_preorder_iterator(); +} + +inline const_postorder_iterator ex::postorder_begin() const +{ + return const_postorder_iterator(*this, nops()); +} + +inline const_postorder_iterator ex::postorder_end() const throw() +{ + return const_postorder_iterator(); +} + // utility functions @@ -700,6 +688,11 @@ struct ex_swap : public std::binary_function { void operator() (ex &lh, ex &rh) const { lh.swap(rh); } }; +// Make it possible to print exvectors and exmaps +std::ostream & operator<<(std::ostream & os, const exvector & e); +std::ostream & operator<<(std::ostream & os, const exset & e); +std::ostream & operator<<(std::ostream & os, const exmap & e); + // wrapper functions around member functions inline size_t nops(const ex & thisex) { return thisex.nops(); } @@ -707,12 +700,24 @@ inline size_t 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 & pattern) -{ return thisex.has(pattern); } +inline ex conjugate(const ex & thisex) +{ return thisex.conjugate(); } + +inline ex real_part(const ex & thisex) +{ return thisex.real_part(); } -inline bool find(const ex & thisex, const ex & pattern, lst & found) +inline ex imag_part(const ex & thisex) +{ return thisex.imag_part(); } + +inline bool has(const ex & thisex, const ex & pattern, unsigned options = 0) +{ return thisex.has(pattern, options); } + +inline bool find(const ex & thisex, const ex & pattern, exset& found) { return thisex.find(pattern, found); } +inline bool is_polynomial(const ex & thisex, const ex & vars) +{ return thisex.is_polynomial(vars); } + inline int degree(const ex & thisex, const ex & s) { return thisex.degree(s); } @@ -758,20 +763,23 @@ inline ex evalf(const ex & thisex, int level = 0) inline ex evalm(const ex & thisex) { return thisex.evalm(); } +inline ex eval_integ(const ex & thisex) +{ return thisex.eval_integ(); } + 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, unsigned options = 0) { return thisex.series(r, order, options); } -inline bool match(const ex & thisex, const ex & pattern, lst & repl_lst) +inline bool match(const ex & thisex, const ex & pattern, exmap& repl_lst) { return thisex.match(pattern, repl_lst); } -inline ex simplify_indexed(const ex & thisex) -{ return thisex.simplify_indexed(); } +inline ex simplify_indexed(const ex & thisex, unsigned options = 0) +{ return thisex.simplify_indexed(options); } -inline ex simplify_indexed(const ex & thisex, const scalar_products & sp) -{ return thisex.simplify_indexed(sp); } +inline ex simplify_indexed(const ex & thisex, const scalar_products & sp, unsigned options = 0) +{ return thisex.simplify_indexed(sp, options); } inline ex symmetrize(const ex & thisex) { return thisex.symmetrize(); } @@ -863,6 +871,52 @@ public: ex operator()(const ex & e) { return ptr(e, arg1, arg2, arg3); } }; +template +class pointer_to_member_to_map_function : public map_function { +protected: + ex (C::*ptr)(const ex &); + C &c; +public: + explicit pointer_to_member_to_map_function(ex (C::*member)(const ex &), C &obj) : ptr(member), c(obj) {} + ex operator()(const ex & e) { return (c.*ptr)(e); } +}; + +template +class pointer_to_member_to_map_function_1arg : public map_function { +protected: + ex (C::*ptr)(const ex &, T1); + C &c; + T1 arg1; +public: + explicit pointer_to_member_to_map_function_1arg(ex (C::*member)(const ex &, T1), C &obj, T1 a1) : ptr(member), c(obj), arg1(a1) {} + ex operator()(const ex & e) { return (c.*ptr)(e, arg1); } +}; + +template +class pointer_to_member_to_map_function_2args : public map_function { +protected: + ex (C::*ptr)(const ex &, T1, T2); + C &c; + T1 arg1; + T2 arg2; +public: + explicit pointer_to_member_to_map_function_2args(ex (C::*member)(const ex&, T1, T2), C &obj, T1 a1, T2 a2) : ptr(member), c(obj), arg1(a1), arg2(a2) {} + ex operator()(const ex & e) { return (c.*ptr)(e, arg1, arg2); } +}; + +template +class pointer_to_member_to_map_function_3args : public map_function { +protected: + ex (C::*ptr)(const ex &, T1, T2, T3); + C &c; + T1 arg1; + T2 arg2; + T3 arg3; +public: + explicit pointer_to_member_to_map_function_3args(ex (C::*member)(const ex &, T1, T2, T3), C &obj, T1 a1, T2 a2, T3 a3) : ptr(member), c(obj), arg1(a1), arg2(a2), arg3(a3) {} + ex operator()(const ex & e) { return (c.*ptr)(e, arg1, arg2, arg3); } +}; + inline ex ex::map(ex f(const ex &)) const { pointer_to_map_function fcn(f); @@ -931,4 +985,4 @@ inline void iter_swap(list::iterator i1, list::iterator i2 } // namespace std -#endif // ndef __GINAC_EX_H__ +#endif // ndef GINAC_EX_H