X-Git-Url: https://www.ginac.de/ginac.git//ginac.git?p=ginac.git;a=blobdiff_plain;f=ginac%2Fex.cpp;h=4a41ea8f00ae59c50b0cc3591db309fa2d5fae03;hp=c30efddac37b449193263f329d367f7a915fdd78;hb=eefedc70f63222beca918a3df89cabac700df1eb;hpb=66c0f31c678e6c1938d637636b230ea376c157c1 diff --git a/ginac/ex.cpp b/ginac/ex.cpp index c30efdda..4a41ea8f 100644 --- a/ginac/ex.cpp +++ b/ginac/ex.cpp @@ -1,8 +1,9 @@ /** @file ex.cpp * - * Implementation of GiNaC's light-weight expression handles. - * - * GiNaC Copyright (C) 1999 Johannes Gutenberg University Mainz, Germany + * Implementation of GiNaC's light-weight expression handles. */ + +/* + * GiNaC Copyright (C) 1999-2003 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 @@ -20,6 +21,7 @@ */ #include +#include #include "ex.h" #include "add.h" @@ -27,431 +29,508 @@ #include "ncmul.h" #include "numeric.h" #include "power.h" +#include "lst.h" +#include "relational.h" +#include "input_lexer.h" +#include "utils.h" -////////// -// default constructor, destructor, copy constructor assignment operator and helpers -////////// - -// public - -#ifndef INLINE_EX_CONSTRUCTORS - -ex::ex() : bp(exZERO().bp) -{ - debugmsg("ex default constructor",LOGLEVEL_CONSTRUCT); - ASSERT(exZERO().bp!=0); - ASSERT(exZERO().bp->flags & status_flags::dynallocated); - ASSERT(bp!=0); - ++bp->refcount; -} - -ex::~ex() -{ - debugmsg("ex destructor",LOGLEVEL_DESTRUCT); - ASSERT(bp!=0); - ASSERT(bp->flags & status_flags::dynallocated); - if (--bp->refcount == 0) { - delete bp; - } -} - -ex::ex(ex const & other) : bp(other.bp) -{ - debugmsg("ex copy constructor",LOGLEVEL_CONSTRUCT); - ASSERT(bp!=0); - ASSERT((bp->flags) & status_flags::dynallocated); - ++bp->refcount; -} - -ex const & ex::operator=(ex const & other) -{ - debugmsg("ex operator=",LOGLEVEL_ASSIGNMENT); - ASSERT(bp!=0); - ASSERT(bp->flags & status_flags::dynallocated); - ASSERT(other.bp!=0); - ASSERT(other.bp->flags & status_flags::dynallocated); - ++other.bp->refcount; - basic * tmpbp=other.bp; - if (--bp->refcount==0) { - delete bp; - } - bp=tmpbp; - return *this; -} - -#endif // ndef INLINE_EX_CONSTRUCTORS +namespace GiNaC { ////////// // other constructors ////////// -// public - -#ifndef INLINE_EX_CONSTRUCTORS -ex::ex(basic const & other) -{ - debugmsg("ex constructor from basic",LOGLEVEL_CONSTRUCT); - construct_from_basic(other); -} -#endif - -ex::ex(int const i) -{ - debugmsg("ex constructor from int",LOGLEVEL_CONSTRUCT); - construct_from_basic(numeric(i)); -} - -ex::ex(unsigned int const i) -{ - debugmsg("ex constructor from unsigned int",LOGLEVEL_CONSTRUCT); - construct_from_basic(numeric(i)); -} - -ex::ex(long const i) -{ - debugmsg("ex constructor from long",LOGLEVEL_CONSTRUCT); - construct_from_basic(numeric(i)); -} - -ex::ex(unsigned long const i) -{ - debugmsg("ex constructor from unsigned long",LOGLEVEL_CONSTRUCT); - construct_from_basic(numeric(i)); -} - -ex::ex(double const d) -{ - debugmsg("ex constructor from double",LOGLEVEL_CONSTRUCT); - construct_from_basic(numeric(d)); -} - -////////// -// functions overriding virtual functions from bases classes -////////// - -// none - -////////// -// new virtual functions which can be overridden by derived classes -////////// - -// none +// none (all inlined) ////////// // non-virtual functions in this class ////////// // public - -void ex::swap(ex & other) + +/** Print expression to stream. The formatting of the output is determined + * by the kind of print_context object that is passed. Possible formattings + * include ginsh-parsable output (the default), tree-like output for + * debugging, and C++ source. + * @see print_context */ +void ex::print(const print_context & c, unsigned level) const { - debugmsg("ex swap",LOGLEVEL_MEMBER_FUNCTION); - - ASSERT(bp!=0); - ASSERT(bp->flags & status_flags::dynallocated); - ASSERT(other.bp!=0); - ASSERT(other.bp->flags & status_flags::dynallocated); - - basic * tmpbp=bp; - bp=other.bp; - other.bp=tmpbp; + bp->print(c, level); } -bool ex::info(unsigned inf) const +/** Little wrapper arount print to be called within a debugger. */ +void ex::dbgprint() const { - if (inf == info_flags::normal_form) { - - // Polynomials are in normal form - if (info(info_flags::polynomial)) - return true; - - // polynomial^(-int) is in normal form - if (is_ex_exactly_of_type(*this, power)) - return op(1).info(info_flags::negint); - - // polynomial^(int) * polynomial^(int) * ... is in normal form - if (!is_ex_exactly_of_type(*this, mul)) - return false; - for (int i=0; iinfo(inf); - } + bp->dbgprint(); } -int ex::nops() const +/** Little wrapper arount printtree to be called within a debugger. */ +void ex::dbgprinttree() const { - ASSERT(bp!=0); - return bp->nops(); + bp->dbgprinttree(); } ex ex::expand(unsigned options) const { - ASSERT(bp!=0); - return bp->expand(options); -} - -bool ex::has(ex const & other) const -{ - ASSERT(bp!=0); - return bp->has(other); -} - -int ex::degree(symbol const & s) const -{ - ASSERT(bp!=0); - return bp->degree(s); -} - -int ex::ldegree(symbol const & s) const -{ - ASSERT(bp!=0); - return bp->ldegree(s); -} - -ex ex::coeff(symbol const & s, int const n) const -{ - ASSERT(bp!=0); - return bp->coeff(s,n); + if (options == 0 && (bp->flags & status_flags::expanded)) // The "expanded" flag only covers the standard options; someone might want to re-expand with different options + return *bp; + else + return bp->expand(options); } -ex ex::numer(bool normalize) const -{ - ex n; - if (normalize && !info(info_flags::normal_form)) - n = normal(); - else - n = *this; - - // polynomial - if (n.info(info_flags::polynomial)) - return n; - - // something^(-int) - if (is_ex_exactly_of_type(n, power) && n.op(1).info(info_flags::negint)) - return exONE(); - - // something^(int) * something^(int) * ... - if (!is_ex_exactly_of_type(n, mul)) - return n; - ex res = exONE(); - for (int i=0; icollect(s); +/** Compute partial derivative of an expression. + * + * @param s symbol by which the expression is derived + * @param nth order of derivative (default 1) + * @return partial derivative as a new expression */ +ex ex::diff(const symbol & s, unsigned nth) const +{ + if (!nth) + return *this; + else + return bp->diff(s, nth); +} + +/** Check whether expression matches a specified pattern. */ +bool ex::match(const ex & pattern) const +{ + lst repl_lst; + return bp->match(pattern, repl_lst); } -ex ex::eval(int level) const +/** Find all occurrences of a pattern. The found matches are appended to + * the "found" list. If the expression itself matches the pattern, the + * children are not further examined. This function returns true when any + * matches were found. */ +bool ex::find(const ex & pattern, lst & found) const { - ASSERT(bp!=0); - return bp->eval(level); + if (match(pattern)) { + found.append(*this); + found.sort(); + found.unique(); + return true; + } + bool any_found = false; + for (size_t i=0; ievalf(level); -} + GINAC_ASSERT(ls.nops() == lr.nops()); -ex ex::subs(lst const & ls, lst const & lr) const -{ - ASSERT(bp!=0); - return bp->subs(ls,lr); -} + // Convert the lists to a map + exmap m; + for (lst::const_iterator its = ls.begin(), itr = lr.begin(); its != ls.end(); ++its, ++itr) { + m.insert(std::make_pair(*its, *itr)); -ex ex::subs(ex const & e) const -{ - ASSERT(bp!=0); - return bp->subs(e); -} + // Search for products and powers in the expressions to be substituted + // (for an optimization in expairseq::subs()) + if (is_exactly_a(*its) || is_exactly_a(*its)) + options |= subs_options::pattern_is_product; + } + if (!(options & subs_options::pattern_is_product)) + options |= subs_options::pattern_is_not_product; -exvector ex::get_indices(void) const -{ - ASSERT(bp!=0); - return bp->get_indices(); + return bp->subs(m, options); } -ex ex::simplify_ncmul(exvector const & v) const +/** Substitute objects in an expression (syntactic substitution) and return + * the result as a new expression. There are two valid types of + * replacement arguments: 1) a relational like object==ex and 2) a list of + * relationals lst(object1==ex1,object2==ex2,...). */ +ex ex::subs(const ex & e, unsigned options) const { - ASSERT(bp!=0); - return bp->simplify_ncmul(v); -} + if (e.info(info_flags::relation_equal)) { + exmap m; + const ex & s = e.lhs(); + m.insert(std::make_pair(s, e.rhs())); + if (is_exactly_a(s) || is_exactly_a(s)) + options |= subs_options::pattern_is_product; + return bp->subs(m, options); + } else if (!e.info(info_flags::list)) + throw(std::invalid_argument("basic::subs(ex): argument must be a list")); -ex ex::operator[](ex const & index) const -{ - debugmsg("ex operator[ex]",LOGLEVEL_OPERATOR); - ASSERT(bp!=0); - return (*bp)[index]; -} + // Convert the list to a map + exmap m; + GINAC_ASSERT(is_a(e)); + for (lst::const_iterator it = ex_to(e).begin(); it != ex_to(e).end(); ++it) { + ex r = *it; + if (!r.info(info_flags::relation_equal)) + throw(std::invalid_argument("basic::subs(ex): argument must be a list of equations")); + const ex & s = r.lhs(); + m.insert(std::make_pair(s, r.rhs())); -ex ex::operator[](int const i) const -{ - debugmsg("ex operator[int]",LOGLEVEL_OPERATOR); - ASSERT(bp!=0); - return (*bp)[i]; -} + // Search for products and powers in the expressions to be substituted + // (for an optimization in expairseq::subs()) + if (is_exactly_a(s) || is_exactly_a(s)) + options |= subs_options::pattern_is_product; + } + if (!(options & subs_options::pattern_is_product)) + options |= subs_options::pattern_is_not_product; -ex ex::op(int const i) const -{ - debugmsg("ex op()",LOGLEVEL_MEMBER_FUNCTION); - ASSERT(bp!=0); - return bp->op(i); + return bp->subs(m, options); } -ex & ex::let_op(int const i) +/** Traverse expression tree with given visitor, preorder traversal. */ +void ex::traverse_preorder(visitor & v) const { - debugmsg("ex let_op()",LOGLEVEL_MEMBER_FUNCTION); - makewriteable(); - ASSERT(bp!=0); - return bp->let_op(i); -} + accept(v); -#ifndef INLINE_EX_CONSTRUCTORS -int ex::compare(ex const & other) const -{ - ASSERT(bp!=0); - 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); + size_t n = nops(); + for (size_t i = 0; i < n; ++i) + op(i).traverse_preorder(v); } -#endif // ndef INLINE_EX_CONSTRUCTORS -#ifndef INLINE_EX_CONSTRUCTORS -bool ex::is_equal(ex const & other) const +/** Traverse expression tree with given visitor, postorder traversal. */ +void ex::traverse_postorder(visitor & v) const { - ASSERT(bp!=0); - 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); -} -#endif // ndef INLINE_EX_CONSTRUCTORS + size_t n = nops(); + for (size_t i = 0; i < n; ++i) + op(i).traverse_postorder(v); -unsigned ex::return_type(void) const -{ - ASSERT(bp!=0); - return bp->return_type(); + accept(v); } -unsigned ex::return_type_tinfo(void) const +/** Return modifyable operand/member at position i. */ +ex & ex::let_op(size_t i) { - ASSERT(bp!=0); - return bp->return_type_tinfo(); + makewriteable(); + return bp->let_op(i); } -unsigned ex::gethash(void) const +ex & ex::operator[](const ex & index) { - ASSERT(bp!=0); - return bp->gethash(); + makewriteable(); + return (*bp)[index]; } -ex ex::exadd(ex const & rh) const +ex & ex::operator[](size_t i) { - return (new add(*this,rh))->setflag(status_flags::dynallocated); + makewriteable(); + return (*bp)[i]; } -ex ex::exmul(ex const & rh) const +/** Left hand side of relational expression. */ +ex ex::lhs() const { - return (new mul(*this,rh))->setflag(status_flags::dynallocated); + if (!is_a(*this)) + throw std::runtime_error("ex::lhs(): not a relation"); + return bp->op(0); } -ex ex::exncmul(ex const & rh) const +/** Right hand side of relational expression. */ +ex ex::rhs() const { - return (new ncmul(*this,rh))->setflag(status_flags::dynallocated); + if (!is_a(*this)) + throw std::runtime_error("ex::rhs(): not a relation"); + return bp->op(1); } // private +/** Make this ex writable (if more than one ex handle the same basic) by + * unlinking the object and creating an unshared copy of it. */ void ex::makewriteable() { - debugmsg("ex makewriteable",LOGLEVEL_MEMBER_FUNCTION); - ASSERT(bp!=0); - ASSERT(bp->flags & status_flags::dynallocated); - if (bp->refcount > 1) { - basic * bp2=bp->duplicate(); - ++bp2->refcount; - bp2->setflag(status_flags::dynallocated); - --bp->refcount; - bp=bp2; - } - ASSERT(bp->refcount == 1); -} - -void ex::construct_from_basic(basic const & other) -{ - if ( (other.flags & status_flags::evaluated)==0 ) { - // cf. copy constructor - ex const & tmpex = other.eval(1); // evaluate only one (top) level - bp = tmpex.bp; - ASSERT(bp!=0); - ASSERT(bp->flags & status_flags::dynallocated); - ++bp->refcount; - if ((other.flags & status_flags::dynallocated)&&(other.refcount==0)) { - delete &const_cast(other); - } - } else { - if (other.flags & status_flags::dynallocated) { - bp=&const_cast(other); - } else { - bp=other.duplicate(); - bp->setflag(status_flags::dynallocated); - } - ASSERT(bp!=0); - // bp->clearflag(status_flags::evaluated); - ++bp->refcount; - } - ASSERT(bp!=0); - ASSERT(bp->flags & status_flags::dynallocated); -} - + GINAC_ASSERT(bp->flags & status_flags::dynallocated); + bp.makewritable(); + GINAC_ASSERT(bp->refcount == 1); +} + +/** Share equal objects between expressions. + * @see ex::compare(const basic &) */ +void ex::share(const ex & other) const +{ + if ((bp->flags | other.bp->flags) & status_flags::not_shareable) + return; + + if (bp->refcount <= other.bp->refcount) + bp = other.bp; + else + other.bp = bp; +} + +/** Helper function for the ex-from-basic constructor. This is where GiNaC's + * automatic evaluator and memory management are implemented. + * @see ex::ex(const basic &) */ +ptr ex::construct_from_basic(const basic & other) +{ + if (!(other.flags & status_flags::evaluated)) { + + // The object is not yet evaluated, so call eval() to evaluate + // the top level. This will return either + // a) the original object with status_flags::evaluated set (when the + // eval() implementation calls hold()) + // or + // b) a different expression. + // + // eval() returns an ex, not a basic&, so this will go through + // construct_from_basic() a second time. In case a) we end up in + // the "else" branch below. In case b) we end up here again and + // apply eval() once more. The recursion stops when eval() calls + // hold() or returns an object that already has its "evaluated" + // flag set, such as a symbol or a numeric. + const ex & tmpex = other.eval(1); + + // Eventually, the eval() recursion goes through the "else" branch + // below, which assures that the object pointed to by tmpex.bp is + // allocated on the heap (either it was already on the heap or it + // is a heap-allocated duplicate of another object). + GINAC_ASSERT(tmpex.bp->flags & status_flags::dynallocated); + + // If the original object is not referenced but heap-allocated, + // it means that eval() hit case b) above. The original object is + // no longer needed (it evaluated into something different), so we + // delete it (because nobody else will). + if ((other.refcount==0) && (other.flags & status_flags::dynallocated)) + delete &other; // yes, you can apply delete to a const pointer + + // We can't return a basic& here because the tmpex is destroyed as + // soon as we leave the function, which would deallocate the + // evaluated object. + return tmpex.bp; + + } else { + + // The easy case: making an "ex" out of an evaluated object. + if (other.flags & status_flags::dynallocated) { + + // The object is already heap-allocated, so we can just make + // another reference to it. + return ptr(const_cast(other)); + + } else { + + // The object is not heap-allocated, so we create a duplicate + // on the heap. + basic *bp = other.duplicate(); + bp->setflag(status_flags::dynallocated); + GINAC_ASSERT(bp->refcount == 0); + return bp; + } + } +} + +basic & ex::construct_from_int(int i) +{ + switch (i) { // prefer flyweights over new objects + case -12: + return const_cast(_num_12); + case -11: + return const_cast(_num_11); + case -10: + return const_cast(_num_10); + case -9: + return const_cast(_num_9); + case -8: + return const_cast(_num_8); + case -7: + return const_cast(_num_7); + case -6: + return const_cast(_num_6); + case -5: + return const_cast(_num_5); + case -4: + return const_cast(_num_4); + case -3: + return const_cast(_num_3); + case -2: + return const_cast(_num_2); + case -1: + return const_cast(_num_1); + case 0: + return const_cast(_num0); + case 1: + return const_cast(_num1); + case 2: + return const_cast(_num2); + case 3: + return const_cast(_num3); + case 4: + return const_cast(_num4); + case 5: + return const_cast(_num5); + case 6: + return const_cast(_num6); + case 7: + return const_cast(_num7); + case 8: + return const_cast(_num8); + case 9: + return const_cast(_num9); + case 10: + return const_cast(_num10); + case 11: + return const_cast(_num11); + case 12: + return const_cast(_num12); + default: + basic *bp = new numeric(i); + bp->setflag(status_flags::dynallocated); + GINAC_ASSERT(bp->refcount == 0); + return *bp; + } +} + +basic & ex::construct_from_uint(unsigned int i) +{ + switch (i) { // prefer flyweights over new objects + case 0: + return const_cast(_num0); + case 1: + return const_cast(_num1); + case 2: + return const_cast(_num2); + case 3: + return const_cast(_num3); + case 4: + return const_cast(_num4); + case 5: + return const_cast(_num5); + case 6: + return const_cast(_num6); + case 7: + return const_cast(_num7); + case 8: + return const_cast(_num8); + case 9: + return const_cast(_num9); + case 10: + return const_cast(_num10); + case 11: + return const_cast(_num11); + case 12: + return const_cast(_num12); + default: + basic *bp = new numeric(i); + bp->setflag(status_flags::dynallocated); + GINAC_ASSERT(bp->refcount == 0); + return *bp; + } +} + +basic & ex::construct_from_long(long i) +{ + switch (i) { // prefer flyweights over new objects + case -12: + return const_cast(_num_12); + case -11: + return const_cast(_num_11); + case -10: + return const_cast(_num_10); + case -9: + return const_cast(_num_9); + case -8: + return const_cast(_num_8); + case -7: + return const_cast(_num_7); + case -6: + return const_cast(_num_6); + case -5: + return const_cast(_num_5); + case -4: + return const_cast(_num_4); + case -3: + return const_cast(_num_3); + case -2: + return const_cast(_num_2); + case -1: + return const_cast(_num_1); + case 0: + return const_cast(_num0); + case 1: + return const_cast(_num1); + case 2: + return const_cast(_num2); + case 3: + return const_cast(_num3); + case 4: + return const_cast(_num4); + case 5: + return const_cast(_num5); + case 6: + return const_cast(_num6); + case 7: + return const_cast(_num7); + case 8: + return const_cast(_num8); + case 9: + return const_cast(_num9); + case 10: + return const_cast(_num10); + case 11: + return const_cast(_num11); + case 12: + return const_cast(_num12); + default: + basic *bp = new numeric(i); + bp->setflag(status_flags::dynallocated); + GINAC_ASSERT(bp->refcount == 0); + return *bp; + } +} + +basic & ex::construct_from_ulong(unsigned long i) +{ + switch (i) { // prefer flyweights over new objects + case 0: + return const_cast(_num0); + case 1: + return const_cast(_num1); + case 2: + return const_cast(_num2); + case 3: + return const_cast(_num3); + case 4: + return const_cast(_num4); + case 5: + return const_cast(_num5); + case 6: + return const_cast(_num6); + case 7: + return const_cast(_num7); + case 8: + return const_cast(_num8); + case 9: + return const_cast(_num9); + case 10: + return const_cast(_num10); + case 11: + return const_cast(_num11); + case 12: + return const_cast(_num12); + default: + basic *bp = new numeric(i); + bp->setflag(status_flags::dynallocated); + GINAC_ASSERT(bp->refcount == 0); + return *bp; + } +} + +basic & ex::construct_from_double(double d) +{ + basic *bp = new numeric(d); + bp->setflag(status_flags::dynallocated); + GINAC_ASSERT(bp->refcount == 0); + return *bp; +} + +ptr ex::construct_from_string_and_lst(const std::string &s, const ex &l) +{ + set_lexer_string(s); + set_lexer_symbols(l); + ginac_yyrestart(NULL); + if (ginac_yyparse()) + throw (std::runtime_error(get_parser_error())); + else + return parsed_ex.bp; +} + ////////// // static member variables ////////// @@ -468,45 +547,7 @@ void ex::construct_from_basic(basic const & other) // global functions ////////// -ex const & exZERO(void) -{ - static ex * eZERO=new ex(numZERO()); - return *eZERO; -} - -ex const & exONE(void) -{ - static ex * eONE=new ex(numONE()); - return *eONE; -} - -ex const & exTWO(void) -{ - static ex * eTWO=new ex(numTWO()); - return *eTWO; -} - -ex const & exTHREE(void) -{ - static ex * eTHREE=new ex(numTHREE()); - return *eTHREE; -} - -ex const & exMINUSONE(void) -{ - static ex * eMINUSONE=new ex(numMINUSONE()); - return *eMINUSONE; -} - -ex const & exHALF(void) -{ - static ex * eHALF=new ex(ex(1)/ex(2)); - return *eHALF; -} +// none -ex const & exMINUSHALF(void) -{ - static ex * eMINUSHALF=new ex(numeric(-1,2)); - return *eMINUSHALF; -} +} // namespace GiNaC