]> www.ginac.de Git - ginac.git/blobdiff - ginac/add.cpp
Added a document about the coding conventions used in GiNaC. Corrections,
[ginac.git] / ginac / add.cpp
index 7c496bc8d32189f951a7a684d5153f1440d2c2bb..cb6c8031ec21f7d3f18826f3974c3ba226255f4d 100644 (file)
@@ -3,7 +3,7 @@
  *  Implementation of GiNaC's sums of expressions. */
 
 /*
- *  GiNaC Copyright (C) 1999-2002 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2003 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
 
 #include "add.h"
 #include "mul.h"
-#include "matrix.h"
 #include "archive.h"
+#include "operators.h"
+#include "matrix.h"
 #include "utils.h"
 
 namespace GiNaC {
 
-GINAC_IMPLEMENT_REGISTERED_CLASS(add, expairseq)
+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_python_repr>(&add::do_print_python_repr))
 
 //////////
-// default ctor, dtor, copy ctor, assignment operator and helpers
+// default constructor
 //////////
 
 add::add()
@@ -42,9 +48,6 @@ add::add()
        tinfo_key = TINFO_add;
 }
 
-DEFAULT_COPY(add)
-DEFAULT_DESTROY(add)
-
 //////////
 // other constructors
 //////////
@@ -83,13 +86,12 @@ add::add(const epvector & v, const ex & oc)
        GINAC_ASSERT(is_canonical());
 }
 
-add::add(epvector * vp, const ex & oc)
+add::add(std::auto_ptr<epvector> vp, const ex & oc)
 {
        tinfo_key = TINFO_add;
        GINAC_ASSERT(vp!=0);
        overall_coeff = oc;
        construct_from_epvector(*vp);
-       delete vp;
        GINAC_ASSERT(is_canonical());
 }
 
@@ -105,129 +107,121 @@ DEFAULT_ARCHIVING(add)
 
 // public
 
-void add::print(const print_context & c, unsigned level) const
+void add::print_add(const print_context & c, const char *openbrace, const char *closebrace, const char *mul_sym, unsigned level) const
 {
-       if (is_a<print_tree>(c)) {
+       if (precedence() <= level)
+               c.s << openbrace << '(';
 
-               inherited::print(c, level);
+       numeric coeff;
+       bool first = true;
 
-       } else if (is_a<print_csrc>(c)) {
+       // First print the overall numeric coefficient, if present
+       if (!overall_coeff.is_zero()) {
+               overall_coeff.print(c, 0);
+               first = false;
+       }
 
-               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.is_equal(_ex1)) {
-                               it->rest.print(c, precedence());
-                       } else if (it->coeff.is_equal(_ex_1)) {
-                               c.s << "-";
-                               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 << "/";
-                               ex_to<numeric>(it->coeff).denom().print(c, precedence());
+       // 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) 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 {
-                               it->coeff.print(c, precedence());
-                               c.s << "*";
-                               it->rest.print(c, precedence());
+                               if (coeff.csgn() == -1)
+                                       (-coeff).print(c, precedence());
+                               else
+                                       coeff.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)  // 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 << "+";
-               }
-       
-               if (!overall_coeff.is_zero()) {
-                       if (overall_coeff.info(info_flags::positive))
-                               c.s << '+';
-                       overall_coeff.print(c, precedence());
+                       c.s << mul_sym;
                }
-               
-               if (precedence() <= level)
-                       c.s << ")";
-
-       } else if (is_a<print_python_repr>(c)) {
-
-               c.s << class_name() << '(';
-               op(0).print(c);
-               for (unsigned i=1; i<nops(); ++i) {
-                       c.s << ',';
-                       op(i).print(c);
-               }
-               c.s << ')';
-
-       } else {
+               it->rest.print(c, precedence());
+               ++it;
+       }
 
-               if (precedence() <= level) {
-                       if (is_a<print_latex>(c))
-                               c.s << "{(";
-                       else
-                               c.s << "(";
-               }
+       if (precedence() <= level)
+               c.s << ')' << closebrace;
+}
 
-               numeric coeff;
-               bool first = true;
+void add::do_print(const print_context & c, unsigned level) const
+{
+       print_add(c, "", "", "*", level);
+}
 
-               // 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;
-               }
+void add::do_print_latex(const print_latex & c, unsigned level) const
+{
+       print_add(c, "{", "}", " ", level);
+}
 
-               // 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) 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
-                                       c.s << '*';
-                       }
+void add::do_print_csrc(const print_csrc & c, unsigned level) const
+{
+       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.is_equal(_ex1)) {
+                       it->rest.print(c, precedence());
+               } else if (it->coeff.is_equal(_ex_1)) {
+                       c.s << "-";
+                       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 << "/";
+                       ex_to<numeric>(it->coeff).denom().print(c, precedence());
+               } else {
+                       it->coeff.print(c, precedence());
+                       c.s << "*";
                        it->rest.print(c, precedence());
-                       ++it;
                }
+               
+               // 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 << "+";
+       }
+       
+       if (!overall_coeff.is_zero()) {
+               if (overall_coeff.info(info_flags::positive)
+                || is_a<print_csrc_cl_N>(c) || !overall_coeff.info(info_flags::real))  // sign inside ctor argument
+                       c.s << '+';
+               overall_coeff.print(c, precedence());
+       }
+               
+       if (precedence() <= level)
+               c.s << ")";
+}
 
-               if (precedence() <= level) {
-                       if (is_a<print_latex>(c))
-                               c.s << ")}";
-                       else
-                               c.s << ")";
-               }
+void add::do_print_python_repr(const print_python_repr & c, unsigned level) const
+{
+       c.s << class_name() << '(';
+       op(0).print(c);
+       for (size_t i=1; i<nops(); ++i) {
+               c.s << ',';
+               op(i).print(c);
        }
+       c.s << ')';
 }
 
 bool add::info(unsigned inf) const
@@ -296,7 +290,7 @@ int add::ldegree(const ex & s) const
 
 ex add::coeff(const ex & s, int n) const
 {
-       epvector *coeffseq = new epvector();
+       std::auto_ptr<epvector> coeffseq(new epvector);
 
        // Calculate sum of coefficients in each term
        epvector::const_iterator i = seq.begin(), end = seq.end();
@@ -314,13 +308,13 @@ ex add::coeff(const ex & s, int n) const
  *  x stands for a symbolic variables of type ex and c stands for such
  *  an expression that contain a plain number.
  *  - +(;c) -> c
- *  - +(x;1) -> x
+ *  - +(x;0) -> x
  *
  *  @param level cut-off in recursive evaluation */
 ex add::eval(int level) const
 {
-       epvector *evaled_seqp = evalchildren(level);
-       if (evaled_seqp) {
+       std::auto_ptr<epvector> evaled_seqp = evalchildren(level);
+       if (evaled_seqp.get()) {
                // do more evaluation later
                return (new add(evaled_seqp, overall_coeff))->
                       setflag(status_flags::dynallocated);
@@ -330,7 +324,7 @@ 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_ex_exactly_of_type(i->rest,numeric))
+               if (is_exactly_a<numeric>(i->rest))
                        dbgprint();
                GINAC_ASSERT(!is_exactly_a<numeric>(i->rest));
                ++i;
@@ -356,11 +350,11 @@ ex add::eval(int level) const
        return this->hold();
 }
 
-ex add::evalm(void) const
+ex add::evalm() const
 {
        // Evaluate children first and add up all matrices. Stop if there's one
        // term that is not a matrix.
-       epvector *s = new epvector;
+       std::auto_ptr<epvector> s(new epvector);
        s->reserve(seq.size());
 
        bool all_matrices = true;
@@ -371,7 +365,7 @@ ex add::evalm(void) const
        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 (is_a<matrix>(m)) {
                        if (first_term) {
                                sum = ex_to<matrix>(m);
                                first_term = false;
@@ -382,19 +376,18 @@ ex add::evalm(void) const
                ++it;
        }
 
-       if (all_matrices) {
-               delete s;
+       if (all_matrices)
                return sum + overall_coeff;
-       else
+       else
                return (new add(s, overall_coeff))->setflag(status_flags::dynallocated);
 }
 
-ex add::simplify_ncmul(const exvector & v) const
+ex add::eval_ncmul(const exvector & v) const
 {
        if (seq.empty())
-               return inherited::simplify_ncmul(v);
+               return inherited::eval_ncmul(v);
        else
-               return seq.begin()->rest.simplify_ncmul(v);
+               return seq.begin()->rest.eval_ncmul(v);
 }    
 
 // protected
@@ -403,7 +396,7 @@ ex add::simplify_ncmul(const exvector & v) const
  *  @see ex::diff */
 ex add::derivative(const symbol & y) const
 {
-       epvector *s = new epvector();
+       std::auto_ptr<epvector> s(new epvector);
        s->reserve(seq.size());
        
        // Only differentiate the "rest" parts of the expairs. This is faster
@@ -422,12 +415,7 @@ int add::compare_same_type(const basic & other) const
        return inherited::compare_same_type(other);
 }
 
-bool add::is_equal_same_type(const basic & other) const
-{
-       return inherited::is_equal_same_type(other);
-}
-
-unsigned add::return_type(void) const
+unsigned add::return_type() const
 {
        if (seq.empty())
                return return_types::commutative;
@@ -435,7 +423,7 @@ unsigned add::return_type(void) const
                return seq.begin()->rest.return_type();
 }
    
-unsigned add::return_type_tinfo(void) const
+unsigned add::return_type_tinfo() const
 {
        if (seq.empty())
                return tinfo_key;
@@ -448,14 +436,14 @@ ex add::thisexpairseq(const epvector & v, const ex & oc) const
        return (new add(v,oc))->setflag(status_flags::dynallocated);
 }
 
-ex add::thisexpairseq(epvector * vp, const ex & oc) const
+ex add::thisexpairseq(std::auto_ptr<epvector> vp, const ex & oc) const
 {
        return (new add(vp,oc))->setflag(status_flags::dynallocated);
 }
 
 expair add::split_ex_to_pair(const ex & e) const
 {
-       if (is_ex_exactly_of_type(e,mul)) {
+       if (is_exactly_a<mul>(e)) {
                const mul &mulref(ex_to<mul>(e));
                const ex &numfactor = mulref.overall_coeff;
                mul *mulcopyp = new mul(mulref);
@@ -472,7 +460,7 @@ expair add::combine_ex_with_coeff_to_pair(const ex & e,
                                                                                  const ex & c) const
 {
        GINAC_ASSERT(is_exactly_a<numeric>(c));
-       if (is_ex_exactly_of_type(e, mul)) {
+       if (is_exactly_a<mul>(e)) {
                const mul &mulref(ex_to<mul>(e));
                const ex &numfactor = mulref.overall_coeff;
                mul *mulcopyp = new mul(mulref);
@@ -480,14 +468,14 @@ expair add::combine_ex_with_coeff_to_pair(const ex & e,
                mulcopyp->clearflag(status_flags::evaluated);
                mulcopyp->clearflag(status_flags::hash_calculated);
                mulcopyp->setflag(status_flags::dynallocated);
-               if (are_ex_trivially_equal(c, _ex1))
+               if (c.is_equal(_ex1))
                        return expair(*mulcopyp, numfactor);
-               else if (are_ex_trivially_equal(numfactor, _ex1))
+               else if (numfactor.is_equal(_ex1))
                        return expair(*mulcopyp, 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, _ex1))
+       } else if (is_exactly_a<numeric>(e)) {
+               if (c.is_equal(_ex1))
                        return expair(e, _ex1);
                return expair(ex_to<numeric>(e).mul_dyn(ex_to<numeric>(c)), _ex1);
        }
@@ -500,7 +488,7 @@ expair add::combine_pair_with_coeff_to_pair(const expair & p,
        GINAC_ASSERT(is_exactly_a<numeric>(p.coeff));
        GINAC_ASSERT(is_exactly_a<numeric>(c));
 
-       if (is_ex_exactly_of_type(p.rest,numeric)) {
+       if (is_exactly_a<numeric>(p.rest)) {
                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);
        }
@@ -518,12 +506,12 @@ ex add::recombine_pair_to_ex(const expair & p) const
 
 ex add::expand(unsigned options) const
 {
-       epvector *vp = expandchildren(options);
-       if (vp == NULL) {
+       std::auto_ptr<epvector> vp = expandchildren(options);
+       if (vp.get() == 0) {
                // the terms have not changed, so it is safe to declare this expanded
                return (options == 0) ? setflag(status_flags::expanded) : *this;
        }
-       
+
        return (new add(vp, overall_coeff))->setflag(status_flags::dynallocated | (options == 0 ? status_flags::expanded : 0));
 }