Update copyright statements.
[ginac.git] / ginac / add.cpp
index 6e068af..81a4f2f 100644 (file)
@@ -3,7 +3,7 @@
  *  Implementation of GiNaC's sums of expressions. */
 
 /*
- *  GiNaC Copyright (C) 1999-2004 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2014 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
  *
  *  You should have received a copy of the GNU General Public License
  *  along with this program; if not, write to the Free Software
- *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
 
-#include <iostream>
-#include <stdexcept>
-
 #include "add.h"
 #include "mul.h"
 #include "archive.h"
 #include "operators.h"
 #include "matrix.h"
 #include "utils.h"
+#include "clifford.h"
+#include "ncmul.h"
+#include "compiler.h"
+
+#include <iostream>
+#include <limits>
+#include <stdexcept>
+#include <string>
 
 namespace GiNaC {
 
@@ -36,7 +41,7 @@ GINAC_IMPLEMENT_REGISTERED_CLASS_OPT(add, expairseq,
   print_func<print_context>(&add::do_print).
   print_func<print_latex>(&add::do_print_latex).
   print_func<print_csrc>(&add::do_print_csrc).
-  print_func<print_tree>(&inherited::do_print_tree).
+  print_func<print_tree>(&add::do_print_tree).
   print_func<print_python_repr>(&add::do_print_python_repr))
 
 //////////
@@ -45,7 +50,6 @@ GINAC_IMPLEMENT_REGISTERED_CLASS_OPT(add, expairseq,
 
 add::add()
 {
-       tinfo_key = TINFO_add;
 }
 
 //////////
@@ -56,7 +60,6 @@ add::add()
 
 add::add(const ex & lh, const ex & rh)
 {
-       tinfo_key = TINFO_add;
        overall_coeff = _ex0;
        construct_from_2_ex(lh,rh);
        GINAC_ASSERT(is_canonical());
@@ -64,7 +67,6 @@ add::add(const ex & lh, const ex & rh)
 
 add::add(const exvector & v)
 {
-       tinfo_key = TINFO_add;
        overall_coeff = _ex0;
        construct_from_exvector(v);
        GINAC_ASSERT(is_canonical());
@@ -72,7 +74,6 @@ add::add(const exvector & v)
 
 add::add(const epvector & v)
 {
-       tinfo_key = TINFO_add;
        overall_coeff = _ex0;
        construct_from_epvector(v);
        GINAC_ASSERT(is_canonical());
@@ -80,7 +81,6 @@ add::add(const epvector & v)
 
 add::add(const epvector & v, const ex & oc)
 {
-       tinfo_key = TINFO_add;
        overall_coeff = oc;
        construct_from_epvector(v);
        GINAC_ASSERT(is_canonical());
@@ -88,8 +88,7 @@ add::add(const epvector & v, const ex & oc)
 
 add::add(std::auto_ptr<epvector> vp, const ex & oc)
 {
-       tinfo_key = TINFO_add;
-       GINAC_ASSERT(vp!=0);
+       GINAC_ASSERT(vp.get()!=0);
        overall_coeff = oc;
        construct_from_epvector(*vp);
        GINAC_ASSERT(is_canonical());
@@ -99,7 +98,7 @@ add::add(std::auto_ptr<epvector> vp, const ex & oc)
 // archiving
 //////////
 
-DEFAULT_ARCHIVING(add)
+GINAC_BIND_UNARCHIVER(add);
 
 //////////
 // functions overriding virtual functions from base classes
@@ -131,8 +130,8 @@ void add::print_add(const print_context & c, const char *openbrace, const char *
                        if (coeff.csgn() == -1) c.s << '-';
                        first = false;
                }
-               if (!coeff.is_equal(_num1) &&
-                   !coeff.is_equal(_num_1)) {
+               if (!coeff.is_equal(*_num1_p) &&
+                   !coeff.is_equal(*_num_1_p)) {
                        if (coeff.is_rational()) {
                                if (coeff.is_negative())
                                        (-coeff).print(c);
@@ -169,37 +168,32 @@ void add::do_print_csrc(const print_csrc & c, unsigned level) const
        if (precedence() <= level)
                c.s << "(";
        
-       // Print arguments, separated by "+"
+       // Print arguments, separated by "+" or "-"
        epvector::const_iterator it = seq.begin(), itend = seq.end();
+       char separator = ' ';
        while (it != itend) {
                
-               // If the coefficient is -1, it is replaced by a single minus sign
-               if (it->coeff.is_equal(_ex1)) {
+               // If the coefficient is negative, separator is "-"
+               if (it->coeff.is_equal(_ex_1) || 
+                       ex_to<numeric>(it->coeff).numer().is_equal(*_num_1_p))
+                       separator = '-';
+               c.s << separator;
+               if (it->coeff.is_equal(_ex1) || it->coeff.is_equal(_ex_1)) {
                        it->rest.print(c, precedence());
-               } else if (it->coeff.is_equal(_ex_1)) {
-                       c.s << "-";
+               } else if (ex_to<numeric>(it->coeff).numer().is_equal(*_num1_p) ||
+                                ex_to<numeric>(it->coeff).numer().is_equal(*_num_1_p))
+               {
                        it->rest.print(c, precedence());
-               } else if (ex_to<numeric>(it->coeff).numer().is_equal(_num1)) {
-                       it->rest.print(c, precedence());
-                       c.s << "/";
-                       ex_to<numeric>(it->coeff).denom().print(c, precedence());
-               } else if (ex_to<numeric>(it->coeff).numer().is_equal(_num_1)) {
-                       c.s << "-";
-                       it->rest.print(c, precedence());
-                       c.s << "/";
+                       c.s << '/';
                        ex_to<numeric>(it->coeff).denom().print(c, precedence());
                } else {
                        it->coeff.print(c, precedence());
-                       c.s << "*";
+                       c.s << '*';
                        it->rest.print(c, precedence());
                }
                
-               // Separator is "+", except if the following expression would have a leading minus sign or the sign is sitting in parenthesis (as in a ctor)
                ++it;
-               if (it != itend
-                && (is_a<print_csrc_cl_N>(c) || !it->coeff.info(info_flags::real)  // sign inside ctor arguments
-                 || !(it->coeff.info(info_flags::negative) || (it->coeff.is_equal(_num1) && is_exactly_a<numeric>(it->rest) && it->rest.info(info_flags::negative)))))
-                       c.s << "+";
+               separator = '+';
        }
        
        if (!overall_coeff.is_zero()) {
@@ -231,6 +225,16 @@ bool add::info(unsigned inf) const
                case info_flags::integer_polynomial:
                case info_flags::cinteger_polynomial:
                case info_flags::rational_polynomial:
+               case info_flags::real:
+               case info_flags::rational:
+               case info_flags::integer:
+               case info_flags::crational:
+               case info_flags::cinteger:
+               case info_flags::positive:
+               case info_flags::nonnegative:
+               case info_flags::posint:
+               case info_flags::nonnegint:
+               case info_flags::even:
                case info_flags::crational_polynomial:
                case info_flags::rational_function: {
                        epvector::const_iterator i = seq.begin(), end = seq.end();
@@ -239,6 +243,8 @@ bool add::info(unsigned inf) const
                                        return false;
                                ++i;
                        }
+                       if (overall_coeff.is_zero() && (inf == info_flags::positive || inf == info_flags::posint))
+                               return true;
                        return overall_coeff.info(inf);
                }
                case info_flags::algebraic: {
@@ -254,9 +260,19 @@ bool add::info(unsigned inf) const
        return inherited::info(inf);
 }
 
+bool add::is_polynomial(const ex & var) const
+{
+       for (epvector::const_iterator i=seq.begin(); i!=seq.end(); ++i) {
+               if (!(i->rest).is_polynomial(var)) {
+                       return false;
+               }
+       }
+       return true;
+}
+
 int add::degree(const ex & s) const
 {
-       int deg = INT_MIN;
+       int deg = std::numeric_limits<int>::min();
        if (!overall_coeff.is_zero())
                deg = 0;
        
@@ -273,7 +289,7 @@ int add::degree(const ex & s) const
 
 int add::ldegree(const ex & s) const
 {
-       int deg = INT_MAX;
+       int deg = std::numeric_limits<int>::max();
        if (!overall_coeff.is_zero())
                deg = 0;
        
@@ -291,17 +307,31 @@ int add::ldegree(const ex & s) const
 ex add::coeff(const ex & s, int n) const
 {
        std::auto_ptr<epvector> coeffseq(new epvector);
+       std::auto_ptr<epvector> coeffseq_cliff(new epvector);
+       int rl = clifford_max_label(s);
+       bool do_clifford = (rl != -1);
+       bool nonscalar = false;
 
        // Calculate sum of coefficients in each term
        epvector::const_iterator i = seq.begin(), end = seq.end();
        while (i != end) {
                ex restcoeff = i->rest.coeff(s, n);
-               if (!restcoeff.is_zero())
+               if (!restcoeff.is_zero()) {
+                       if (do_clifford) {
+                               if (clifford_max_label(restcoeff) == -1) {
+                                       coeffseq_cliff->push_back(combine_ex_with_coeff_to_pair(ncmul(restcoeff, dirac_ONE(rl)), i->coeff));
+                               } else {
+                                       coeffseq_cliff->push_back(combine_ex_with_coeff_to_pair(restcoeff, i->coeff));
+                                       nonscalar = true;
+                               }
+                       }
                        coeffseq->push_back(combine_ex_with_coeff_to_pair(restcoeff, i->coeff));
+               }
                ++i;
        }
 
-       return (new add(coeffseq, n==0 ? overall_coeff : _ex0))->setflag(status_flags::dynallocated);
+       return (new add(nonscalar ? coeffseq_cliff : coeffseq,
+                       n==0 ? overall_coeff : _ex0))->setflag(status_flags::dynallocated);
 }
 
 /** Perform automatic term rewriting rules in this class.  In the following
@@ -324,9 +354,6 @@ ex add::eval(int level) const
        epvector::const_iterator i = seq.begin(), end = seq.end();
        while (i != end) {
                GINAC_ASSERT(!is_exactly_a<add>(i->rest));
-               if (is_exactly_a<numeric>(i->rest))
-                       dbgprint();
-               GINAC_ASSERT(!is_exactly_a<numeric>(i->rest));
                ++i;
        }
 #endif // def DO_GINAC_ASSERT
@@ -347,6 +374,33 @@ ex add::eval(int level) const
        } else if (!overall_coeff.is_zero() && seq[0].rest.return_type() != return_types::commutative) {
                throw (std::logic_error("add::eval(): sum of non-commutative objects has non-zero numeric term"));
        }
+       
+       // if any terms in the sum still are purely numeric, then they are more
+       // appropriately collected into the overall coefficient
+       epvector::const_iterator last = seq.end();
+       epvector::const_iterator j = seq.begin();
+       int terms_to_collect = 0;
+       while (j != last) {
+               if (unlikely(is_a<numeric>(j->rest)))
+                       ++terms_to_collect;
+               ++j;
+       }
+       if (terms_to_collect) {
+               std::auto_ptr<epvector> s(new epvector);
+               s->reserve(seq_size - terms_to_collect);
+               numeric oc = *_num1_p;
+               j = seq.begin();
+               while (j != last) {
+                       if (unlikely(is_a<numeric>(j->rest)))
+                               oc = oc.mul(ex_to<numeric>(j->rest)).mul(ex_to<numeric>(j->coeff));
+                       else
+                               s->push_back(*j);
+                       ++j;
+               }
+               return (new add(s, ex_to<numeric>(overall_coeff).add_dyn(oc)))
+                       ->setflag(status_flags::dynallocated);
+       }
+       
        return this->hold();
 }
 
@@ -382,6 +436,68 @@ ex add::evalm() const
                return (new add(s, overall_coeff))->setflag(status_flags::dynallocated);
 }
 
+ex add::conjugate() const
+{
+       exvector *v = 0;
+       for (size_t i=0; i<nops(); ++i) {
+               if (v) {
+                       v->push_back(op(i).conjugate());
+                       continue;
+               }
+               ex term = op(i);
+               ex ccterm = term.conjugate();
+               if (are_ex_trivially_equal(term, ccterm))
+                       continue;
+               v = new exvector;
+               v->reserve(nops());
+               for (size_t j=0; j<i; ++j)
+                       v->push_back(op(j));
+               v->push_back(ccterm);
+       }
+       if (v) {
+               ex result = add(*v);
+               delete v;
+               return result;
+       }
+       return *this;
+}
+
+ex add::real_part() const
+{
+       epvector v;
+       v.reserve(seq.size());
+       for (epvector::const_iterator i=seq.begin(); i!=seq.end(); ++i)
+               if ((i->coeff).info(info_flags::real)) {
+                       ex rp = (i->rest).real_part();
+                       if (!rp.is_zero())
+                               v.push_back(expair(rp, i->coeff));
+               } else {
+                       ex rp=recombine_pair_to_ex(*i).real_part();
+                       if (!rp.is_zero())
+                               v.push_back(split_ex_to_pair(rp));
+               }
+       return (new add(v, overall_coeff.real_part()))
+               -> setflag(status_flags::dynallocated);
+}
+
+ex add::imag_part() const
+{
+       epvector v;
+       v.reserve(seq.size());
+       for (epvector::const_iterator i=seq.begin(); i!=seq.end(); ++i)
+               if ((i->coeff).info(info_flags::real)) {
+                       ex ip = (i->rest).imag_part();
+                       if (!ip.is_zero())
+                               v.push_back(expair(ip, i->coeff));
+               } else {
+                       ex ip=recombine_pair_to_ex(*i).imag_part();
+                       if (!ip.is_zero())
+                               v.push_back(split_ex_to_pair(ip));
+               }
+       return (new add(v, overall_coeff.imag_part()))
+               -> setflag(status_flags::dynallocated);
+}
+
 ex add::eval_ncmul(const exvector & v) const
 {
        if (seq.empty())
@@ -422,21 +538,23 @@ unsigned add::return_type() const
        else
                return seq.begin()->rest.return_type();
 }
-   
-unsigned add::return_type_tinfo() const
+
+return_type_t add::return_type_tinfo() const
 {
        if (seq.empty())
-               return tinfo_key;
+               return make_return_type_t<add>();
        else
                return seq.begin()->rest.return_type_tinfo();
 }
 
-ex add::thisexpairseq(const epvector & v, const ex & oc) const
+// Note: do_index_renaming is ignored because it makes no sense for an add.
+ex add::thisexpairseq(const epvector & v, const ex & oc, bool do_index_renaming) const
 {
        return (new add(v,oc))->setflag(status_flags::dynallocated);
 }
 
-ex add::thisexpairseq(std::auto_ptr<epvector> vp, const ex & oc) const
+// Note: do_index_renaming is ignored because it makes no sense for an add.
+ex add::thisexpairseq(std::auto_ptr<epvector> vp, const ex & oc, bool do_index_renaming) const
 {
        return (new add(vp,oc))->setflag(status_flags::dynallocated);
 }
@@ -489,16 +607,16 @@ expair add::combine_pair_with_coeff_to_pair(const expair & p,
        GINAC_ASSERT(is_exactly_a<numeric>(c));
 
        if (is_exactly_a<numeric>(p.rest)) {
-               GINAC_ASSERT(ex_to<numeric>(p.coeff).is_equal(_num1)); // should be normalized
+               GINAC_ASSERT(ex_to<numeric>(p.coeff).is_equal(*_num1_p)); // 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)));
 }
-       
+
 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_p))
                return p.rest;
        else
                return (new mul(p.rest,p.coeff))->setflag(status_flags::dynallocated);