]> www.ginac.de Git - ginac.git/blobdiff - ginac/ex.cpp
- fixed a problem where (p\-m*ONE)*(p\-m*ONE) would be automatically simplified
[ginac.git] / ginac / ex.cpp
index 1fb016c389e8305c95a8925c0ea131b8b5f20b0f..b6b968595e05e662aa89e2b89c0aefd4a274fbef 100644 (file)
 #include "ncmul.h"
 #include "numeric.h"
 #include "power.h"
+#include "lst.h"
 #include "relational.h"
 #include "input_lexer.h"
 #include "debugmsg.h"
 #include "utils.h"
 
-#ifndef NO_NAMESPACE_GINAC
 namespace GiNaC {
-#endif // ndef NO_NAMESPACE_GINAC
 
 //////////
-// default constructor, destructor, copy constructor assignment operator and helpers
+// other ctors
 //////////
 
-// public
-
-#ifndef INLINE_EX_CONSTRUCTORS
-
-ex::ex() : bp(_ex0().bp)
-{
-       debugmsg("ex default constructor",LOGLEVEL_CONSTRUCT);
-       GINAC_ASSERT(_ex0().bp!=0);
-       GINAC_ASSERT(_ex0().bp->flags & status_flags::dynallocated);
-       GINAC_ASSERT(bp!=0);
-       ++bp->refcount;
-}
-
-ex::~ex()
-{
-       debugmsg("ex destructor",LOGLEVEL_DESTRUCT);
-       GINAC_ASSERT(bp!=0);
-       GINAC_ASSERT(bp->flags & status_flags::dynallocated);
-       if (--bp->refcount == 0) {
-               delete bp;
-       }
-}
-
-ex::ex(const ex & other) : bp(other.bp)
-{
-       debugmsg("ex copy constructor",LOGLEVEL_CONSTRUCT);
-       GINAC_ASSERT(bp!=0);
-       GINAC_ASSERT((bp->flags) & status_flags::dynallocated);
-       ++bp->refcount;
-}
-
-const ex & ex::operator=(const ex & other)
-{
-       debugmsg("ex operator=",LOGLEVEL_ASSIGNMENT);
-       GINAC_ASSERT(bp!=0);
-       GINAC_ASSERT(bp->flags & status_flags::dynallocated);
-       GINAC_ASSERT(other.bp!=0);
-       GINAC_ASSERT(other.bp->flags & status_flags::dynallocated);
-       ++other.bp->refcount;
-       basic * tmpbp = other.bp;
-       if (--bp->refcount==0)
-               delete bp;
-       bp = tmpbp;
-       return *this;
-}
-
-#endif // ndef INLINE_EX_CONSTRUCTORS
-
-//////////
-// other constructors
-//////////
-
-// public
-
-#ifndef INLINE_EX_CONSTRUCTORS
-
-ex::ex(const basic & other)
-{
-       debugmsg("ex constructor from basic",LOGLEVEL_CONSTRUCT);
-       construct_from_basic(other);
-}
-
-ex::ex(int i)
-{
-       debugmsg("ex constructor from int",LOGLEVEL_CONSTRUCT);
-       construct_from_int(i);
-}
-
-ex::ex(unsigned int i)
-{
-       debugmsg("ex constructor from unsigned int",LOGLEVEL_CONSTRUCT);
-       construct_from_uint(i);
-}
-
-ex::ex(long i)
-{
-       debugmsg("ex constructor from long",LOGLEVEL_CONSTRUCT);
-       construct_from_long(i);
-}
-
-ex::ex(unsigned long i)
-{
-       debugmsg("ex constructor from unsigned long",LOGLEVEL_CONSTRUCT);
-       construct_from_ulong(i);
-}
-
-ex::ex(double const d)
-{
-       debugmsg("ex constructor from double",LOGLEVEL_CONSTRUCT);
-       construct_from_double(d);
-}
-
-ex::ex(const std::string &s, const ex &l)
-{
-       debugmsg("ex constructor from string,lst",LOGLEVEL_CONSTRUCT);
-       construct_from_string_and_lst(s, l);
-}
-
-#endif // ndef INLINE_EX_CONSTRUCTORS
-
-//////////
-// functions overriding virtual functions from bases classes
-//////////
-
-// none
-
-//////////
-// new virtual functions which can be overridden by derived classes
-//////////
-
-// none
+// none (all inlined)
 
 //////////
 // non-virtual functions in this class
@@ -160,7 +49,7 @@ ex::ex(const std::string &s, const ex &l)
 
 // public
 
-/** Swap the contents of two expressions. */
+/** Efficiently swap the contents of two expressions. */
 void ex::swap(ex & other)
 {
        debugmsg("ex swap",LOGLEVEL_MEMBER_FUNCTION);
@@ -170,67 +59,35 @@ void ex::swap(ex & other)
        GINAC_ASSERT(other.bp!=0);
        GINAC_ASSERT(other.bp->flags & status_flags::dynallocated);
        
-       basic * tmpbp=bp;
-       bp=other.bp;
-       other.bp=tmpbp;
-}
-
-/** Output formatted to be useful as ginsh input. */
-void ex::print(std::ostream & os, unsigned upper_precedence) const
-{
-       debugmsg("ex print",LOGLEVEL_PRINT);
-       GINAC_ASSERT(bp!=0);
-       bp->print(os,upper_precedence);
-}
-
-void ex::printraw(std::ostream & os) const
-{
-       debugmsg("ex printraw",LOGLEVEL_PRINT);
-       GINAC_ASSERT(bp!=0);
-       os << "ex(";
-       bp->printraw(os);
-       os << ")";
+       basic * tmpbp = bp;
+       bp = other.bp;
+       other.bp = tmpbp;
 }
 
-void ex::printtree(std::ostream & os, unsigned indent) const
+/** Print expression to stream. The formatting of the output is determined
+ *  by the kind of print_context object that is passed. Possible formattings
+ *  include ginsh-parsable output (the default), tree-like output for
+ *  debugging, and C++ source.
+ *  @see print_context */
+void ex::print(const print_context & c, unsigned level) const
 {
-       debugmsg("ex printtree",LOGLEVEL_PRINT);
+       debugmsg("ex print", LOGLEVEL_PRINT);
        GINAC_ASSERT(bp!=0);
-       // os << "refcount=" << bp->refcount << " ";
-       bp->printtree(os,indent);
+       bp->print(c, level);
 }
 
-/** Print expression as a C++ statement. The output looks like
- *  "<type> <var_name> = <expression>;". The "type" parameter has an effect
- *  on how number literals are printed.
- *
- *  @param os output stream
- *  @param type variable type (one of the csrc_types)
- *  @param var_name variable name to be printed */
-void ex::printcsrc(std::ostream & os, unsigned type, const char *var_name) const
+/** Print expression to stream in a tree-like format suitable for debugging. */
+void ex::printtree(std::ostream & os) const
 {
-       debugmsg("ex print csrc", LOGLEVEL_PRINT);
+       debugmsg("ex printtree", LOGLEVEL_PRINT);
        GINAC_ASSERT(bp!=0);
-       switch (type) {
-               case csrc_types::ctype_float:
-                       os << "float ";
-                       break;
-               case csrc_types::ctype_double:
-                       os << "double ";
-                       break;
-               case csrc_types::ctype_cl_N:
-                       os << "cl_N ";
-                       break;
-       }
-       os << var_name << " = ";
-       bp->printcsrc(os, type, 0);
-       os << ";\n";
+       bp->print(print_tree(os));
 }
 
 /** Little wrapper arount print to be called within a debugger. */
 void ex::dbgprint(void) const
 {
-       debugmsg("ex dbgprint",LOGLEVEL_PRINT);
+       debugmsg("ex dbgprint", LOGLEVEL_PRINT);
        GINAC_ASSERT(bp!=0);
        bp->dbgprint();
 }
@@ -238,73 +95,20 @@ void ex::dbgprint(void) const
 /** Little wrapper arount printtree to be called within a debugger. */
 void ex::dbgprinttree(void) const
 {
-       debugmsg("ex dbgprinttree",LOGLEVEL_PRINT);
+       debugmsg("ex dbgprinttree", LOGLEVEL_PRINT);
        GINAC_ASSERT(bp!=0);
        bp->dbgprinttree();
 }
 
-bool ex::info(unsigned inf) const
-{
-       return bp->info(inf);
-}
-
-unsigned ex::nops() const
-{
-       GINAC_ASSERT(bp!=0);
-       return bp->nops();
-}
-
 ex ex::expand(unsigned options) const
 {
        GINAC_ASSERT(bp!=0);
-       if (bp->flags & status_flags::expanded)
+       if (options == 0 && (bp->flags & status_flags::expanded)) // The "expanded" flag only covers the standard options; someone might want to re-expand with different options
                return *bp;
        else
                return bp->expand(options);
 }
 
-bool ex::has(const ex & other) const
-{
-       GINAC_ASSERT(bp!=0);
-       return bp->has(other);
-}
-
-int ex::degree(const symbol & s) const
-{
-       GINAC_ASSERT(bp!=0);
-       return bp->degree(s);
-}
-
-int ex::ldegree(const symbol & s) const
-{
-       GINAC_ASSERT(bp!=0);
-       return bp->ldegree(s);
-}
-
-ex ex::coeff(const symbol & s, int n) const
-{
-       GINAC_ASSERT(bp!=0);
-       return bp->coeff(s,n);
-}
-
-ex ex::collect(const symbol & s) const
-{
-       GINAC_ASSERT(bp!=0);
-       return bp->collect(s);
-}
-
-ex ex::eval(int level) const
-{
-       GINAC_ASSERT(bp!=0);
-       return bp->eval(level);
-}
-
-ex ex::evalf(int level) const
-{
-       GINAC_ASSERT(bp!=0);
-       return bp->evalf(level);
-}
-
 /** Compute partial derivative of an expression.
  *
  *  @param s  symbol by which the expression is derived
@@ -320,28 +124,30 @@ ex ex::diff(const symbol & s, unsigned nth) const
                return bp->diff(s, nth);
 }
 
-ex ex::subs(const lst & ls, const lst & lr) const
-{
-       GINAC_ASSERT(bp!=0);
-       return bp->subs(ls,lr);
-}
-
-ex ex::subs(const ex & e) const
-{
-       GINAC_ASSERT(bp!=0);
-       return bp->subs(e);
-}
-
-exvector ex::get_indices(void) const
+/** Check whether expression matches a specified pattern. */
+bool ex::match(const ex & pattern) const
 {
-       GINAC_ASSERT(bp!=0);
-       return bp->get_indices();
+       lst repl_lst;
+       return bp->match(pattern, repl_lst);
 }
 
-ex ex::simplify_ncmul(const exvector & v) const
+/** Find all occurrences of a pattern. The found matches are appended to
+ *  the "found" list. If the expression itself matches the pattern, the
+ *  children are not further examined. This function returns true when any
+ *  matches were found. */
+bool ex::find(const ex & pattern, lst & found) const
 {
-       GINAC_ASSERT(bp!=0);
-       return bp->simplify_ncmul(v);
+       if (match(pattern)) {
+               found.append(*this);
+               found.sort();
+               found.unique();
+               return true;
+       }
+       bool any_found = false;
+       for (unsigned i=0; i<nops(); i++)
+               if (op(i).find(pattern, found))
+                       any_found = true;
+       return any_found;
 }
 
 ex ex::operator[](const ex & index) const
@@ -358,14 +164,6 @@ ex ex::operator[](int i) const
        return (*bp)[i];
 }
 
