X-Git-Url: https://www.ginac.de/ginac.git//ginac.git?p=ginac.git;a=blobdiff_plain;f=ginac%2Fbasic.cpp;h=f86483e4ec7da5b7000c258939e18cc0b6e9c4bd;hp=595d64500c37435b1ea324b39782d07cc72f88c2;hb=36ffb97c48fbbd3acb2b1aa305872e00a4456dc4;hpb=f64dcc8accf3e0603d0701de0c87e36f1ee6262d diff --git a/ginac/basic.cpp b/ginac/basic.cpp index 595d6450..f86483e4 100644 --- a/ginac/basic.cpp +++ b/ginac/basic.cpp @@ -3,7 +3,7 @@ * Implementation of GiNaC's ABC. */ /* - * GiNaC Copyright (C) 1999-2003 Johannes Gutenberg University Mainz, Germany + * GiNaC Copyright (C) 1999-2006 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,7 +17,7 @@ * * 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 */ #include @@ -36,13 +36,16 @@ #include "relational.h" #include "operators.h" #include "wildcard.h" -#include "print.h" #include "archive.h" #include "utils.h" +#include "inifcns.h" namespace GiNaC { -GINAC_IMPLEMENT_REGISTERED_CLASS(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 constructor, destructor, copy constructor and assignment operator @@ -53,9 +56,8 @@ GINAC_IMPLEMENT_REGISTERED_CLASS(basic, void) /** 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), refcount(0) +basic::basic(const basic & other) : tinfo_key(other.tinfo_key), flags(other.flags & ~status_flags::dynallocated), hashvalue(other.hashvalue) { - GINAC_ASSERT(typeid(*this) == typeid(other)); } /** basic assignment operator: the other object might be of a derived class. */ @@ -66,13 +68,13 @@ const basic & basic::operator=(const basic & other) // 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. - flags = 0; + 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; - refcount = 0; + set_refcount(0); return *this; } @@ -91,7 +93,7 @@ const basic & basic::operator=(const basic & other) ////////// /** Construct object from archive_node. */ -basic::basic(const archive_node &n, lst &sym_lst) : flags(0), refcount(0) +basic::basic(const archive_node &n, lst &sym_lst) : flags(0) { // Reconstruct tinfo_key from class name std::string class_name; @@ -116,23 +118,85 @@ void basic::archive(archive_node &n) const // 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 { - if (is_a(c)) { + print_dispatch(get_class_info(), c, level); +} - c.s << std::string(level, ' ') << class_name() - << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec - << ", nops=" << nops() - << std::endl; - for (size_t i=0; i(c).delta_indent); +/** 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(); - } else - c.s << "[" << class_name() << " object]"; +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; + } + + // 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")); + + } else { + + // 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]"; +} + +/** 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); + this->print(print_dflt(std::cerr)); std::cerr << std::endl; } @@ -156,7 +220,7 @@ void basic::dbgprinttree() const this->print(print_tree(std::cerr)); } -/** Return relative operator precedence (for parenthizing output). */ +/** Return relative operator precedence (for parenthezing output). */ unsigned basic::precedence() const { return 70; @@ -223,13 +287,13 @@ ex & basic::operator[](size_t i) * 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 +bool basic::has(const ex & pattern, unsigned options) 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; + basic *copy = NULL; + for (size_t i=0; ilet_op(i) = n; + } + } + + if (copy) { + copy->setflag(status_flags::dynallocated); + copy->clearflag(status_flags::hash_calculated | status_flags::expanded); + return *copy; + } else + return *this; +} + +/** Check whether this is a polynomial in the given variables. */ +bool basic::is_polynomial(const ex & var) const +{ + return !has(var) || is_equal(ex_to(var)); } /** Return degree of highest power in object s. */ @@ -408,6 +489,20 @@ ex basic::evalm() const return map(map_evalm); } +/** Function object to be applied by basic::eval_integ(). */ +struct eval_integ_map_function : public map_function { + ex operator()(const ex & e) { return eval_integ(e); } +} map_eval_integ; + +/** Evaluate integrals, if result is known. */ +ex basic::eval_integ() const +{ + if (nops() == 0) + return *this; + else + return map(map_eval_integ); +} + /** Perform automatic symbolic evaluations on indexed expression that * contains this object as the base expression. */ ex basic::eval_indexed(const basic & i) const @@ -422,7 +517,7 @@ ex basic::eval_indexed(const basic & i) const * (or a subclass) and their indices are compatible. This function is used * internally by simplify_indexed(). * - * @param self First indexed expression; it's base object is *this + * @param self First indexed expression; its base object is *this * @param other Second indexed expression * @return sum of self and other * @see ex::simplify_indexed() */ @@ -434,7 +529,7 @@ ex basic::add_indexed(const ex & self, const ex & other) const /** Multiply an indexed expression with a scalar. This function is used * internally by simplify_indexed(). * - * @param self Indexed expression; it's base object is *this + * @param self Indexed expression; its base object is *this * @param other Numeric value * @return product of self and other * @see ex::simplify_indexed() */ @@ -450,7 +545,7 @@ ex basic::scalar_mul_indexed(const ex & self, const numeric & other) const * and that at least one dummy index has been found. This functions is * used internally by simplify_indexed(). * - * @param self Pointer to first indexed expression; it's base object is *this + * @param self Pointer to first indexed expression; its base object is *this * @param other Pointer to second indexed expression * @param v The complete vector of factors * @return true if the contraction was successful, false otherwise @@ -485,8 +580,8 @@ bool basic::match(const ex & pattern, lst & repl_lst) const 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) + // a match for that wildcard first (if so, 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))); @@ -524,22 +619,21 @@ bool basic::match(const ex & pattern, lst & repl_lst) const } /** Helper function for subs(). Does not recurse into subexpressions. */ -ex basic::subs_one_level(const lst & ls, const lst & lr, unsigned options) const +ex basic::subs_one_level(const exmap & m, unsigned options) const { - GINAC_ASSERT(ls.nops() == lr.nops()); + exmap::const_iterator it; - lst::const_iterator its, itr; - - if (options & subs_options::subs_no_pattern) { - for (its = ls.begin(), itr = lr.begin(); its != ls.end(); ++its, ++itr) { - if (is_equal(ex_to(*its))) - return *itr; - } + if (options & subs_options::no_pattern) { + ex thisex = *this; + it = m.find(thisex); + if (it != m.end()) + return it->second; + return thisex; } else { - for (its = ls.begin(), itr = lr.begin(); its != ls.end(); ++its, ++itr) { + for (it = m.begin(); it != m.end(); ++it) { lst repl_lst; - if (match(ex_to(*its), repl_lst)) - return itr->subs(repl_lst, options | subs_options::subs_no_pattern); // avoid infinite recursion when re-substituting the wildcards + 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 } } @@ -548,7 +642,7 @@ ex basic::subs_one_level(const lst & ls, const lst & lr, unsigned options) const /** Substitute a set of objects by arbitrary expressions. The ex returned * will already be evaluated. */ -ex basic::subs(const lst & ls, const lst & lr, unsigned options) const +ex basic::subs(const exmap & m, unsigned options) const { size_t num = nops(); if (num) { @@ -556,7 +650,7 @@ ex basic::subs(const lst & ls, const lst & lr, unsigned options) const // Substitute in subexpressions for (size_t i=0; ilet_op(i) = op(i).subs(ls, lr, options); + copy->let_op(i) = op(i).subs(m, options); // Perform substitutions on the new object as a whole - return copy->subs_one_level(ls, lr, options); + return copy->subs_one_level(m, options); } } } // Nothing changed or no subexpressions - return subs_one_level(ls, lr, options); + return subs_one_level(m, options); } /** Default interface of nth derivative ex::diff(s, n). It should be called @@ -613,6 +707,21 @@ exvector basic::get_free_indices() const return exvector(); // return an empty exvector } +ex basic::conjugate() const +{ + return *this; +} + +ex basic::real_part() const +{ + return real_part_function(*this).hold(); +} + +ex basic::imag_part() const +{ + return imag_part_function(*this).hold(); +} + ex basic::eval_ncmul(const exvector & v) const { return hold_ncmul(v); @@ -683,9 +792,9 @@ unsigned basic::return_type() const return return_types::commutative; } -unsigned basic::return_type_tinfo() const +tinfo_t basic::return_type_tinfo() const { - return tinfo(); + return tinfo_key; } /** Compute the hash value of an object and if it makes sense to store it in @@ -696,10 +805,10 @@ unsigned basic::return_type_tinfo() const * would all end up with the same hashvalue. */ unsigned basic::calchash() const { - unsigned v = golden_ratio_hash(tinfo()); + unsigned v = golden_ratio_hash((p_int)tinfo()); for (size_t i=0; i(this))->op(i).gethash(); + v ^= this->op(i).gethash(); } // store calculated hash value only if object is already evaluated @@ -715,7 +824,7 @@ unsigned basic::calchash() const 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); } + ex operator()(const ex & e) { return e.expand(options); } }; /** Expand expression, i.e. multiply it out and return the result as a new @@ -737,47 +846,24 @@ 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, unsigned options) const -{ - if (e.info(info_flags::relation_equal)) { - return subs(lst(e.lhs()), lst(e.rhs()), options); - } - if (!e.info(info_flags::list)) { - throw(std::invalid_argument("basic::subs(ex): argument must be a list")); - } - - // Split list into two - lst ls; - lst lr; - 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")); - } - ls.append(r.op(0)); - lr.append(r.op(1)); - } - return subs(ls, lr, options); -} - /** Compare objects syntactically to establish canonical ordering. * All compare functions return: -1 for *this less than other, 0 equal, * 1 greater. */ int basic::compare(const basic & other) const { +#ifdef GINAC_COMPARE_STATISTICS + compare_statistics.total_basic_compares++; +#endif const unsigned hash_this = gethash(); const unsigned hash_other = other.gethash(); if (hash_thishash_other) return 1; +#ifdef GINAC_COMPARE_STATISTICS + compare_statistics.compare_same_hashvalue++; +#endif - const unsigned typeid_this = tinfo(); - const unsigned typeid_other = other.tinfo(); + const tinfo_t typeid_this = tinfo(); + const tinfo_t typeid_other = other.tinfo(); if (typeid_this==typeid_other) { GINAC_ASSERT(typeid(*this)==typeid(other)); // int cmpval = compare_same_type(other); @@ -790,6 +876,9 @@ int basic::compare(const basic & other) const // std::cout << std::endl; // } // return cmpval; +#ifdef GINAC_COMPARE_STATISTICS + compare_statistics.compare_same_type++; +#endif return compare_same_type(other); } else { // std::cout << "hash collision, different types: " @@ -810,13 +899,22 @@ int basic::compare(const basic & other) const * @see is_equal_same_type */ bool basic::is_equal(const basic & other) const { +#ifdef GINAC_COMPARE_STATISTICS + compare_statistics.total_basic_is_equals++; +#endif if (this->gethash()!=other.gethash()) return false; +#ifdef GINAC_COMPARE_STATISTICS + compare_statistics.is_equal_same_hashvalue++; +#endif if (this->tinfo()!=other.tinfo()) return false; GINAC_ASSERT(typeid(*this)==typeid(other)); +#ifdef GINAC_COMPARE_STATISTICS + compare_statistics.is_equal_same_type++; +#endif return is_equal_same_type(other); } @@ -834,7 +932,7 @@ const basic & basic::hold() const * is not the case. */ void basic::ensure_if_modifiable() const { - if (refcount > 1) + if (get_refcount() > 1) throw(std::runtime_error("cannot modify multiply referenced object")); clearflag(status_flags::hash_calculated | status_flags::evaluated); } @@ -845,4 +943,27 @@ void basic::ensure_if_modifiable() const int max_recursion_level = 1024; + +#ifdef GINAC_COMPARE_STATISTICS +compare_statistics_t::~compare_statistics_t() +{ + std::clog << "ex::compare() called " << total_compares << " times" << std::endl; + std::clog << "nontrivial compares: " << nontrivial_compares << " times" << std::endl; + std::clog << "basic::compare() called " << total_basic_compares << " times" << std::endl; + std::clog << "same hashvalue in compare(): " << compare_same_hashvalue << " times" << std::endl; + std::clog << "compare_same_type() called " << compare_same_type << " times" << std::endl; + std::clog << std::endl; + std::clog << "ex::is_equal() called " << total_is_equals << " times" << std::endl; + std::clog << "nontrivial is_equals: " << nontrivial_is_equals << " times" << std::endl; + std::clog << "basic::is_equal() called " << total_basic_is_equals << " times" << std::endl; + std::clog << "same hashvalue in is_equal(): " << is_equal_same_hashvalue << " times" << std::endl; + std::clog << "is_equal_same_type() called " << is_equal_same_type << " times" << std::endl; + std::clog << std::endl; + std::clog << "basic::gethash() called " << total_gethash << " times" << std::endl; + std::clog << "used cached hashvalue " << gethash_cached << " times" << std::endl; +} + +compare_statistics_t compare_statistics; +#endif + } // namespace GiNaC