]> www.ginac.de Git - ginac.git/blobdiff - ginac/add.cpp
- The default implementations of evalf(), diff(), normal() and expand() use
[ginac.git] / ginac / add.cpp
index 0c22465a10021e54828d149bdda3502ee1e3e25b..31e2f8fc5b3e540dd80667bed303cbfd8c8f3444 100644 (file)
@@ -25,6 +25,7 @@
 
 #include "add.h"
 #include "mul.h"
+#include "matrix.h"
 #include "archive.h"
 #include "debugmsg.h"
 #include "utils.h"
@@ -37,26 +38,14 @@ GINAC_IMPLEMENT_REGISTERED_CLASS(add, expairseq)
 // default constructor, destructor, copy constructor assignment operator and helpers
 //////////
 
-// public
-
 add::add()
 {
        debugmsg("add default constructor",LOGLEVEL_CONSTRUCT);
        tinfo_key = TINFO_add;
 }
 
-// protected
-
-/** For use by copy ctor and assignment operator. */
-void add::copy(const add & other)
-{
-       inherited::copy(other);
-}
-
-void add::destroy(bool call_parent)
-{
-       if (call_parent) inherited::destroy(call_parent);
-}
+DEFAULT_COPY(add)
+DEFAULT_DESTROY(add)
 
 //////////
 // other constructors
@@ -115,23 +104,7 @@ add::add(epvector * vp, const ex & oc)
 // archiving
 //////////
 
