* Implementation of GiNaC's ABC. */
/*
- * GiNaC Copyright (C) 1999 Johannes Gutenberg University Mainz, Germany
+ * GiNaC Copyright (C) 1999-2001 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
#include "symbol.h"
#include "lst.h"
#include "ncmul.h"
+#include "archive.h"
#include "utils.h"
#include "debugmsg.h"
-#ifndef NO_GINAC_NAMESPACE
namespace GiNaC {
-#endif // ndef NO_GINAC_NAMESPACE
+
+GINAC_IMPLEMENT_REGISTERED_CLASS_NO_CTORS(basic, void)
//////////
-// default constructor, destructor, copy constructor assignment operator and helpers
+// default ctor, dtor, copy ctor assignment operator and helpers
//////////
// public
-#ifndef INLINE_BASIC_CONSTRUCTORS
-basic::basic() : flags(0), refcount(0), tinfo_key(TINFO_BASIC)
+basic::basic(const basic & other) : tinfo_key(TINFO_basic), flags(0), refcount(0)
{
- debugmsg("basic default constructor",LOGLEVEL_CONSTRUCT);
- // nothing to do
+ debugmsg("basic copy ctor", LOGLEVEL_CONSTRUCT);
+ copy(other);
}
-basic::~basic()
+const basic & basic::operator=(const basic & other)
{
- debugmsg("basic destructor",LOGLEVEL_DESTRUCT);
- destroy(0);
- GINAC_ASSERT((!(flags & status_flags::dynallocated))||(refcount==0));
+ debugmsg("basic operator=", LOGLEVEL_ASSIGNMENT);
+ if (this != &other) {
+ destroy(true);
+ copy(other);
+ }
+ return *this;
}
-basic::basic(basic const & other) : flags(0), refcount(0), tinfo_key(TINFO_BASIC)
-{
- debugmsg("basic copy constructor",LOGLEVEL_CONSTRUCT);
- copy(other);
-}
-#endif
+// protected
-basic const & basic::operator=(basic const & other)
-{
- debugmsg("basic operator=",LOGLEVEL_ASSIGNMENT);
- if (this != &other) {
- destroy(1);
- copy(other);
- }
- return *this;
-}
+// none (all conditionally inlined)
-// protected
+//////////
+// other ctors
+//////////
-#if 0
-void basic::copy(basic const & other)
-{
- flags=other.flags & ~ status_flags::dynallocated;
- hashvalue=other.hashvalue;
- tinfo_key=other.tinfo_key;
-}
-#endif
+// none (all conditionally inlined)
//////////
-// other constructors
+// archiving
//////////
-#ifndef INLINE_BASIC_CONSTRUCTORS
-basic::basic(unsigned ti) : flags(0), refcount(0), tinfo_key(ti)
+/** 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. */
+ex basic::unarchive(const archive_node &n, const lst &sym_lst)
{
- debugmsg("basic constructor with tinfo_key",LOGLEVEL_CONSTRUCT);
- // nothing to do
+ return (new basic(n, sym_lst))->setflag(status_flags::dynallocated);
+}
+
+/** Archive the object. */
+void basic::archive(archive_node &n) const
+{
+ n.add_string("class", class_name());
}
-#endif
//////////
// functions overriding virtual functions from bases classes
// public
-/** Output to stream formatted to be useful as ginsh input. */
-void basic::print(ostream & os, unsigned upper_precedence) const
+/** Output to ostream formatted as parsable (as in ginsh) input.
+ * Generally, superfluous parenthesis should be avoided as far as possible. */
+void basic::print(std::ostream & os, unsigned upper_precedence) const
{
- debugmsg("basic print",LOGLEVEL_PRINT);
- os << "[basic object]";
+ debugmsg("basic print",LOGLEVEL_PRINT);
+ os << "[" << class_name() << " object]";
}
-/** Output to stream in ugly raw format, so brave developers can have a look
- * at the underlying structure. */
-void basic::printraw(ostream & os) const
+/** Output to ostream in ugly raw format, so brave developers can have a look
+ * at the underlying structure. */
+void basic::printraw(std::ostream & os) const
{
- debugmsg("basic printraw",LOGLEVEL_PRINT);
- os << "[basic object]";
+ debugmsg("basic printraw",LOGLEVEL_PRINT);
+ os << "[" << class_name() << " object]";
}
-/** Output to stream formatted in tree- (indented-) form, so developers can
+/** Output to ostream formatted in tree- (indented-) form, so developers can
* have a look at the underlying structure. */
-void basic::printtree(ostream & os, unsigned indent) const
+void basic::printtree(std::ostream & os, unsigned indent) const
{
- debugmsg("basic printtree",LOGLEVEL_PRINT);
- os << string(indent,' ') << "type=" << typeid(*this).name()
- << ", hash=" << hashvalue << " (0x" << hex << hashvalue << dec << ")"
- << ", flags=" << flags
- << ", nops=" << nops() << endl;
- for (int i=0; i<nops(); ++i) {
- op(i).printtree(os,indent+delta_indent);
- }
+ debugmsg("basic printtree",LOGLEVEL_PRINT);
+ os << std::string(indent,' ') << "type=" << class_name()
+ << ", hash=" << hashvalue
+ << " (0x" << std::hex << hashvalue << std::dec << ")"
+ << ", flags=" << flags
+ << ", nops=" << nops() << std::endl;
+ for (unsigned i=0; i<nops(); ++i) {
+ op(i).printtree(os,indent+delta_indent);
+ }
}
-/** Output to stream formatted as C-source.
+/** Output to ostream formatted as C-source.
*
* @param os a stream for output
* @param type variable type (one of the csrc_types)
* @param upper_precedence operator precedence of caller
* @see ex::printcsrc */
-void basic::printcsrc(ostream & os, unsigned type, unsigned upper_precedence) const
+void basic::printcsrc(std::ostream & os, unsigned type, unsigned upper_precedence) const
{
- debugmsg("basic print csrc", LOGLEVEL_PRINT);
+ debugmsg("basic print csrc", LOGLEVEL_PRINT);
}
-/** Little wrapper arount print to be called within a debugger. */
+/** Little wrapper arount 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
{
- print(cerr);
- cerr << endl;
+ this->print(std::cerr);
+ std::cerr << std::endl;
}
-/** Little wrapper arount printtree to be called within a debugger. */
+/** Little wrapper arount printtree to be called within a debugger.
+ *
+ * @see basic::dbgprint
+ * @see basic::printtree */
void basic::dbgprinttree(void) const
{
- printtree(cerr,0);
+ this->printtree(std::cerr,0);
}
+/** 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);
+ debugmsg("basic duplicate",LOGLEVEL_DUPLICATE);
+ return new basic(*this);
}
+/** Information about the object.
+ *
+ * @see class info_flags */
bool basic::info(unsigned inf) const
{
- return false; // all possible properties are false for basic objects
+ // all possible properties are false for basic objects
+ return false;
}
-int basic::nops() const
+/** Number of operands/members. */
+unsigned basic::nops() const
{
- return 0;
+ // iterating from 0 to nops() on atomic objects should be an empty loop,
+ // and accessing their elements is a range error. Container objects should
+ // override this.
+ return 0;
}
-ex basic::op(int const i) const
+/** Return operand/member at position i. */
+ex basic::op(int i) const
{
- return (const_cast<basic *>(this))->let_op(i);
+ return (const_cast<basic *>(this))->let_op(i);
}
-ex & basic::let_op(int const i)
+/** Return modifyable operand/member at position i. */
+ex & basic::let_op(int i)
{
- throw(std::out_of_range("op() out of range"));
+ throw(std::out_of_range("op() out of range"));
}
-ex basic::operator[](ex const & index) const
+ex basic::operator[](const ex & index) const
{
- if (is_exactly_of_type(*index.bp,numeric)) {
- return op(static_cast<numeric const &>(*index.bp).to_int());
- }
- throw(std::invalid_argument("non-numeric indices not supported by this type"));
+ 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"));
}
-ex basic::operator[](int const i) const
+ex basic::operator[](int i) const
{
- return op(i);
+ return op(i);
}
-bool basic::has(ex const & other) const
+/** 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
{
- GINAC_ASSERT(other.bp!=0);
- if (is_equal(*other.bp)) return true;
- if (nops()>0) {
- for (int i=0; i<nops(); i++) {
- if (op(i).has(other)) return true;
- }
- }
- return false;
+ GINAC_ASSERT(other.bp!=0);
+ if (is_equal(*other.bp)) return true;
+ if (nops()>0) {
+ for (unsigned i=0; i<nops(); i++)
+ if (op(i).has(other))
+ return true;
+ }
+
+ return false;
}
-int basic::degree(symbol const & s) const
+/** Return degree of highest power in symbol s. */
+int basic::degree(const symbol & s) const
{
- return 0;
+ return 0;
}
-int basic::ldegree(symbol const & s) const
+/** Return degree of lowest power in symbol s. */
+int basic::ldegree(const symbol & s) const
{
- return 0;
+ return 0;
}
-ex basic::coeff(symbol const & s, int const n) const
+/** Return coefficient of degree n in symbol s. */
+ex basic::coeff(const symbol & s, int n) const
{
- return n==0 ? *this : exZERO();
+ return n==0 ? *this : _ex0();
}
-ex basic::collect(symbol const & s) const
+/** Sort expression in terms of powers of some symbol.
+ * @param s symbol to sort in. */
+ex basic::collect(const symbol & s) const
{
- ex x;
- int ldeg=ldegree(s);
- int deg=degree(s);
- for (int n=ldeg; n<=deg; n++) {
- x += coeff(s,n)*power(s,n);
- }
- return x;
+ ex x;
+ for (int n=this->ldegree(s); n<=this->degree(s); n++)
+ x += this->coeff(s,n)*power(s,n);
+
+ return x;
}
+/** Perform automatic non-interruptive symbolic evaluation on expression. */
ex basic::eval(int level) const
{
- return this->hold();
+ // There is nothing to do for basic objects:
+ return this->hold();
}
+/** Evaluate object numerically. */
ex basic::evalf(int level) const
{
- return *this;
+ // There is nothing to do for basic objects:
+ return *this;
}
-ex basic::subs(lst const & ls, lst const & lr) const
+/** Perform automatic symbolic evaluations on indexed expression that
+ * contains this object as the base expression. */
+ex basic::eval_indexed(const basic & i) const
+ // this function can't take a "const ex & i" because that would result
+ // in an infinite eval() loop
{
- return *this;
+ // There is nothing to do for basic objects
+ return i.hold();
}
-exvector basic::get_indices(void) const
+/** Try to contract two indexed expressions. If a contraction exists, the
+ * function overwrites one or both arguments and returns true. Otherwise it
+ * returns false. It is guaranteed that both expressions are of class
+ * indexed (or a subclass) and that at least one dummy index has been
+ * found.
+ *
+ * @param self The first indexed expression; it's base object is *this
+ * @param other The second indexed expression
+ * @return true if the contraction was successful, false otherwise */
+bool basic::contract_with(ex & self, ex & other) const
{
- return exvector(); // return an empty exvector
+ // Do nothing
+ return false;
}
-ex basic::simplify_ncmul(exvector const & v) const
+/** Substitute a set of symbols by arbitrary expressions. The ex returned
+ * will already be evaluated. */
+ex basic::subs(const lst & ls, const lst & lr) const
{
- return simplified_ncmul(v);
+ return *this;
}
-// protected
+/** Default interface of nth derivative ex::diff(s, n). It should be called
+ * instead of ::derivative(s) for first derivatives and for nth derivatives it
+ * just recurses down.
+ *
+ * @param s symbol to differentiate in
+ * @param nth order of differentiation
+ * @see ex::diff */
+ex basic::diff(const symbol & s, unsigned nth) const
+{
+ // trivial: zeroth derivative
+ if (nth==0)
+ return ex(*this);
+
+ // evaluate unevaluated *this before differentiating
+ if (!(flags & status_flags::evaluated))
+ return ex(*this).diff(s, nth);
+
+ ex ndiff = this->derivative(s);
+ while (!ndiff.is_zero() && // stop differentiating zeros
+ nth>1) {
+ ndiff = ndiff.diff(s);
+ --nth;
+ }
+ return ndiff;
+}
-int basic::compare_same_type(basic const & other) const
+/** Return a vector containing the free indices of an expression. */
+exvector basic::get_free_indices(void) const
{
- return compare_pointers(this, &other);
+ return exvector(); // return an empty exvector
}
-bool basic::is_equal_same_type(basic const & other) const
+ex basic::simplify_ncmul(const exvector & v) const
{
- return compare_same_type(other)==0;
+ return simplified_ncmul(v);
}
-unsigned basic::return_type(void) const
+// protected
+
+/** Default implementation of ex::diff(). It simply throws an error message.
+ *
+ * @exception logic_error (differentiation not supported by this type)
+ * @see ex::diff */
+ex basic::derivative(const symbol & s) const
{
- return return_types::commutative;
+ throw(std::logic_error("differentiation not supported by this type"));
}
-unsigned basic::return_type_tinfo(void) const
+/** Returns order relation between two objects of same type. This needs to be
+ * implemented by each class. It may never return anything else than 0,
+ * signalling equality, or +1 and -1 signalling inequality and determining
+ * the canonical ordering. */
+int basic::compare_same_type(const basic & other) const
{
- return tinfo();
+ return compare_pointers(this, &other);
}
-unsigned basic::calchash(void) const
+/** Returns true if two objects of same type are equal. Normally needs
+ * not be reimplemented as long as it wasn't overwritten by some parent
+ * class, since it just calls compare_same_type(). The reason why this
+ * function exists is that sometimes it is easier to determine equality
+ * than an order relation and then it can be overridden. */
+bool basic::is_equal_same_type(const basic & other) const
{
- unsigned v=golden_ratio_hash(tinfo());
- for (int i=0; i<nops(); i++) {
- v=rotate_left_31(v);
- v ^= (const_cast<basic *>(this))->let_op(i).gethash();
- }
+ return this->compare_same_type(other)==0;
+}
- v = v & 0x7FFFFFFFU;
-
- // store calculated hash value only if object is already evaluated
- if (flags & status_flags::evaluated) {
- setflag(status_flags::hash_calculated);
- hashvalue=v;
- }
+unsigned basic::return_type(void) const
+{
+ return return_types::commutative;
+}
- return v;
+unsigned basic::return_type_tinfo(void) const
+{
+ return tinfo();
}
+/** Compute the hash value of an object and if it makes sense to store it in
+ * the objects status_flags, do so. The method inherited from class basic
+ * computes a hash value based on the type and hash values of possible
+ * 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 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();
+ }
+
+ // 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);
+ hashvalue = v;
+ }
+
+ return v;
+}
+
+/** 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);
+ return this->setflag(status_flags::expanded);
}
+
//////////
// non-virtual functions in this class
//////////
// public
-ex basic::subs(ex const & e) const
-{
- // accept 2 types of replacement expressions:
- // - symbol==ex
- // - lst(symbol1==ex1,symbol2==ex2,...)
- // convert to subs(lst(symbol1,symbol2,...),lst(ex1,ex2,...))
- // additionally, idx can be used instead of symbol
- 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 (int i=0; i<e.nops(); i++) {
- if (!e.op(i).info(info_flags::relation_equal)) {
- throw(std::invalid_argument("basic::subs(ex): argument must be a list or equations"));
- }
- if (!e.op(i).op(0).info(info_flags::symbol)) {
- if (!e.op(i).op(0).info(info_flags::idx)) {
- throw(std::invalid_argument("basic::subs(ex): lhs must be a symbol or an idx"));
- }
- }
- ls.append(e.op(i).op(0));
- lr.append(e.op(i).op(1));
- }
- return subs(ls,lr);
-}
-
-/** Compare objects to establish canonical order.
+/** Substitute symbols in expression and return the result as a new expression.
+ * There are two valid types of replacement arguments: 1) a relational like
+ * symbol==ex and 2) a list of relationals lst(symbol1==ex1,symbol2==ex2,...),
+ * which is converted to subs(lst(symbol1,symbol2,...),lst(ex1,ex2,...)).
+ * In addition, an object of class idx can be used instead of a symbol. */
+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; i<e.nops(); i++) {
+ if (!e.op(i).info(info_flags::relation_equal)) {
+ throw(std::invalid_argument("basic::subs(ex): argument must be a list or equations"));
+ }
+ if (!e.op(i).op(0).info(info_flags::symbol)) {
+ if (!e.op(i).op(0).info(info_flags::idx)) {
+ throw(std::invalid_argument("basic::subs(ex): lhs must be a symbol or an idx"));
+ }
+ }
+ ls.append(e.op(i).op(0));
+ lr.append(e.op(i).op(1));
+ }
+ return subs(ls,lr);
+}
+
+/** Compare objects to establish canonical ordering.
* All compare functions return: -1 for *this less than other, 0 equal,
* 1 greater. */
-int basic::compare(basic const & other) const
-{
- unsigned hash_this = gethash();
- 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) {
- /*
- cout << "hash collision, different types: "
- << *this << " and " << other << endl;
- this->printraw(cout);
- cout << " and ";
- other.printraw(cout);
- cout << endl;
- */
- return -1;
- }
- if (typeid_this>typeid_other) {
- /*
- cout << "hash collision, different types: "
- << *this << " and " << other << endl;
- this->printraw(cout);
- cout << " and ";
- other.printraw(cout);
- cout << endl;
- */
- return 1;
- }
-
- GINAC_ASSERT(typeid(*this)==typeid(other));
-
- int cmpval=compare_same_type(other);
- if ((cmpval!=0)&&(hash_this<0x80000000U)) {
- /*
- cout << "hash collision, same type: "
- << *this << " and " << other << endl;
- this->printraw(cout);
- cout << " and ";
- other.printraw(cout);
- cout << endl;
- */
- }
- return cmpval;
-}
-
-bool basic::is_equal(basic const & other) const
+int basic::compare(const basic & other) const
+{
+ unsigned hash_this = gethash();
+ 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->printraw(std::cout);
+// std::cout << " and ";
+// other.printraw(std::cout);
+// std::cout << std::endl;
+ return -1;
+ }
+ if (typeid_this>typeid_other) {
+// std::cout << "hash collision, different types: "
+// << *this << " and " << other << std::endl;
+// this->printraw(std::cout);
+// std::cout << " and ";
+// other.printraw(std::cout);
+// std::cout << std::endl;
+ return 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->printraw(std::cout);
+// std::cout << " and ";
+// other.printraw(std::cout);
+// std::cout << std::endl;
+ }
+ return cmpval;
+}
+
+/** Test for 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
{
- unsigned hash_this = gethash();
- unsigned hash_other = other.gethash();
-
- if (hash_this!=hash_other) return false;
-
- unsigned typeid_this = tinfo();
- unsigned typeid_other = other.tinfo();
-
- if (typeid_this!=typeid_other) return false;
-
- GINAC_ASSERT(typeid(*this)==typeid(other));
-
- return is_equal_same_type(other);
+ if (this->gethash()!=other.gethash())
+ return false;
+ if (this->tinfo()!=other.tinfo())
+ return false;
+
+ GINAC_ASSERT(typeid(*this)==typeid(other));
+
+ return this->is_equal_same_type(other);
}
// protected
-basic const & basic::hold(void) const
+/** Stop further evaluation.
+ *
+ * @see basic::eval */
+const basic & basic::hold(void) const
{
- return setflag(status_flags::evaluated);
+ return this->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
{
- if (refcount>1) {
- throw(std::runtime_error("cannot modify multiply referenced object"));
- }
+ if (this->refcount>1)
+ throw(std::runtime_error("cannot modify multiply referenced object"));
}
//////////
// protected
-unsigned basic::precedence=70;
-unsigned basic::delta_indent=4;
-
-//////////
-// global constants
-//////////
-
-const basic some_basic;
-type_info const & typeid_basic=typeid(some_basic);
+unsigned basic::precedence = 70;
+unsigned basic::delta_indent = 4;
//////////
// global variables
//////////
-int max_recursion_level=1024;
+int max_recursion_level = 1024;
-#ifndef NO_GINAC_NAMESPACE
} // namespace GiNaC
-#endif // ndef NO_GINAC_NAMESPACE
git://www.ginac.de / ginac.git / blobdiff