]> www.ginac.de Git - ginac.git/blobdiff - ginac/basic.cpp
* Fix a bitch of a bug where 1<I (and all other relationals) returned true.
[ginac.git] / ginac / basic.cpp
index bf5bd6cb02b0d1c89e8b87acdc000a0913108ebb..70f84ea83ef731336f16807973c3cd19f1315d07 100644 (file)
@@ -33,6 +33,7 @@
 #include "symbol.h"
 #include "lst.h"
 #include "ncmul.h"
+#include "relational.h"
 #include "print.h"
 #include "archive.h"
 #include "utils.h"
@@ -133,7 +134,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.
@@ -145,7 +146,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 */
@@ -212,23 +213,40 @@ ex basic::operator[](int i) const
        return op(i);
 }
 
-/** Search ocurrences.  An object  'has' an expression if it is the expression
+/** 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. */
+ *  is false.  The expression can also contain wildcards. */
 bool basic::has(const ex & other) const
 {
        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;
-       }
+       lst repl_lst;
+       if (match(*other.bp, repl_lst))
+               return true;
+       for (unsigned i=0; i<nops(); i++)
+               if (op(i).has(other))
+                       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
 {
@@ -247,7 +265,7 @@ ex basic::coeff(const ex & s, int n) const
        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
@@ -338,11 +356,42 @@ ex basic::eval(int level) const
        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
@@ -398,15 +447,81 @@ 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_ex_exactly_of_type(pattern, wildcard)) {
+
+               // 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);
+               }
+               repl_lst.append(pattern == *this);
+               return true;
+
+       } else {
+
+               // Expression must be of the same type as the pattern
+               if (tinfo() != pattern.bp->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(*pattern.bp);
+
+               // Otherwise the subexpressions must match one-to-one
+               for (unsigned i=0; i<nops(); i++)
+                       if (!op(i).match(pattern.op(i), repl_lst))
+                               return false;
+
+               // Looks similar enough, match found
+               return true;
+       }
+}
+
 /** 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 lst & ls, const lst & lr, bool no_pattern) const
 {
        GINAC_ASSERT(ls.nops() == lr.nops());
 
-       for (unsigned i=0; i<ls.nops(); i++) {
-               if (is_equal(*ls.op(i).bp))
-                       return lr.op(i);
+       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
+               }
        }
 
        return *this;
@@ -451,13 +566,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
@@ -516,11 +643,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 this->setflag(status_flags::expanded);
+       else {
+               expand_map_function map_expand(options);
+               return map(map_expand).bp->setflag(status_flags::expanded);
+       }
 }
 
 
@@ -535,10 +674,10 @@ ex basic::expand(unsigned options) const
  *  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
+ex basic::subs(const ex & e, bool no_pattern) const
 {
        if (e.info(info_flags::relation_equal)) {
-               return subs(lst(e));
+               return subs(lst(e), no_pattern);
        }
        if (!e.info(info_flags::list)) {
                throw(std::invalid_argument("basic::subs(ex): argument must be a list"));
@@ -553,7 +692,7 @@ ex basic::subs(const ex & e) const
                ls.append(r.op(0));
                lr.append(r.op(1));
        }
-       return subs(ls, lr);
+       return subs(ls, lr, no_pattern);
 }
 
 /** Compare objects to establish canonical ordering.
@@ -639,6 +778,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);
 }
 
 //////////