-/** Construct object from archive_node. */
-add::add(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
-{
-       debugmsg("add constructor from archive_node", LOGLEVEL_CONSTRUCT);
-}
-
-/** Unarchive the object. */
-ex add::unarchive(const archive_node &n, const lst &sym_lst)
-{
-       return (new add(n, sym_lst))->setflag(status_flags::dynallocated);
-}
-
-/** Archive the object. */
-void add::archive(archive_node &n) const
-{
-       inherited::archive(n);
-}
+DEFAULT_ARCHIVING(add)
 
 //////////
 // functions overriding virtual functions from bases classes
@@ -139,107 +112,119 @@ void add::archive(archive_node &n) const
 
 // public
 
-void add::print(std::ostream & os, unsigned upper_precedence) const
+void add::print(const print_context & c, unsigned level) const
 {
-       debugmsg("add print",LOGLEVEL_PRINT);
-       if (precedence<=upper_precedence) os << "(";
-       numeric coeff;
-       bool first = true;
-       // first print the overall numeric coefficient, if present:
-       if (!overall_coeff.is_zero()) {
-               os << overall_coeff;
-               first = false;
-       }
-       // then proceed with the remaining factors:
-       for (epvector::const_iterator cit=seq.begin(); cit!=seq.end(); ++cit) {
-               coeff = ex_to_numeric(cit->coeff);
-               if (!first) {
-                       if (coeff.csgn()==-1) os << '-'; else os << '+';
-               } else {
-                       if (coeff.csgn()==-1) os << '-';
+       debugmsg("add print", LOGLEVEL_PRINT);
+
+       if (is_a<print_tree>(c)) {
+
+               inherited::print(c, level);
+
+       } else if (is_a<print_csrc>(c)) {
+
+               if (precedence() <= level)
+                       c.s << "(";
+       
+               // Print arguments, separated by "+"
+               epvector::const_iterator it = seq.begin(), itend = seq.end();
+               while (it != itend) {
+               
+                       // If the coefficient is -1, it is replaced by a single minus sign
+                       if (it->coeff.compare(_num1()) == 0) {
+                               it->rest.bp->print(c, precedence());
+                       } else if (it->coeff.compare(_num_1()) == 0) {
+                               c.s << "-";
+                               it->rest.bp->print(c, precedence());
+                       } else if (ex_to<numeric>(it->coeff).numer().compare(_num1()) == 0) {
+                               it->rest.bp->print(c, precedence());
+                               c.s << "/";
+                               ex_to<numeric>(it->coeff).denom().print(c, precedence());
+                       } else if (ex_to<numeric>(it->coeff).numer().compare(_num_1()) == 0) {
+                               c.s << "-";
+                               it->rest.bp->print(c, precedence());
+                               c.s << "/";
+                               ex_to<numeric>(it->coeff).denom().print(c, precedence());
+                       } else {
+                               it->coeff.bp->print(c, precedence());
+                               c.s << "*";
+                               it->rest.bp->print(c, precedence());
+                       }
+               
+                       // Separator is "+", except if the following expression would have a leading minus sign
+                       it++;
+                       if (it != itend && !(it->coeff.compare(_num0()) < 0 || (it->coeff.compare(_num1()) == 0 && is_exactly_a<numeric>(it->rest) && it->rest.compare(_num0()) < 0)))
+                               c.s << "+";
+               }
+       
+               if (!overall_coeff.is_zero()) {
+                       if (overall_coeff.info(info_flags::positive))
+                               c.s << '+';
+                       overall_coeff.bp->print(c, precedence());
+               }
+       
+               if (precedence() <= level)
+                       c.s << ")";
+
+       } else {
+
+               if (precedence() <= level) {
+                       if (is_a<print_latex>(c))
+                               c.s << "{(";
+                       else
+                               c.s << "(";
+               }
+
+               numeric coeff;
+               bool first = true;
+
+               // First print the overall numeric coefficient, if present
+               if (!overall_coeff.is_zero()) {
+                       if (!is_a<print_tree>(c))
+                               overall_coeff.print(c, 0);
+                       else
+                               overall_coeff.print(c, precedence());
                        first = false;
                }
-               if (!coeff.is_equal(_num1()) &&
-                   !coeff.is_equal(_num_1())) {
-                       if (coeff.is_rational()) {
-                               if (coeff.is_negative())
-                                       os << -coeff;
-                               else
-                                       os << coeff;
+
+               // Then proceed with the remaining factors
+               epvector::const_iterator it = seq.begin(), itend = seq.end();
+               while (it != itend) {
+                       coeff = ex_to<numeric>(it->coeff);
+                       if (!first) {
+                               if (coeff.csgn() == -1) c.s << '-'; else c.s << '+';
                        } else {
-                               if (coeff.csgn()==-1)
-                                       (-coeff).print(os, precedence);
+                               if (coeff.csgn() == -1) c.s << '-';
+                               first = false;
+                       }
+                       if (!coeff.is_equal(_num1()) &&
+                           !coeff.is_equal(_num_1())) {
+                               if (coeff.is_rational()) {
+                                       if (coeff.is_negative())
+                                               (-coeff).print(c);
+                                       else
+                                               coeff.print(c);
+                               } else {
+                                       if (coeff.csgn() == -1)
+                                               (-coeff).print(c, precedence());
+                                       else
+                                               coeff.print(c, precedence());
+                               }
+                               if (is_a<print_latex>(c))
+                                       c.s << ' ';
                                else
-                                       coeff.print(os, precedence);
+                                       c.s << '*';
                        }
-                       os << '*';
+                       it->rest.print(c, precedence());
+                       it++;
                }
-               cit->rest.print(os, precedence);
-       }
-       if (precedence<=upper_precedence) os << ")";
-}
-
-void add::printraw(std::ostream & os) const
-{
-       debugmsg("add printraw",LOGLEVEL_PRINT);
-
-       os << "+(";
-       for (epvector::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
-               os << "(";
-               (*it).rest.bp->printraw(os);
-               os << ",";
-               (*it).coeff.bp->printraw(os);        
-               os << "),";
-       }
-       os << ",hash=" << hashvalue << ",flags=" << flags;
-       os << ")";
-}
 
-void add::printcsrc(std::ostream & os, unsigned type, unsigned upper_precedence) const
-{
-       debugmsg("add print csrc", LOGLEVEL_PRINT);
-       if (precedence <= upper_precedence)
-               os << "(";
-       
-       // Print arguments, separated by "+"
-       epvector::const_iterator it = seq.begin();
-       epvector::const_iterator itend = seq.end();
-       while (it != itend) {
-               
-               // If the coefficient is -1, it is replaced by a single minus sign
-               if (it->coeff.compare(_num1()) == 0) {
-                       it->rest.bp->printcsrc(os, type, precedence);
-               } else if (it->coeff.compare(_num_1()) == 0) {
-                       os << "-";
-                       it->rest.bp->printcsrc(os, type, precedence);
-               } else if (ex_to_numeric(it->coeff).numer().compare(_num1()) == 0) {
-                       it->rest.bp->printcsrc(os, type, precedence);
-                       os << "/";
-                       ex_to_numeric(it->coeff).denom().printcsrc(os, type, precedence);
-               } else if (ex_to_numeric(it->coeff).numer().compare(_num_1()) == 0) {
-                       os << "-";
-                       it->rest.bp->printcsrc(os, type, precedence);
-                       os << "/";
-                       ex_to_numeric(it->coeff).denom().printcsrc(os, type, precedence);
-               } else {
-                       it->coeff.bp->printcsrc(os, type, precedence);
-                       os << "*";
-                       it->rest.bp->printcsrc(os, type, precedence);
+               if (precedence() <= level) {
+                       if (is_a<print_latex>(c))
+                               c.s << ")}";
+                       else
+                               c.s << ")";
                }
-               
-               // Separator is "+", except if the following expression would have a leading minus sign
-               it++;
-               if (it != itend && !(it->coeff.compare(_num0()) < 0 || (it->coeff.compare(_num1()) == 0 && is_ex_exactly_of_type(it->rest, numeric) && it->rest.compare(_num0()) < 0)))
-                       os << "+";
-       }
-       
-       if (!overall_coeff.is_zero()) {
-               if (overall_coeff.info(info_flags::positive)) os << '+';
-               overall_coeff.bp->printcsrc(os,type,precedence);
        }
-       
-       if (precedence <= upper_precedence)
-               os << ")";
 }
 
 bool add::info(unsigned inf) const
@@ -268,7 +253,7 @@ bool add::info(unsigned inf) const
        return inherited::info(inf);
 }
 
-int add::degree(const symbol & s) const
+int add::degree(const ex & s) const
 {
        int deg = INT_MIN;
        if (!overall_coeff.is_equal(_ex0()))
@@ -283,7 +268,7 @@ int add::degree(const symbol & s) const
        return deg;
 }
 
-int add::ldegree(const symbol & s) const
+int add::ldegree(const ex & s) const
 {
        int deg = INT_MAX;
        if (!overall_coeff.is_equal(_ex0()))
@@ -297,21 +282,19 @@ int add::ldegree(const symbol & s) const
        return deg;
 }
 
-ex add::coeff(const symbol & s, int n) const
+ex add::coeff(const ex & s, int n) const
 {
        epvector coeffseq;
-       coeffseq.reserve(seq.size());
-
+       
        epvector::const_iterator it=seq.begin();
        while (it!=seq.end()) {
-               coeffseq.push_back(combine_ex_with_coeff_to_pair((*it).rest.coeff(s,n),
-                                                                (*it).coeff));
+               ex restcoeff = it->rest.coeff(s,n);
+               if (!restcoeff.is_zero())
+                       coeffseq.push_back(combine_ex_with_coeff_to_pair(restcoeff,it->coeff));
                ++it;
        }
-       if (n==0) {
-               return (new add(coeffseq,overall_coeff))->setflag(status_flags::dynallocated);
-       }
-       return (new add(coeffseq))->setflag(status_flags::dynallocated);
+       
+       return (new add(coeffseq, n==0 ? overall_coeff : default_overall_coeff()))->setflag(status_flags::dynallocated);
 }
 
 ex add::eval(int level) const
@@ -354,16 +337,37 @@ ex add::eval(int level) const
        return this->hold();
 }
 
-exvector add::get_indices(void) const
+ex add::evalm(void) const
 {
-       // FIXME: all terms in the sum should have the same indices (compatible
-       // tensors) however this is not checked, since there is no function yet
-       // which compares indices (idxvector can be unsorted)
-       if (seq.size()==0) {
-               return exvector();
+       // Evaluate children first and add up all matrices. Stop if there's one
+       // term that is not a matrix.
+       epvector *s = new epvector;
+       s->reserve(seq.size());
+
+       bool all_matrices = true;
+       bool first_term = true;
+       matrix sum;
+
+       epvector::const_iterator it = seq.begin(), itend = seq.end();
+       while (it != itend) {
+               const ex &m = recombine_pair_to_ex(*it).evalm();
+               s->push_back(split_ex_to_pair(m));
+               if (is_ex_of_type(m, matrix)) {
+                       if (first_term) {
+                               sum = ex_to<matrix>(m);
+                               first_term = false;
+                       } else
+                               sum = sum.add(ex_to<matrix>(m));
+               } else
+                       all_matrices = false;
+               it++;
        }
-       return (seq.begin())->rest.get_indices();
-}    
+
+       if (all_matrices)
+               return sum + overall_coeff;
+       else
+               return (new add(s, overall_coeff))->setflag(status_flags::dynallocated);
+}
 
 ex add::simplify_ncmul(const exvector & v) const
 {
@@ -377,10 +381,19 @@ ex add::simplify_ncmul(const exvector & v) const
 
 /** Implementation of ex::diff() for a sum. It differentiates each term.
  *  @see ex::diff */
-ex add::derivative(const symbol & s) const
+ex add::derivative(const symbol & y) const
 {
-       // D(a+b+c)=D(a)+D(b)+D(c)
-       return (new add(diffchildren(s)))->setflag(status_flags::dynallocated);
+       epvector *s = new epvector();
+       s->reserve(seq.size());
+       
+       // Only differentiate the "rest" parts of the expairs. This is faster
+       // than the default implementation in basic::derivative() although
+       // if performs the same function (differentiate each term).
+       for (epvector::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
+               s->push_back(combine_ex_with_coeff_to_pair((*it).rest.diff(y),
+                                                          (*it).coeff));
+       }
+       return (new add(s, _ex0()))->setflag(status_flags::dynallocated);
 }
 
 int add::compare_same_type(const basic & other) const
@@ -422,7 +435,7 @@ ex add::thisexpairseq(epvector * vp, const ex & oc) const
 expair add::split_ex_to_pair(const ex & e) const
 {
        if (is_ex_exactly_of_type(e,mul)) {
-               const mul &mulref = ex_to_mul(e);
+               const mul &mulref(ex_to<mul>(e));
                ex numfactor = mulref.overall_coeff;
                mul *mulcopyp = new mul(mulref);
                mulcopyp->overall_coeff = _ex1();
@@ -439,7 +452,7 @@ expair add::combine_ex_with_coeff_to_pair(const ex & e,
 {
        GINAC_ASSERT(is_ex_exactly_of_type(c, numeric));
        if (is_ex_exactly_of_type(e, mul)) {
-               const mul &mulref = ex_to_mul(e);
+               const mul &mulref(ex_to<mul>(e));
                ex numfactor = mulref.overall_coeff;
                mul *mulcopyp = new mul(mulref);
                mulcopyp->overall_coeff = _ex1();
@@ -451,11 +464,11 @@ expair add::combine_ex_with_coeff_to_pair(const ex & e,
                else if (are_ex_trivially_equal(numfactor, _ex1()))
                        return expair(*mulcopyp, c);
                else
-                       return expair(*mulcopyp, ex_to_numeric(numfactor).mul_dyn(ex_to_numeric(c)));
+                       return expair(*mulcopyp, ex_to<numeric>(numfactor).mul_dyn(ex_to<numeric>(c)));
        } else if (is_ex_exactly_of_type(e, numeric)) {
                if (are_ex_trivially_equal(c, _ex1()))
                        return expair(e, _ex1());
-               return expair(ex_to_numeric(e).mul_dyn(ex_to_numeric(c)), _ex1());
+               return expair(ex_to<numeric>(e).mul_dyn(ex_to<numeric>(c)), _ex1());
        }
        return expair(e, c);
 }
@@ -467,16 +480,16 @@ expair add::combine_pair_with_coeff_to_pair(const expair & p,
        GINAC_ASSERT(is_ex_exactly_of_type(c,numeric));
 
        if (is_ex_exactly_of_type(p.rest,numeric)) {
-               GINAC_ASSERT(ex_to_numeric(p.coeff).is_equal(_num1())); // should be normalized
-               return expair(ex_to_numeric(p.rest).mul_dyn(ex_to_numeric(c)),_ex1());
+               GINAC_ASSERT(ex_to<numeric>(p.coeff).is_equal(_num1())); // should be normalized
+               return expair(ex_to<numeric>(p.rest).mul_dyn(ex_to<numeric>(c)),_ex1());
        }
 
-       return expair(p.rest,ex_to_numeric(p.coeff).mul_dyn(ex_to_numeric(c)));
+       return expair(p.rest,ex_to<numeric>(p.coeff).mul_dyn(ex_to<numeric>(c)));
 }
        
 ex add::recombine_pair_to_ex(const expair & p) const
 {
-       if (ex_to_numeric(p.coeff).is_equal(_num1()))
+       if (ex_to<numeric>(p.coeff).is_equal(_num1()))
                return p.rest;
        else
                return p.rest*p.coeff;
@@ -488,21 +501,12 @@ ex add::expand(unsigned options) const
                return *this;
        
        epvector * vp = expandchildren(options);
-       if (vp==0) {
+       if (vp == NULL) {
                // the terms have not changed, so it is safe to declare this expanded
-               setflag(status_flags::expanded);
-               return *this;
+               return this->setflag(status_flags::expanded);
        }
        
        return (new add(vp,overall_coeff))->setflag(status_flags::expanded | status_flags::dynallocated);
 }
 
-//////////
-// static member variables
-//////////
-
-// protected
-
-unsigned add::precedence = 40;
-
 } // namespace GiNaC