]> www.ginac.de Git - ginac.git/blobdiff - ginac/add.cpp
* add::coeff(): don't epvector::reserve() more terms than we'll actually
[ginac.git] / ginac / add.cpp
index 74a373283a033687efbb73b55d5693987f2b34be..412bd5a548e65cffab65f1fd3379c7aed137bc03 100644 (file)
@@ -29,9 +29,7 @@
 #include "debugmsg.h"
 #include "utils.h"
 
-#ifndef NO_NAMESPACE_GINAC
 namespace GiNaC {
-#endif // ndef NO_NAMESPACE_GINAC
 
 GINAC_IMPLEMENT_REGISTERED_CLASS(add, expairseq)
 
@@ -39,47 +37,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;
 }
 
-add::~add()
-{
-       debugmsg("add destructor",LOGLEVEL_DESTRUCT);
-       destroy(false);
-}
-
-add::add(const add & other)
-{
-       debugmsg("add copy constructor",LOGLEVEL_CONSTRUCT);
-       copy(other);
-}
-
-const add & add::operator=(const add & other)
-{
-       debugmsg("add operator=",LOGLEVEL_ASSIGNMENT);
-       if (this != &other) {
-               destroy(true);
-               copy(other);
-       }
-       return *this;
-}
-
-// protected
-
-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
@@ -105,23 +70,6 @@ add::add(const exvector & v)
        GINAC_ASSERT(is_canonical());
 }
 
-/*
-add::add(const epvector & v, bool do_not_canonicalize)
-{
-       debugmsg("add constructor from epvector,bool",LOGLEVEL_CONSTRUCT);
-       tinfo_key = TINFO_add;
-       if (do_not_canonicalize) {
-               seq=v;
-#ifdef EXPAIRSEQ_USE_HASHTAB
-               combine_same_terms(); // to build hashtab
-#endif // def EXPAIRSEQ_USE_HASHTAB
-       } else {
-               construct_from_epvector(v);
-       }
-       GINAC_ASSERT(is_canonical());
-}
-*/
-
 add::add(const epvector & v)
 {
        debugmsg("add constructor from epvector",LOGLEVEL_CONSTRUCT);
@@ -155,23 +103,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
@@ -179,113 +111,119 @@ void add::archive(archive_node &n) const
 
 // public
 
-basic * add::duplicate() const
+void add::print(const print_context & c, unsigned level) const
 {
-       debugmsg("add duplicate",LOGLEVEL_DUPLICATE);
-       return new add(*this);
-}
+       debugmsg("add print", LOGLEVEL_PRINT);
 
-void add::print(std::ostream & os, unsigned upper_precedence) 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 << '-';
+       if (is_of_type(c, print_tree)) {
+
+               inherited::print(c, level);
+
+       } else if (is_of_type(c, print_csrc)) {
+
+               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_ex_exactly_of_type(it->rest, numeric) && 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_of_type(c, print_latex))
+                               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_of_type(c, print_tree))
+                               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_of_type(c, print_latex))
+                                       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_of_type(c, print_latex))
+                               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_equal(_ex0())) {
-               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
@@ -314,26 +252,27 @@ 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())) {
+       if (!overall_coeff.is_equal(_ex0()))
                deg = 0;
-       }
+       
        int cur_deg;
        for (epvector::const_iterator cit=seq.begin(); cit!=seq.end(); ++cit) {
-               cur_deg=(*cit).rest.degree(s);
-               if (cur_deg>deg) deg=cur_deg;
+               cur_deg = (*cit).rest.degree(s);
+               if (cur_deg>deg)
+                       deg = cur_deg;
        }
        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())) {
+       if (!overall_coeff.is_equal(_ex0()))
                deg = 0;
-       }
+       
        int cur_deg;
        for (epvector::const_iterator cit=seq.begin(); cit!=seq.end(); ++cit) {
                cur_deg = (*cit).rest.ldegree(s);
@@ -342,31 +281,29 @@ 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
 {
        // simplifications: +(;c) -> c
        //                  +(x;1) -> x
-
+       
        debugmsg("add eval",LOGLEVEL_MEMBER_FUNCTION);
-
-       epvector * evaled_seqp=evalchildren(level);
+       
+       epvector * evaled_seqp = evalchildren(level);
        if (evaled_seqp!=0) {
                // do more evaluation later
                return (new add(evaled_seqp,overall_coeff))->
@@ -376,41 +313,29 @@ ex add::eval(int level) const
 #ifdef DO_GINAC_ASSERT
        for (epvector::const_iterator cit=seq.begin(); cit!=seq.end(); ++cit) {
                GINAC_ASSERT(!is_ex_exactly_of_type((*cit).rest,add));
-               if (is_ex_exactly_of_type((*cit).rest,numeric)) {
+               if (is_ex_exactly_of_type((*cit).rest,numeric))
                        dbgprint();
-               }
                GINAC_ASSERT(!is_ex_exactly_of_type((*cit).rest,numeric));
        }
 #endif // def DO_GINAC_ASSERT
        
        if (flags & status_flags::evaluated) {
                GINAC_ASSERT(seq.size()>0);
-               GINAC_ASSERT((seq.size()>1)||!overall_coeff.is_equal(_ex0()));
+               GINAC_ASSERT(seq.size()>1 || !overall_coeff.is_zero());
                return *this;
        }
        
-       int seq_size=seq.size();
+       int seq_size = seq.size();
        if (seq_size==0) {
                // +(;c) -> c
                return overall_coeff;
-       } else if ((seq_size==1)&&overall_coeff.is_equal(_ex0())) {
+       } else if ((seq_size==1) && overall_coeff.is_equal(_ex0())) {
                // +(x;0) -> x
                return recombine_pair_to_ex(*(seq.begin()));
        }
        return this->hold();
 }
 
-exvector add::get_indices(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();
-       }
-       return (seq.begin())->rest.get_indices();
-}    
-
 ex add::simplify_ncmul(const exvector & v) const
 {
        if (seq.size()==0) {
@@ -468,14 +393,14 @@ 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);
-               ex numfactor=mulref.overall_coeff;
-               // mul * mulcopyp=static_cast<mul *>(mulref.duplicate());
-               mul * mulcopyp=new mul(mulref);
-               mulcopyp->overall_coeff=_ex1();
+               const mul &mulref = ex_to_mul(e);
+               ex numfactor = mulref.overall_coeff;
+               mul *mulcopyp = new mul(mulref);
+               mulcopyp->overall_coeff = _ex1();
                mulcopyp->clearflag(status_flags::evaluated);
                mulcopyp->clearflag(status_flags::hash_calculated);
-               return expair(mulcopyp->setflag(status_flags::dynallocated),numfactor);
+               mulcopyp->setflag(status_flags::dynallocated);
+               return expair(*mulcopyp,numfactor);
        }
        return expair(e,_ex1());
 }