-/** Return operand/member at position i. */
-ex ex::op(int i) const
-{
-       debugmsg("ex op()",LOGLEVEL_MEMBER_FUNCTION);
-       GINAC_ASSERT(bp!=0);
-       return bp->op(i);
-}
-
 /** Return modifyable operand/member at position i. */
 ex & ex::let_op(int i)
 {
@@ -379,7 +177,8 @@ ex & ex::let_op(int i)
 ex ex::lhs(void) const
 {
        debugmsg("ex lhs()",LOGLEVEL_MEMBER_FUNCTION);
-       GINAC_ASSERT(is_ex_of_type(*this,relational));
+       if (!is_ex_of_type(*this,relational))
+               throw std::runtime_error("ex::lhs(): not a relation");
        return (*static_cast<relational *>(bp)).lhs();
 }
 
@@ -387,71 +186,15 @@ ex ex::lhs(void) const
 ex ex::rhs(void) const
 {
        debugmsg("ex rhs()",LOGLEVEL_MEMBER_FUNCTION);
-       GINAC_ASSERT(is_ex_of_type(*this,relational));
+       if (!is_ex_of_type(*this,relational))
+               throw std::runtime_error("ex::rhs(): not a relation");
        return (*static_cast<relational *>(bp)).rhs();
 }
 
-#ifndef INLINE_EX_CONSTRUCTORS
-int ex::compare(const ex & other) const
-{
-       GINAC_ASSERT(bp!=0);
-       GINAC_ASSERT(other.bp!=0);
-       if (bp==other.bp) {
-               // special case: both expression point to same basic, trivially equal
-               return 0; 
-       }
-       return bp->compare(*other.bp);
-}
-#endif // ndef INLINE_EX_CONSTRUCTORS
-
-#ifndef INLINE_EX_CONSTRUCTORS
-bool ex::is_equal(const ex & other) const
-{
-       GINAC_ASSERT(bp!=0);
-       GINAC_ASSERT(other.bp!=0);
-       // if both expression point to same basic they are trivially equal
-       if (bp==other.bp)
-               return true;
-       
-       return bp->is_equal(*other.bp);
-}
-#endif // ndef INLINE_EX_CONSTRUCTORS
-
-unsigned ex::return_type(void) const
-{
-       GINAC_ASSERT(bp!=0);
-       return bp->return_type();
-}
-
-unsigned ex::return_type_tinfo(void) const
-{
-       GINAC_ASSERT(bp!=0);
-       return bp->return_type_tinfo();
-}
-
-unsigned ex::gethash(void) const
-{
-       GINAC_ASSERT(bp!=0);
-       return bp->gethash();
-}
-
-ex ex::exadd(const ex & rh) const
-{
-       return (new add(*this,rh))->setflag(status_flags::dynallocated);
-}
-
-ex ex::exmul(const ex & rh) const
-{
-       return (new mul(*this,rh))->setflag(status_flags::dynallocated);
-}
-
-ex ex::exncmul(const ex & rh) const
-{
-       return (new ncmul(*this,rh))->setflag(status_flags::dynallocated);
-}
-
 // private
 
+/** Make this ex writable (if more than one ex handle the same basic) by 
+ *  unlinking the object and creating an unshared copy of it. */
 void ex::makewriteable()
 {
        debugmsg("ex makewriteable",LOGLEVEL_MEMBER_FUNCTION);
@@ -467,21 +210,20 @@ void ex::makewriteable()
        GINAC_ASSERT(bp->refcount==1);
 }
 
+/** Ctor from basic implementation.
+ *  @see ex::ex(const basic &) */
 void ex::construct_from_basic(const basic & other)
 {
-       if ((other.flags & status_flags::evaluated)==0) {
-               // cf. copy constructor
-               const ex & tmpex = other.eval(1); // evaluate only one (top) level
+       if (!(other.flags & status_flags::evaluated)) {
+               const ex & tmpex(other.eval(1)); // evaluate only one (top) level
                bp = tmpex.bp;
-               GINAC_ASSERT(bp!=0);
                GINAC_ASSERT(bp->flags & status_flags::dynallocated);
                ++bp->refcount;
-               if ((other.flags & status_flags::dynallocated)&&(other.refcount==0)) {
+               if ((other.refcount==0) && (other.flags & status_flags::dynallocated))
                        delete &const_cast<basic &>(other);
-               }
        } else {
                if (other.flags & status_flags::dynallocated) {
-                       // it's on the heap, so just copy bp:
+                       // ok, it is already on the heap, so just copy bp:
                        bp = &const_cast<basic &>(other);
                } else {
                        // create a duplicate on the heap:
@@ -489,7 +231,6 @@ void ex::construct_from_basic(const basic & other)
                        bp->setflag(status_flags::dynallocated);
                }
                GINAC_ASSERT(bp!=0);
-               // bp->clearflag(status_flags::evaluated);
                ++bp->refcount;
        }
        GINAC_ASSERT(bp!=0);
@@ -651,6 +392,4 @@ void ex::construct_from_string_and_lst(const std::string &s, const ex &l)
 // none
 
 
-#ifndef NO_NAMESPACE_GINAC
 } // namespace GiNaC
-#endif // ndef NO_NAMESPACE_GINAC