* Implementation of GiNaC's ABC. */
/*
- * GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
+ * GiNaC Copyright (C) 1999-2016 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
*
* 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 <iostream>
-#include <stdexcept>
-#ifdef DO_GINAC_ASSERT
-# include <typeinfo>
-#endif
-
#include "basic.h"
#include "ex.h"
#include "numeric.h"
#include "power.h"
+#include "add.h"
#include "symbol.h"
#include "lst.h"
#include "ncmul.h"
#include "relational.h"
-#include "print.h"
+#include "operators.h"
+#include "wildcard.h"
#include "archive.h"
#include "utils.h"
-#include "debugmsg.h"
+#include "hash_seed.h"
+#include "inifcns.h"
+
+#include <iostream>
+#include <stdexcept>
+#include <typeinfo>
namespace GiNaC {
-GINAC_IMPLEMENT_REGISTERED_CLASS_NO_CTORS(basic, void)
+GINAC_IMPLEMENT_REGISTERED_CLASS_OPT(basic, void,
+ print_func<print_context>(&basic::do_print).
+ print_func<print_tree>(&basic::do_print_tree).
+ print_func<print_python_repr>(&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) : flags(other.flags & ~status_flags::dynallocated), hashvalue(other.hashvalue)
{
- debugmsg("basic copy ctor", LOGLEVEL_CONSTRUCT);
- copy(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 (typeid(*this) != typeid(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.
+ 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)
-{
- 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))
- tinfo_key = find_tinfo_key(class_name);
- else
- throw (std::runtime_error("archive node contains no class name"));
-}
-
-/** Unarchive the object. */
-DEFAULT_UNARCHIVE(basic)
+void basic::read_archive(const archive_node& n, lst& syms)
+{ }
/** Archive the object. */
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();
- if (is_of_type(c, print_tree)) {
+next_class:
+ const std::vector<print_functor> & pdt = reg_info->options.get_print_dispatch_table();
- 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<nops(); ++i)
- op(i).print(c, level + static_cast<const print_tree &>(c).delta_indent);
+next_context:
+ unsigned id = pc_info->options.get_id();
+ if (id >= pdt.size() || !(pdt[id].is_valid())) {
- } else
- c.s << "[" << class_name() << " object]";
+ // 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; i<nops(); ++i)
+ op(i).print(c, level + c.delta_indent);
+}
+
+/** Python parsable output to stream. */
+void basic::do_print_python_repr(const print_python_repr & c, unsigned level) const
+{
+ c.s << class_name() << "()";
}
-/** Little wrapper arount print to be called within a debugger.
+/** Little wrapper around print to be called within a debugger.
* This is needed because you cannot call foo.print(cout) from within the
* debugger because it might not know what cout is. This method can be
* invoked with no argument and it will simply print to stdout.
*
- * @see basic::print */
-void basic::dbgprint(void) const
+ * @see basic::print
+ * @see basic::dbgprinttree */
+void basic::dbgprint() const
{
- this->print(std::cerr);
+ this->print(print_dflt(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));
}
-/** Return relative operator precedence (for parenthizing output). */
-unsigned basic::precedence(void) const
+/** Return relative operator precedence (for parenthezing output). */
+unsigned basic::precedence() const
{
return 70;
}
-/** 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
-{
- debugmsg("basic duplicate",LOGLEVEL_DUPLICATE);
- return new basic(*this);
-}
-
/** Information about the object.
*
* @see class info_flags */
}
/** 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
}
/** Return operand/member at position i. */
-ex basic::op(int i) const
+ex basic::op(size_t i) const
{
- return (const_cast<basic *>(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)
+/** Return modifiable operand/member at position 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<const numeric &>(*index.bp).to_int());
-
- throw(std::invalid_argument("non-numeric indices not supported by this type"));
+ if (is_exactly_a<numeric>(index))
+ return op(static_cast<size_t>(ex_to<numeric>(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. The expression can also contain wildcards. */
-bool basic::has(const ex & other) const
+ex & basic::operator[](const ex & index)
+{
+ if (is_exactly_a<numeric>(index))
+ return let_op(ex_to<numeric>(index).to_int());
+
+ throw(std::invalid_argument(std::string("non-numeric indices not supported by ") + class_name()));
+}
+
+ex & basic::operator[](size_t i)
{
- GINAC_ASSERT(other.bp!=0);
- lst repl_lst;
- if (match(*other.bp, repl_lst))
+ 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, unsigned options) const
+{
+ exmap repl_lst;
+ if (match(pattern, repl_lst))
return true;
- for (unsigned i=0; i<nops(); i++)
- if (op(i).has(other))
+ for (size_t i=0; i<nops(); i++)
+ if (op(i).has(pattern, options))
return true;
return false;
}
/** Construct new expression by applying the specified function to all
- * sub-expressions. */
-ex basic::map(map_func f) const
+ * sub-expressions (one level only, not recursively). */
+ex basic::map(map_function & f) const
{
- unsigned num = nops();
+ size_t num = nops();
if (num == 0)
return *this;
- basic *copy = duplicate();
- copy->setflag(status_flags::dynallocated);
- copy->clearflag(status_flags::hash_calculated);
- ex e(*copy);
- for (unsigned i=0; i<num; i++)
- e.let_op(i) = f(e.op(i));
- return e.eval();
+ basic *copy = nullptr;
+ for (size_t i=0; i<num; i++) {
+ const ex & o = op(i);
+ const ex & n = f(o);
+ if (!are_ex_trivially_equal(o, n)) {
+ if (copy == nullptr)
+ copy = duplicate();
+ copy->let_op(i) = n;
+ }
+ }
+
+ if (copy) {
+ 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<basic>(var));
}
/** Return degree of highest power in object s. */
int basic::degree(const ex & s) const
{
- return 0;
+ return is_equal(ex_to<basic>(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<basic>(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<basic>(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<lst>(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();
- struct sym_info {
- ex sym;
- int ldeg, deg;
- int cnt; // current degree, 'counter'
- ex coeff; // coefficient for degree 'cnt'
- };
- sym_info *si = new sym_info[num];
- ex c = *this;
- for (int i=0; i<num; i++) {
- si[i].sym = s.op(i);
- si[i].ldeg = si[i].cnt = this->ldegree(si[i].sym);
- si[i].deg = this->degree(si[i].sym);
- c = si[i].coeff = c.coeff(si[i].sym, si[i].cnt);
- }
-
- while (true) {
-
- // Calculate coeff*x1^c1*...*xn^cn
- ex y = _ex1();
- for (int i=0; i<num; i++) {
- int cnt = si[i].cnt;
- y *= power(si[i].sym, cnt);
- }
- x += y * si[num - 1].coeff;
-
- // Increment counters
- int n = num - 1;
- while (true) {
- si[n].cnt++;
- if (si[n].cnt <= si[n].deg) {
- // Update coefficients
- ex c;
- if (n == 0)
- c = *this;
- else
- c = si[n - 1].coeff;
- for (int i=n; i<num; i++)
- c = si[i].coeff = c.coeff(si[i].sym, si[i].cnt);
- break;
- }
- if (n == 0)
- goto done;
- si[n].cnt = si[n].ldeg;
- n--;
+ x = this->expand();
+ if (! is_a<add>(x))
+ return x;
+ const lst& l(ex_to<lst>(s));
+
+ exmap cmap;
+ cmap[_ex1] = _ex0;
+ for (const auto & xi : x) {
+ ex key = _ex1;
+ ex pre_coeff = xi;
+ for (auto & li : l) {
+ int cexp = pre_coeff.degree(li);
+ pre_coeff = pre_coeff.coeff(li, cexp);
+ key *= pow(li, cexp);
}
+ exmap::iterator ci = cmap.find(key);
+ if (ci != cmap.end())
+ ci->second += pre_coeff;
+ else
+ cmap.insert(exmap::value_type(key, pre_coeff));
}
-done: delete[] si;
+ exvector resv;
+ for (auto & mi : cmap)
+ resv.push_back((mi.first)*(mi.second));
+ return dynallocate<add>(resv);
} else {
// Recursive form
x = *this;
- for (int n=s.nops()-1; n>=0; n--)
+ size_t n = s.nops() - 1;
+ while (true) {
x = x.collect(s[n]);
+ if (n == 0)
+ break;
+ n--;
+ }
}
} else {
return x + (*this - x).expand();
}
-/** Perform automatic non-interruptive symbolic evaluation on expression. */
-ex basic::eval(int level) const
+/** Perform automatic non-interruptive term rewriting rules. */
+ex basic::eval() 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 {
+ ex operator()(const ex & e) override { return evalf(e); }
+};
+
/** Evaluate object numerically. */
-ex basic::evalf(int level) const
+ex basic::evalf() const
{
- // There is nothing to do for basic objects:
- return *this;
+ if (nops() == 0)
+ return *this;
+ else {
+ evalf_map_function map_evalf;
+ return map(map_evalf);
+ }
}
-/** Evaluate sums and products of matrices. */
-ex basic::evalm(void) const
+/** Function object to be applied by basic::evalm(). */
+struct evalm_map_function : public map_function {
+ ex operator()(const ex & e) override { return evalm(e); }
+} map_evalm;
+
+/** Evaluate sums, products and integer powers of matrices. */
+ex basic::evalm() const
{
- unsigned num = nops();
- if (num == 0)
+ if (nops() == 0)
return *this;
else
- return map(GiNaC::evalm);
+ 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) override { 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
* (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() */
/** 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() */
* 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
}
/** 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
+ * object in the pattern, a pair with the wildcard as a key and matching
+ * expression as a value is added to repl_lst. */
+bool basic::match(const ex & pattern, exmap& repl_lst) const
{
/*
Sweet sweet shapes, sweet sweet shapes,
- Thats the key thing, right right.
+ 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 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.
*/
- if (is_ex_exactly_of_type(pattern, wildcard)) {
+ if (is_exactly_a<wildcard>(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 (unsigned i=0; i<repl_lst.nops(); i++) {
- if (repl_lst.op(i).op(0).is_equal(pattern))
- return is_equal(*repl_lst.op(i).op(1).bp);
+ // a match for that wildcard first (if so, the earlier match must be
+ // the same expression)
+ for (auto & it : repl_lst) {
+ if (it.first.is_equal(pattern))
+ return is_equal(ex_to<basic>(it.second));
}
- repl_lst.append(pattern == *this);
+ repl_lst[pattern] = *this;
return true;
} else {
// Expression must be of the same type as the pattern
- if (tinfo() != pattern.bp->tinfo())
+ if (typeid(*this) != typeid(ex_to<basic>(pattern)))
return false;
// Number of subexpressions must match
// No subexpressions? Then just compare the objects (there can't be
// wildcards in the pattern)
if (nops() == 0)
- return is_equal(*pattern.bp);
+ return is_equal_same_type(ex_to<basic>(pattern));
+
+ // Check whether attributes that are not subexpressions match
+ if (!match_same_type(ex_to<basic>(pattern)))
+ return false;
+ // Even if the expression does not match the pattern, some of
+ // its subexpressions could match it. For example, x^5*y^(-1)
+ // does not match the pattern $0^5, but its subexpression x^5
+ // does. So, save repl_lst in order to not add bogus entries.
+ exmap tmp_repl = repl_lst;
// Otherwise the subexpressions must match one-to-one
- for (unsigned i=0; i<nops(); i++)
- if (!op(i).match(pattern.op(i), repl_lst))
+ for (size_t i=0; i<nops(); i++)
+ if (!op(i).match(pattern.op(i), tmp_repl))
return false;
// Looks similar enough, match found
+ repl_lst = tmp_repl;
return true;
}
}
+/** Helper function for subs(). Does not recurse into subexpressions. */
+ex basic::subs_one_level(const exmap & m, unsigned options) const
+{
+ if (options & subs_options::no_pattern) {
+ auto it = m.find(*this);
+ if (it != m.end())
+ return it->second;
+ return *this;
+ } else {
+ for (auto & it : m) {
+ exmap repl_lst;
+ if (match(ex_to<basic>(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, bool no_pattern) const
+ex basic::subs(const exmap & m, unsigned options) const
{
- GINAC_ASSERT(ls.nops() == lr.nops());
+ size_t num = nops();
+ if (num) {
- if (no_pattern) {
- for (unsigned i=0; i<ls.nops(); i++) {
- if (is_equal(*ls.op(i).bp))
- return lr.op(i);
- }
- } else {
- for (unsigned i=0; i<ls.nops(); i++) {
- lst repl_lst;
- if (match(*ls.op(i).bp, repl_lst))
- return lr.op(i).bp->subs(repl_lst, true); // avoid infinite recursion when re-substituting the wildcards
+ // Substitute in subexpressions
+ for (size_t i=0; i<num; i++) {
+ const ex & orig_op = op(i);
+ const ex & subsed_op = orig_op.subs(m, options);
+ if (!are_ex_trivially_equal(orig_op, subsed_op)) {
+
+ // Something changed, clone the object
+ basic *copy = duplicate();
+ copy->clearflag(status_flags::hash_calculated | status_flags::expanded);
+
+ // Substitute the changed operand
+ copy->let_op(i++) = subsed_op;
+
+ // Substitute the other operands
+ for (; i<num; i++)
+ copy->let_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
}
/** 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::conjugate() const
+{
+ return *this;
+}
+
+ex basic::real_part() const
+{
+ return real_part_function(*this).hold();
+}
+
+ex basic::imag_part() const
{
- return simplified_ncmul(v);
+ return imag_part_function(*this).hold();
+}
+
+ex basic::eval_ncmul(const exvector & v) const
+{
+ 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) override { 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
* 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;
}
-unsigned basic::return_type(void) const
+/** 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() const
{
return return_types::commutative;
}
-unsigned basic::return_type_tinfo(void) const
+return_type_t basic::return_type_tinfo() const
{
- return tinfo();
+ return_type_t rt;
+ rt.tinfo = &typeid(*this);
+ rt.rl = 0;
+ return rt;
}
/** Compute the hash value of an object and if it makes sense to store it in
* 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<nops(); i++) {
- v = rotate_left_31(v);
- v ^= (const_cast<basic *>(this))->op(i).gethash();
+ unsigned v = make_hash_seed(typeid(*this));
+ for (size_t i=0; i<nops(); i++) {
+ v = rotate_left(v);
+ v ^= this->op(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);
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) override { return e.expand(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<basic>(map(map_expand)).setflag(options == 0 ? status_flags::expanded : 0);
+ }
}
// 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, bool no_pattern) const
-{
- if (e.info(info_flags::relation_equal)) {
- return subs(lst(e), no_pattern);
- }
- 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; i<e.nops(); i++) {
- ex r = e.op(i);
- 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, no_pattern);
-}
-
-/** Compare objects to establish canonical ordering.
+/** 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
{
- unsigned hash_this = gethash();
- unsigned hash_other = other.gethash();
-
+#ifdef GINAC_COMPARE_STATISTICS
+ compare_statistics.total_basic_compares++;
+#endif
+ const unsigned hash_this = gethash();
+ const unsigned hash_other = other.gethash();
if (hash_this<hash_other) return -1;
if (hash_this>hash_other) return 1;
-
- unsigned typeid_this = tinfo();
- unsigned typeid_other = other.tinfo();
-
- if (typeid_this<typeid_other) {
-// 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;
- }
- if (typeid_this>typeid_other) {
+#ifdef GINAC_COMPARE_STATISTICS
+ compare_statistics.compare_same_hashvalue++;
+#endif
+
+ const std::type_info& typeid_this = typeid(*this);
+ const std::type_info& typeid_other = typeid(other);
+ if (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;
+#ifdef GINAC_COMPARE_STATISTICS
+ compare_statistics.compare_same_type++;
+#endif
+ 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_this.before(typeid_other) ? -1 : 1);
}
-
- GINAC_ASSERT(typeid(*this)==typeid(other));
-
-// int cmpval = compare_same_type(other);
-// if ((cmpval!=0) && (hash_this<0x80000000U)) {
-// 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);
}
-/** 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.
* @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;
- if (this->tinfo()!=other.tinfo())
+#ifdef GINAC_COMPARE_STATISTICS
+ compare_statistics.is_equal_same_hashvalue++;
+#endif
+ if (typeid(*this) != typeid(other))
return false;
- GINAC_ASSERT(typeid(*this)==typeid(other));
-
- return this->is_equal_same_type(other);
+#ifdef GINAC_COMPARE_STATISTICS
+ compare_statistics.is_equal_same_type++;
+#endif
+ return is_equal_same_type(other);
}
// protected
/** 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);
}
//////////
// global variables
//////////
-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
git://www.ginac.de / ginac.git / blobdiff