@@ -484,30 +409,28 @@ expair add::combine_ex_with_coeff_to_pair(const ex & e,
                                                                                  const ex & c) const
 {
        GINAC_ASSERT(is_ex_exactly_of_type(c, numeric));
-       ex one = _ex1();
        if (is_ex_exactly_of_type(e, mul)) {
                const mul &mulref = ex_to_mul(e);
                ex numfactor = mulref.overall_coeff;
                mul *mulcopyp = new mul(mulref);
-               mulcopyp->overall_coeff = one;
+               mulcopyp->overall_coeff = _ex1();
                mulcopyp->clearflag(status_flags::evaluated);
                mulcopyp->clearflag(status_flags::hash_calculated);
                mulcopyp->setflag(status_flags::dynallocated);
-               if (are_ex_trivially_equal(c, one)) {
+               if (are_ex_trivially_equal(c, _ex1()))
                        return expair(*mulcopyp, numfactor);
-               } else if (are_ex_trivially_equal(numfactor, one)) {
+               else if (are_ex_trivially_equal(numfactor, _ex1()))
                        return expair(*mulcopyp, c);
-               }
-               return expair(*mulcopyp, ex_to_numeric(numfactor).mul_dyn(ex_to_numeric(c)));
+               else
+                       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, one)) {
-                       return expair(e, one);
-               }
-               return expair(ex_to_numeric(e).mul_dyn(ex_to_numeric(c)), one);
+               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(e, c);
 }
-       
+
 expair add::combine_pair_with_coeff_to_pair(const expair & p,
                                                                                        const ex & c) const
 {
@@ -536,8 +459,11 @@ ex add::expand(unsigned options) const
                return *this;
        
        epvector * vp = expandchildren(options);
-       if (vp==0)
+       if (vp==0) {
+               // the terms have not changed, so it is safe to declare this expanded
+               setflag(status_flags::expanded);
                return *this;
+       }
        
        return (new add(vp,overall_coeff))->setflag(status_flags::expanded | status_flags::dynallocated);
 }
@@ -550,6 +476,4 @@ ex add::expand(unsigned options) const
 
 unsigned add::precedence = 40;
 
-#ifndef NO_NAMESPACE_GINAC
 } // namespace GiNaC
-#endif // ndef NO_NAMESPACE_GINAC