]> www.ginac.de Git - ginac.git/blobdiff - ginac/basic.cpp
- prepared for 1.0.13 release
[ginac.git] / ginac / basic.cpp
index c899d19f1659c2641d3b4048108bf5b90019c5f7..f625e92b342a39e3538fa397649d5fc836e7e237 100644 (file)
@@ -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
 #include "lst.h"
 #include "ncmul.h"
 #include "relational.h"
+#include "wildcard.h"
 #include "print.h"
 #include "archive.h"
 #include "utils.h"
-#include "debugmsg.h"
 
 namespace GiNaC {
 
 GINAC_IMPLEMENT_REGISTERED_CLASS_NO_CTORS(basic, void)
 
 //////////
-// default ctor, dtor, copy ctor assignment operator and helpers
+// default ctor, dtor, copy ctor, assignment operator and helpers
 //////////
 
 // public
 
 basic::basic(const basic & other) : tinfo_key(TINFO_basic), flags(0), refcount(0)
 {
-       debugmsg("basic copy ctor", LOGLEVEL_CONSTRUCT);
        copy(other);
 }
 
 const basic & basic::operator=(const basic & other)
 {
-       debugmsg("basic operator=", LOGLEVEL_ASSIGNMENT);
        if (this != &other) {
                destroy(true);
                copy(other);
@@ -82,8 +80,6 @@ const basic & basic::operator=(const basic & other)
 /** 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))
@@ -101,12 +97,6 @@ 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
 //////////
@@ -119,8 +109,6 @@ void basic::archive(archive_node &n) const
  *               level for placing parentheses and formatting */
 void basic::print(const print_context & c, unsigned level) const
 {
-       debugmsg("basic print", LOGLEVEL_PRINT);
-
        if (is_of_type(c, print_tree)) {
 
                c.s << std::string(level, ' ') << class_name()
@@ -134,7 +122,7 @@ void basic::print(const print_context & c, unsigned level) const
                c.s << "[" << class_name() << " object]";
 }
 
-/** 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.
@@ -146,7 +134,7 @@ void basic::dbgprint(void) const
        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 */
@@ -166,7 +154,6 @@ unsigned basic::precedence(void) const
  *  construction of an ex from a basic. */
 basic * basic::duplicate() const
 {
-       debugmsg("basic duplicate",LOGLEVEL_DUPLICATE);
        return new basic(*this);
 }
 
@@ -202,9 +189,9 @@ ex & basic::let_op(int i)
 
 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());
-       
+       if (is_ex_exactly_of_type(index,numeric))
+               return op(ex_to<numeric>(index).to_int());
+
        throw(std::invalid_argument("non-numeric indices not supported by this type"));
 }
 
@@ -213,43 +200,61 @@ ex basic::operator[](int 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
+/** 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
 {
-       GINAC_ASSERT(other.bp!=0);
        lst repl_lst;
-       if (match(*other.bp, repl_lst)) return true;
-       if (nops()>0) {
-               for (unsigned i=0; i<nops(); i++)
-                       if (op(i).has(other))
-                               return true;
-       }
+       if (match(pattern, repl_lst))
+               return true;
+       for (unsigned i=0; i<nops(); i++)
+               if (op(i).has(pattern))
+                       return true;
        
        return false;
 }
 
+/** Construct new expression by applying the specified function to all
+ *  sub-expressions (one level only, not recursively). */
+ex basic::map(map_function & f) const
+{
+       unsigned num = nops();
+       if (num == 0)
+               return *this;
+
+       basic *copy = duplicate();
+       copy->setflag(status_flags::dynallocated);
+       copy->clearflag(status_flags::hash_calculated | status_flags::expanded);
+       ex e(*copy);
+       for (unsigned i=0; i<num; i++)
+               e.let_op(i) = f(e.op(i));
+       return e.eval();
+}
+
 /** 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
@@ -258,6 +263,8 @@ ex basic::collect(const ex & s, bool distributed) const
        if (is_ex_of_type(s, lst)) {
 
                // List of objects specified
+               if (s.nops() == 0)
+                       return *this;
                if (s.nops() == 1)
                        return collect(s.op(0));
 
@@ -283,7 +290,7 @@ ex basic::collect(const ex & s, bool distributed) const
                        while (true) {
 
                                // Calculate coeff*x1^c1*...*xn^cn
-                               ex y = _ex1();
+                               ex y = _ex1;
                                for (int i=0; i<num; i++) {
                                        int cnt = si[i].cnt;
                                        y *= power(si[i].sym, cnt);
@@ -293,7 +300,7 @@ ex basic::collect(const ex & s, bool distributed) const
                                // Increment counters
                                int n = num - 1;
                                while (true) {
-                                       si[n].cnt++;
+                                       ++si[n].cnt;
                                        if (si[n].cnt <= si[n].deg) {
                                                // Update coefficients
                                                ex c;
@@ -333,18 +340,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();
 }
 
+/** 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(void) const
+{
+       if (nops() == 0)
+               return *this;
+       else
+               return map(map_evalm);
 }
 
 /** Perform automatic symbolic evaluations on indexed expression that
@@ -405,7 +443,22 @@ bool basic::contract_with(exvector::iterator self, exvector::iterator other, exv
  *  is added to repl_lst. */
 bool basic::match(const ex & pattern, lst & repl_lst) const
 {
-//clog << "match " << *this << " with " << pattern << ", repl_lst = " << repl_lst << endl;
+/*
+       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_ex_exactly_of_type(pattern, wildcard)) {
 
                // Wildcard matches anything, but check whether we already have found
@@ -413,7 +466,7 @@ bool basic::match(const ex & pattern, lst & repl_lst) const
                // 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);
+                               return is_equal(ex_to<basic>(repl_lst.op(i).op(1)));
                }
                repl_lst.append(pattern == *this);
                return true;
@@ -421,7 +474,7 @@ bool basic::match(const ex & pattern, lst & repl_lst) const
        } else {
 
                // Expression must be of the same type as the pattern
-               if (tinfo() != pattern.bp->tinfo())
+               if (tinfo() != ex_to<basic>(pattern).tinfo())
                        return false;
 
                // Number of subexpressions must match
@@ -431,7 +484,11 @@ bool basic::match(const ex & pattern, lst & repl_lst) const
                // 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;
 
                // Otherwise the subexpressions must match one-to-one
                for (unsigned i=0; i<nops(); i++)
@@ -451,14 +508,14 @@ ex basic::subs(const lst & ls, const lst & lr, bool no_pattern) const
 
        if (no_pattern) {
                for (unsigned i=0; i<ls.nops(); i++) {
-                       if (is_equal(*ls.op(i).bp))
+                       if (is_equal(ex_to<basic>(ls.op(i))))
                                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 recursion when re-substituting the wildcards
+                       if (match(ex_to<basic>(ls.op(i)), repl_lst))
+                               return lr.op(i).subs(repl_lst, true); // avoid infinite recursion when re-substituting the wildcards
                }
        }
 
@@ -504,13 +561,25 @@ ex basic::simplify_ncmul(const exvector & v) const
 
 // 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
@@ -530,7 +599,24 @@ 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
@@ -569,11 +655,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<basic>(map(map_expand)).setflag(options == 0 ? status_flags::expanded : 0);
+       }
 }
 
 
@@ -673,7 +771,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
@@ -683,7 +781,7 @@ bool basic::is_equal(const basic & other) const
  *  @see basic::eval */
 const basic & basic::hold(void) const
 {
-       return this->setflag(status_flags::evaluated);
+       return setflag(status_flags::evaluated);
 }
 
 /** Ensure the object may be modified without hurting others, throws if this
@@ -692,6 +790,7 @@ void basic::ensure_if_modifiable(void) const
 {
        if (this->refcount>1)
                throw(std::runtime_error("cannot modify multiply referenced object"));
+       clearflag(status_flags::hash_calculated);
 }
 
 //////////