X-Git-Url: https://www.ginac.de/ginac.git//ginac.git?p=ginac.git;a=blobdiff_plain;f=ginac%2Fbasic.cpp;h=01a29011152a9c9ff7b58620e7a0da71c7561d75;hp=5b0b180378bc24df6bd95dbf671ece9f95bc6e56;hb=ffad02322624ab79fdad1a23a3aa83cd67376151;hpb=d508ca04e9c2f4ee103c9f21f33a98c87116df13 diff --git a/ginac/basic.cpp b/ginac/basic.cpp index 5b0b1803..01a29011 100644 --- a/ginac/basic.cpp +++ b/ginac/basic.cpp @@ -3,7 +3,7 @@ * Implementation of GiNaC's ABC. */ /* - * GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany + * 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 @@ -33,56 +33,68 @@ #include "symbol.h" #include "lst.h" #include "ncmul.h" -#include "print.h" +#include "relational.h" +#include "operators.h" +#include "wildcard.h" #include "archive.h" #include "utils.h" -#include "debugmsg.h" namespace GiNaC { -GINAC_IMPLEMENT_REGISTERED_CLASS_NO_CTORS(basic, void) +GINAC_IMPLEMENT_REGISTERED_CLASS_OPT(basic, void, + print_func(&basic::do_print). + print_func(&basic::do_print_tree). + print_func(&basic::do_print_python_repr)) ////////// -// default ctor, dtor, copy ctor assignment operator and helpers +// default constructor, destructor, copy constructor and assignment operator ////////// // public -basic::basic(const basic & other) : tinfo_key(TINFO_basic), flags(0), refcount(0) +/** basic copy constructor: implicitly assumes that the other class is of + * the exact same type (as it's used by duplicate()), so it can copy the + * tinfo_key and the hash value. */ +basic::basic(const basic & other) : tinfo_key(other.tinfo_key), flags(other.flags & ~status_flags::dynallocated), hashvalue(other.hashvalue) { - debugmsg("basic copy ctor", LOGLEVEL_CONSTRUCT); - copy(other); + GINAC_ASSERT(typeid(*this) == typeid(other)); } +/** basic assignment operator: the other object might be of a derived class. */ const basic & basic::operator=(const basic & other) { - debugmsg("basic operator=", LOGLEVEL_ASSIGNMENT); - if (this != &other) { - destroy(true); - copy(other); + unsigned fl = other.flags & ~status_flags::dynallocated; + if (tinfo_key != other.tinfo_key) { + // The other object is of a derived class, so clear the flags as they + // might no longer apply (especially hash_calculated). Oh, and don't + // copy the tinfo_key: it is already set correctly for this object. + fl &= ~(status_flags::evaluated | status_flags::expanded | status_flags::hash_calculated); + } else { + // The objects are of the exact same class, so copy the hash value. + hashvalue = other.hashvalue; } + flags = fl; + set_refcount(0); return *this; } // protected -// none (all conditionally inlined) +// none (all inlined) ////////// -// other ctors +// other constructors ////////// -// none (all conditionally inlined) +// none (all inlined) ////////// // archiving ////////// /** Construct object from archive_node. */ -basic::basic(const archive_node &n, const lst &sym_lst) : flags(0), refcount(0) +basic::basic(const archive_node &n, lst &sym_lst) : flags(0) { - debugmsg("basic ctor from archive_node", LOGLEVEL_CONSTRUCT); - // Reconstruct tinfo_key from class name std::string class_name; if (n.find_string("class", class_name)) @@ -100,67 +112,118 @@ void basic::archive(archive_node &n) const n.add_string("class", class_name()); } -////////// -// functions overriding virtual functions from bases classes -////////// - -// none - ////////// // new virtual functions which can be overridden by derived classes ////////// // public -/** Output to stream. +/** Output to stream. This performs double dispatch on the dynamic type of + * *this and the dynamic type of the supplied print context. * @param c print context object that describes the output formatting * @param level value that is used to identify the precedence or indentation * level for placing parentheses and formatting */ void basic::print(const print_context & c, unsigned level) const { - debugmsg("basic print", LOGLEVEL_PRINT); + print_dispatch(get_class_info(), c, level); +} + +/** Like print(), but dispatch to the specified class. Can be used by + * implementations of print methods to dispatch to the method of the + * superclass. + * + * @see basic::print */ +void basic::print_dispatch(const registered_class_info & ri, const print_context & c, unsigned level) const +{ + // Double dispatch on object type and print_context type + const registered_class_info * reg_info = &ri; + const print_context_class_info * pc_info = &c.get_class_info(); + +next_class: + const std::vector & pdt = reg_info->options.get_print_dispatch_table(); + +next_context: + unsigned id = pc_info->options.get_id(); + if (id >= pdt.size() || !(pdt[id].is_valid())) { + + // Method not found, try parent print_context class + const print_context_class_info * parent_pc_info = pc_info->get_parent(); + if (parent_pc_info) { + pc_info = parent_pc_info; + goto next_context; + } + + // Method still not found, try parent class + const registered_class_info * parent_reg_info = reg_info->get_parent(); + if (parent_reg_info) { + reg_info = parent_reg_info; + pc_info = &c.get_class_info(); + goto next_class; + } - if (is_of_type(c, print_tree)) { + // Method still not found. This shouldn't happen because basic (the + // base class of the algebraic hierarchy) registers a method for + // print_context (the base class of the print context hierarchy), + // so if we end up here, there's something wrong with the class + // registry. + throw (std::runtime_error(std::string("basic::print(): method for ") + class_name() + "/" + c.class_name() + " not found")); - c.s << std::string(level, ' ') << class_name() - << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec - << ", nops=" << nops() - << std::endl; - for (unsigned i=0; i(c).delta_indent); + } else { - } else - c.s << "[" << class_name() << " object]"; + // Call method + pdt[id](*this, c, level); + } +} + +/** Default output to stream. */ +void basic::do_print(const print_context & c, unsigned level) const +{ + c.s << "[" << class_name() << " object]"; } -/** Little wrapper arount print to be called within a debugger. +/** Tree output to stream. */ +void basic::do_print_tree(const print_tree & c, unsigned level) const +{ + c.s << std::string(level, ' ') << class_name() << " @" << this + << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec; + if (nops()) + c.s << ", nops=" << nops(); + c.s << std::endl; + for (size_t i=0; iprint(std::cerr); std::cerr << std::endl; } -/** Little wrapper arount printtree to be called within a debugger. +/** Little wrapper around printtree to be called within a debugger. * - * @see basic::dbgprint - * @see basic::printtree */ -void basic::dbgprinttree(void) const + * @see basic::dbgprint */ +void basic::dbgprinttree() const { this->print(print_tree(std::cerr)); } -/** Create a new copy of this on the heap. One can think of this as simulating - * a virtual copy constructor which is needed for instance by the refcounted - * construction of an ex from a basic. */ -basic * basic::duplicate() const +/** Return relative operator precedence (for parenthezing output). */ +unsigned basic::precedence() const { - debugmsg("basic duplicate",LOGLEVEL_DUPLICATE); - return new basic(*this); + return 70; } /** Information about the object. @@ -173,7 +236,7 @@ bool basic::info(unsigned inf) const } /** Number of operands/members. */ -unsigned basic::nops() const +size_t basic::nops() const { // iterating from 0 to nops() on atomic objects should be an empty loop, // and accessing their elements is a range error. Container objects should @@ -182,81 +245,115 @@ unsigned basic::nops() const } /** Return operand/member at position i. */ -ex basic::op(int i) const +ex basic::op(size_t i) const { - return (const_cast(this))->let_op(i); + throw(std::range_error(std::string("basic::op(): ") + class_name() + std::string(" has no operands"))); } /** Return modifyable operand/member at position i. */ -ex & basic::let_op(int i) +ex & basic::let_op(size_t i) { - throw(std::out_of_range("op() out of range")); + ensure_if_modifiable(); + throw(std::range_error(std::string("basic::let_op(): ") + class_name() + std::string(" has no operands"))); } ex basic::operator[](const ex & index) const { - if (is_exactly_of_type(*index.bp,numeric)) - return op(static_cast(*index.bp).to_int()); - - throw(std::invalid_argument("non-numeric indices not supported by this type")); + if (is_exactly_a(index)) + return op(static_cast(ex_to(index).to_int())); + + throw(std::invalid_argument(std::string("non-numeric indices not supported by ") + class_name())); } -ex basic::operator[](int i) const +ex basic::operator[](size_t i) const { return op(i); } -/** Search ocurrences. An object 'has' an expression if it is the expression - * itself or one of the children 'has' it. As a consequence (according to - * the definition of children) given e=x+y+z, e.has(x) is true but e.has(x+y) - * is false. */ -bool basic::has(const ex & other) const +ex & basic::operator[](const ex & index) { - GINAC_ASSERT(other.bp!=0); - if (is_equal(*other.bp)) return true; - if (nops()>0) { - for (unsigned i=0; i(index)) + return let_op(ex_to(index).to_int()); + + throw(std::invalid_argument(std::string("non-numeric indices not supported by ") + class_name())); +} + +ex & basic::operator[](size_t i) +{ + return let_op(i); +} + +/** Test for occurrence of a pattern. An object 'has' a pattern if it matches + * the pattern itself or one of the children 'has' it. As a consequence + * (according to the definition of children) given e=x+y+z, e.has(x) is true + * but e.has(x+y) is false. */ +bool basic::has(const ex & pattern) const +{ + lst repl_lst; + if (match(pattern, repl_lst)) + return true; + for (size_t i=0; isetflag(status_flags::dynallocated); + copy->clearflag(status_flags::hash_calculated | status_flags::expanded); + for (size_t i=0; ilet_op(i) = f(copy->op(i)); + return *copy; +} + /** Return degree of highest power in object s. */ int basic::degree(const ex & s) const { - return 0; + return is_equal(ex_to(s)) ? 1 : 0; } /** Return degree of lowest power in object s. */ int basic::ldegree(const ex & s) const { - return 0; + return is_equal(ex_to(s)) ? 1 : 0; } /** Return coefficient of degree n in object s. */ ex basic::coeff(const ex & s, int n) const { - return n==0 ? *this : _ex0(); + if (is_equal(ex_to(s))) + return n==1 ? _ex1 : _ex0; + else + return n==0 ? *this : _ex0; } -/** Sort expression in terms of powers of some object(s). +/** Sort expanded expression in terms of powers of some object(s). * @param s object(s) to sort in * @param distributed recursive or distributed form (only used when s is a list) */ ex basic::collect(const ex & s, bool distributed) const { ex x; - if (is_ex_of_type(s, lst)) { + if (is_a(s)) { // List of objects specified + if (s.nops() == 0) + return *this; if (s.nops() == 1) return collect(s.op(0)); else if (distributed) { // Get lower/upper degree of all symbols in list - int num = s.nops(); + size_t num = s.nops(); struct sym_info { ex sym; int ldeg, deg; @@ -265,7 +362,7 @@ ex basic::collect(const ex & s, bool distributed) const }; sym_info *si = new sym_info[num]; ex c = *this; - for (int i=0; ildegree(si[i].sym); si[i].deg = this->degree(si[i].sym); @@ -275,17 +372,17 @@ ex basic::collect(const ex & s, bool distributed) const while (true) { // Calculate coeff*x1^c1*...*xn^cn - ex y = _ex1(); - for (int i=0; i=0; n--) + size_t n = s.nops() - 1; + while (true) { x = x.collect(s[n]); + if (n == 0) + break; + n--; + } } } else { @@ -325,18 +427,49 @@ done: delete[] si; return x + (*this - x).expand(); } -/** Perform automatic non-interruptive symbolic evaluation on expression. */ +/** Perform automatic non-interruptive term rewriting rules. */ ex basic::eval(int level) const { // There is nothing to do for basic objects: - return this->hold(); + return hold(); } +/** Function object to be applied by basic::evalf(). */ +struct evalf_map_function : public map_function { + int level; + evalf_map_function(int l) : level(l) {} + ex operator()(const ex & e) { return evalf(e, level); } +}; + /** Evaluate object numerically. */ ex basic::evalf(int level) const { - // There is nothing to do for basic objects: - return *this; + if (nops() == 0) + return *this; + else { + if (level == 1) + return *this; + else if (level == -max_recursion_level) + throw(std::runtime_error("max recursion level reached")); + else { + evalf_map_function map_evalf(level - 1); + return map(map_evalf); + } + } +} + +/** Function object to be applied by basic::evalm(). */ +struct evalm_map_function : public map_function { + ex operator()(const ex & e) { return evalm(e); } +} map_evalm; + +/** Evaluate sums, products and integer powers of matrices. */ +ex basic::evalm() const +{ + if (nops() == 0) + return *this; + else + return map(map_evalm); } /** Perform automatic symbolic evaluations on indexed expression that @@ -392,18 +525,121 @@ bool basic::contract_with(exvector::iterator self, exvector::iterator other, exv return false; } +/** Check whether the expression matches a given pattern. For every wildcard + * object in the pattern, an expression of the form "wildcard == matching_expression" + * is added to repl_lst. */ +bool basic::match(const ex & pattern, lst & repl_lst) const +{ +/* + Sweet sweet shapes, sweet sweet shapes, + That's the key thing, right right. + Feed feed face, feed feed shapes, + But who is the king tonight? + Who is the king tonight? + Pattern is the thing, the key thing-a-ling, + But who is the king of Pattern? + But who is the king, the king thing-a-ling, + Who is the king of Pattern? + Bog is the king, the king thing-a-ling, + Bog is the king of Pattern. + Ba bu-bu-bu-bu bu-bu-bu-bu-bu-bu bu-bu + Bog is the king of Pattern. +*/ + + if (is_exactly_a(pattern)) { + + // Wildcard matches anything, but check whether we already have found + // a match for that wildcard first (if so, it the earlier match must + // be the same expression) + for (lst::const_iterator it = repl_lst.begin(); it != repl_lst.end(); ++it) { + if (it->op(0).is_equal(pattern)) + return is_equal(ex_to(it->op(1))); + } + repl_lst.append(pattern == *this); + return true; + + } else { + + // Expression must be of the same type as the pattern + if (tinfo() != ex_to(pattern).tinfo()) + return false; + + // Number of subexpressions must match + if (nops() != pattern.nops()) + return false; + + // No subexpressions? Then just compare the objects (there can't be + // wildcards in the pattern) + if (nops() == 0) + return is_equal_same_type(ex_to(pattern)); + + // Check whether attributes that are not subexpressions match + if (!match_same_type(ex_to(pattern))) + return false; + + // Otherwise the subexpressions must match one-to-one + for (size_t i=0; isecond; + } else { + for (it = m.begin(); it != m.end(); ++it) { + lst repl_lst; + if (match(ex_to(it->first), repl_lst)) + return it->second.subs(repl_lst, options | subs_options::no_pattern); // avoid infinite recursion when re-substituting the wildcards + } + } + + return *this; +} + /** Substitute a set of objects by arbitrary expressions. The ex returned * will already be evaluated. */ -ex basic::subs(const lst & ls, const lst & lr) const +ex basic::subs(const exmap & m, unsigned options) const { - GINAC_ASSERT(ls.nops() == lr.nops()); + size_t num = nops(); + if (num) { + + // Substitute in subexpressions + for (size_t i=0; isetflag(status_flags::dynallocated); + copy->clearflag(status_flags::hash_calculated | status_flags::expanded); + + // Substitute the changed operand + copy->let_op(i++) = subsed_op; - for (unsigned i=0; ilet_op(i) = op(i).subs(m, options); + + // Perform substitutions on the new object as a whole + return copy->subs_one_level(m, options); + } + } } - return *this; + // Nothing changed or no subexpressions + return subs_one_level(m, options); } /** Default interface of nth derivative ex::diff(s, n). It should be called @@ -433,25 +669,37 @@ ex basic::diff(const symbol & s, unsigned nth) const } /** Return a vector containing the free indices of an expression. */ -exvector basic::get_free_indices(void) const +exvector basic::get_free_indices() const { return exvector(); // return an empty exvector } -ex basic::simplify_ncmul(const exvector & v) const +ex basic::eval_ncmul(const exvector & v) const { - return simplified_ncmul(v); + return hold_ncmul(v); } // protected -/** Default implementation of ex::diff(). It simply throws an error message. +/** Function object to be applied by basic::derivative(). */ +struct derivative_map_function : public map_function { + const symbol &s; + derivative_map_function(const symbol &sym) : s(sym) {} + ex operator()(const ex & e) { return diff(e, s); } +}; + +/** Default implementation of ex::diff(). It maps the operation on the + * operands (or returns 0 when the object has no operands). * - * @exception logic_error (differentiation not supported by this type) * @see ex::diff */ ex basic::derivative(const symbol & s) const { - throw(std::logic_error("differentiation not supported by this type")); + if (nops() == 0) + return _ex0; + else { + derivative_map_function map_derivative(s); + return map(map_derivative); + } } /** Returns order relation between two objects of same type. This needs to be @@ -471,15 +719,32 @@ int basic::compare_same_type(const basic & other) const * than an order relation and then it can be overridden. */ bool basic::is_equal_same_type(const basic & other) const { - return this->compare_same_type(other)==0; + return compare_same_type(other)==0; +} + +/** Returns true if the attributes of two objects are similar enough for + * a match. This function must not match subexpressions (this is already + * done by basic::match()). Only attributes not accessible by op() should + * be compared. This is also the reason why this function doesn't take the + * wildcard replacement list from match() as an argument: only subexpressions + * are subject to wildcard matches. Also, this function only needs to be + * implemented for container classes because is_equal_same_type() is + * automatically used instead of match_same_type() if nops() == 0. + * + * @see basic::match */ +bool basic::match_same_type(const basic & other) const +{ + // The default is to only consider subexpressions, but not any other + // attributes + return true; } -unsigned basic::return_type(void) const +unsigned basic::return_type() const { return return_types::commutative; } -unsigned basic::return_type_tinfo(void) const +unsigned basic::return_type_tinfo() const { return tinfo(); } @@ -490,17 +755,14 @@ unsigned basic::return_type_tinfo(void) const * members. For this reason it is well suited for container classes but * atomic classes should override this implementation because otherwise they * would all end up with the same hashvalue. */ -unsigned basic::calchash(void) const +unsigned basic::calchash() const { unsigned v = golden_ratio_hash(tinfo()); - for (unsigned i=0; i(this))->op(i).gethash(); + for (size_t i=0; iop(i).gethash(); } - - // mask out numeric hashes: - v &= 0x7FFFFFFFU; - + // store calculated hash value only if object is already evaluated if (flags & status_flags::evaluated) { setflag(status_flags::hash_calculated); @@ -510,11 +772,23 @@ unsigned basic::calchash(void) const return v; } +/** Function object to be applied by basic::expand(). */ +struct expand_map_function : public map_function { + unsigned options; + expand_map_function(unsigned o) : options(o) {} + ex operator()(const ex & e) { return expand(e, options); } +}; + /** Expand expression, i.e. multiply it out and return the result as a new * expression. */ ex basic::expand(unsigned options) const { - return this->setflag(status_flags::expanded); + if (nops() == 0) + return (options == 0) ? setflag(status_flags::expanded) : *this; + else { + expand_map_function map_expand(options); + return ex_to(map(map_expand)).setflag(options == 0 ? status_flags::expanded : 0); + } } @@ -524,82 +798,43 @@ ex basic::expand(unsigned options) const // public -/** 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,...), which is converted to - * subs(lst(object1,object2,...),lst(ex1,ex2,...)). */ -ex basic::subs(const ex & e) const -{ - if (e.info(info_flags::relation_equal)) { - return subs(lst(e)); - } - if (!e.info(info_flags::list)) { - throw(std::invalid_argument("basic::subs(ex): argument must be a list")); - } - lst ls; - lst lr; - for (unsigned i=0; ihash_other) return 1; - - unsigned typeid_this = tinfo(); - unsigned typeid_other = other.tinfo(); - - if (typeid_thisprint(print_tree(std::cout)); -// std::cout << " and "; -// other.print(print_tree(std::cout)); -// std::cout << std::endl; - return -1; - } - if (typeid_this>typeid_other) { + + const unsigned typeid_this = tinfo(); + const unsigned typeid_other = other.tinfo(); + if (typeid_this==typeid_other) { + GINAC_ASSERT(typeid(*this)==typeid(other)); +// int cmpval = compare_same_type(other); +// if (cmpval!=0) { +// std::cout << "hash collision, same type: " +// << *this << " and " << other << std::endl; +// this->print(print_tree(std::cout)); +// std::cout << " and "; +// other.print(print_tree(std::cout)); +// std::cout << std::endl; +// } +// return cmpval; + return compare_same_type(other); + } else { // std::cout << "hash collision, different types: " // << *this << " and " << other << std::endl; // this->print(print_tree(std::cout)); // std::cout << " and "; // other.print(print_tree(std::cout)); // std::cout << std::endl; - return 1; + return (typeid_thisprint(print_tree(std::cout)); -// std::cout << " and "; -// other.print(print_tree(std::cout)); -// std::cout << std::endl; -// } -// return cmpval; - - return compare_same_type(other); } -/** Test for equality. +/** Test for syntactic equality. * This is only a quick test, meaning objects should be in the same domain. * You might have to .expand(), .normal() objects first, depending on the * domain of your computation, to get a more reliable answer. @@ -614,7 +849,7 @@ bool basic::is_equal(const basic & other) const GINAC_ASSERT(typeid(*this)==typeid(other)); - return this->is_equal_same_type(other); + return is_equal_same_type(other); } // protected @@ -622,27 +857,20 @@ bool basic::is_equal(const basic & other) const /** Stop further evaluation. * * @see basic::eval */ -const basic & basic::hold(void) const +const basic & basic::hold() const { - return this->setflag(status_flags::evaluated); + return setflag(status_flags::evaluated); } /** Ensure the object may be modified without hurting others, throws if this * is not the case. */ -void basic::ensure_if_modifiable(void) const +void basic::ensure_if_modifiable() const { - if (this->refcount>1) + if (get_refcount() > 1) throw(std::runtime_error("cannot modify multiply referenced object")); + clearflag(status_flags::hash_calculated | status_flags::evaluated); } -////////// -// static member variables -////////// - -// protected - -unsigned basic::precedence = 70; - ////////// // global variables //////////