3 * Implementation of GiNaC's sums of expressions. */
6 * GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
34 GINAC_IMPLEMENT_REGISTERED_CLASS(add, expairseq)
37 // default constructor, destructor, copy constructor assignment operator and helpers
42 debugmsg("add default constructor",LOGLEVEL_CONSTRUCT);
43 tinfo_key = TINFO_add;
55 add::add(const ex & lh, const ex & rh)
57 debugmsg("add constructor from ex,ex",LOGLEVEL_CONSTRUCT);
58 tinfo_key = TINFO_add;
59 overall_coeff = _ex0();
60 construct_from_2_ex(lh,rh);
61 GINAC_ASSERT(is_canonical());
64 add::add(const exvector & v)
66 debugmsg("add constructor from exvector",LOGLEVEL_CONSTRUCT);
67 tinfo_key = TINFO_add;
68 overall_coeff = _ex0();
69 construct_from_exvector(v);
70 GINAC_ASSERT(is_canonical());
73 add::add(const epvector & v)
75 debugmsg("add constructor from epvector",LOGLEVEL_CONSTRUCT);
76 tinfo_key = TINFO_add;
77 overall_coeff = _ex0();
78 construct_from_epvector(v);
79 GINAC_ASSERT(is_canonical());
82 add::add(const epvector & v, const ex & oc)
84 debugmsg("add constructor from epvector,ex",LOGLEVEL_CONSTRUCT);
85 tinfo_key = TINFO_add;
87 construct_from_epvector(v);
88 GINAC_ASSERT(is_canonical());
91 add::add(epvector * vp, const ex & oc)
93 debugmsg("add constructor from epvector *,ex",LOGLEVEL_CONSTRUCT);
94 tinfo_key = TINFO_add;
97 construct_from_epvector(*vp);
99 GINAC_ASSERT(is_canonical());
106 DEFAULT_ARCHIVING(add)
109 // functions overriding virtual functions from bases classes
114 void add::print(const print_context & c, unsigned level) const
116 debugmsg("add print", LOGLEVEL_PRINT);
118 if (is_of_type(c, print_tree)) {
120 inherited::print(c, level);
122 } else if (is_of_type(c, print_csrc)) {
124 if (precedence <= level)
127 // Print arguments, separated by "+"
128 epvector::const_iterator it = seq.begin(), itend = seq.end();
129 while (it != itend) {
131 // If the coefficient is -1, it is replaced by a single minus sign
132 if (it->coeff.compare(_num1()) == 0) {
133 it->rest.bp->print(c, precedence);
134 } else if (it->coeff.compare(_num_1()) == 0) {
136 it->rest.bp->print(c, precedence);
137 } else if (ex_to_numeric(it->coeff).numer().compare(_num1()) == 0) {
138 it->rest.bp->print(c, precedence);
140 ex_to_numeric(it->coeff).denom().print(c, precedence);
141 } else if (ex_to_numeric(it->coeff).numer().compare(_num_1()) == 0) {
143 it->rest.bp->print(c, precedence);
145 ex_to_numeric(it->coeff).denom().print(c, precedence);
147 it->coeff.bp->print(c, precedence);
149 it->rest.bp->print(c, precedence);
152 // Separator is "+", except if the following expression would have a leading minus sign
154 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)))
158 if (!overall_coeff.is_zero()) {
159 if (overall_coeff.info(info_flags::positive))
161 overall_coeff.bp->print(c, precedence);
164 if (precedence <= level)
169 if (precedence <= level)
175 // First print the overall numeric coefficient, if present
176 if (!overall_coeff.is_zero()) {
177 overall_coeff.print(c, precedence);
181 // Then proceed with the remaining factors
182 epvector::const_iterator it = seq.begin(), itend = seq.end();
183 while (it != itend) {
184 coeff = ex_to_numeric(it->coeff);
186 if (coeff.csgn() == -1) c.s << '-'; else c.s << '+';
188 if (coeff.csgn() == -1) c.s << '-';
191 if (!coeff.is_equal(_num1()) &&
192 !coeff.is_equal(_num_1())) {
193 if (coeff.is_rational()) {
194 if (coeff.is_negative())
195 (-coeff).print(c, precedence);
197 coeff.print(c, precedence);
199 if (coeff.csgn() == -1)
200 (-coeff).print(c, precedence);
202 coeff.print(c, precedence);
206 it->rest.print(c, precedence);
210 if (precedence <= level)
215 bool add::info(unsigned inf) const
218 case info_flags::polynomial:
219 case info_flags::integer_polynomial:
220 case info_flags::cinteger_polynomial:
221 case info_flags::rational_polynomial:
222 case info_flags::crational_polynomial:
223 case info_flags::rational_function: {
224 for (epvector::const_iterator i=seq.begin(); i!=seq.end(); ++i) {
225 if (!(recombine_pair_to_ex(*i).info(inf)))
228 return overall_coeff.info(inf);
230 case info_flags::algebraic: {
231 for (epvector::const_iterator i=seq.begin(); i!=seq.end(); ++i) {
232 if ((recombine_pair_to_ex(*i).info(inf)))
238 return inherited::info(inf);
241 int add::degree(const ex & s) const
244 if (!overall_coeff.is_equal(_ex0()))
248 for (epvector::const_iterator cit=seq.begin(); cit!=seq.end(); ++cit) {
249 cur_deg = (*cit).rest.degree(s);
256 int add::ldegree(const ex & s) const
259 if (!overall_coeff.is_equal(_ex0()))
263 for (epvector::const_iterator cit=seq.begin(); cit!=seq.end(); ++cit) {
264 cur_deg = (*cit).rest.ldegree(s);
265 if (cur_deg<deg) deg=cur_deg;
270 ex add::coeff(const ex & s, int n) const
273 coeffseq.reserve(seq.size());
275 epvector::const_iterator it=seq.begin();
276 while (it!=seq.end()) {
277 coeffseq.push_back(combine_ex_with_coeff_to_pair((*it).rest.coeff(s,n),
282 return (new add(coeffseq,overall_coeff))->setflag(status_flags::dynallocated);
284 return (new add(coeffseq))->setflag(status_flags::dynallocated);
287 ex add::eval(int level) const
289 // simplifications: +(;c) -> c
292 debugmsg("add eval",LOGLEVEL_MEMBER_FUNCTION);
294 epvector * evaled_seqp = evalchildren(level);
295 if (evaled_seqp!=0) {
296 // do more evaluation later
297 return (new add(evaled_seqp,overall_coeff))->
298 setflag(status_flags::dynallocated);
301 #ifdef DO_GINAC_ASSERT
302 for (epvector::const_iterator cit=seq.begin(); cit!=seq.end(); ++cit) {
303 GINAC_ASSERT(!is_ex_exactly_of_type((*cit).rest,add));
304 if (is_ex_exactly_of_type((*cit).rest,numeric))
306 GINAC_ASSERT(!is_ex_exactly_of_type((*cit).rest,numeric));
308 #endif // def DO_GINAC_ASSERT
310 if (flags & status_flags::evaluated) {
311 GINAC_ASSERT(seq.size()>0);
312 GINAC_ASSERT(seq.size()>1 || !overall_coeff.is_zero());
316 int seq_size = seq.size();
319 return overall_coeff;
320 } else if ((seq_size==1) && overall_coeff.is_equal(_ex0())) {
322 return recombine_pair_to_ex(*(seq.begin()));
327 ex add::simplify_ncmul(const exvector & v) const
330 return inherited::simplify_ncmul(v);
332 return (*seq.begin()).rest.simplify_ncmul(v);
337 /** Implementation of ex::diff() for a sum. It differentiates each term.
339 ex add::derivative(const symbol & s) const
341 // D(a+b+c)=D(a)+D(b)+D(c)
342 return (new add(diffchildren(s)))->setflag(status_flags::dynallocated);
345 int add::compare_same_type(const basic & other) const
347 return inherited::compare_same_type(other);
350 bool add::is_equal_same_type(const basic & other) const
352 return inherited::is_equal_same_type(other);
355 unsigned add::return_type(void) const
358 return return_types::commutative;
360 return (*seq.begin()).rest.return_type();
363 unsigned add::return_type_tinfo(void) const
368 return (*seq.begin()).rest.return_type_tinfo();
371 ex add::thisexpairseq(const epvector & v, const ex & oc) const
373 return (new add(v,oc))->setflag(status_flags::dynallocated);
376 ex add::thisexpairseq(epvector * vp, const ex & oc) const
378 return (new add(vp,oc))->setflag(status_flags::dynallocated);
381 expair add::split_ex_to_pair(const ex & e) const
383 if (is_ex_exactly_of_type(e,mul)) {
384 const mul &mulref = ex_to_mul(e);
385 ex numfactor = mulref.overall_coeff;
386 mul *mulcopyp = new mul(mulref);
387 mulcopyp->overall_coeff = _ex1();
388 mulcopyp->clearflag(status_flags::evaluated);
389 mulcopyp->clearflag(status_flags::hash_calculated);
390 mulcopyp->setflag(status_flags::dynallocated);
391 return expair(*mulcopyp,numfactor);
393 return expair(e,_ex1());
396 expair add::combine_ex_with_coeff_to_pair(const ex & e,
399 GINAC_ASSERT(is_ex_exactly_of_type(c, numeric));
400 if (is_ex_exactly_of_type(e, mul)) {
401 const mul &mulref = ex_to_mul(e);
402 ex numfactor = mulref.overall_coeff;
403 mul *mulcopyp = new mul(mulref);
404 mulcopyp->overall_coeff = _ex1();
405 mulcopyp->clearflag(status_flags::evaluated);
406 mulcopyp->clearflag(status_flags::hash_calculated);
407 mulcopyp->setflag(status_flags::dynallocated);
408 if (are_ex_trivially_equal(c, _ex1()))
409 return expair(*mulcopyp, numfactor);
410 else if (are_ex_trivially_equal(numfactor, _ex1()))
411 return expair(*mulcopyp, c);
413 return expair(*mulcopyp, ex_to_numeric(numfactor).mul_dyn(ex_to_numeric(c)));
414 } else if (is_ex_exactly_of_type(e, numeric)) {
415 if (are_ex_trivially_equal(c, _ex1()))
416 return expair(e, _ex1());
417 return expair(ex_to_numeric(e).mul_dyn(ex_to_numeric(c)), _ex1());
422 expair add::combine_pair_with_coeff_to_pair(const expair & p,
425 GINAC_ASSERT(is_ex_exactly_of_type(p.coeff,numeric));
426 GINAC_ASSERT(is_ex_exactly_of_type(c,numeric));
428 if (is_ex_exactly_of_type(p.rest,numeric)) {
429 GINAC_ASSERT(ex_to_numeric(p.coeff).is_equal(_num1())); // should be normalized
430 return expair(ex_to_numeric(p.rest).mul_dyn(ex_to_numeric(c)),_ex1());
433 return expair(p.rest,ex_to_numeric(p.coeff).mul_dyn(ex_to_numeric(c)));
436 ex add::recombine_pair_to_ex(const expair & p) const
438 if (ex_to_numeric(p.coeff).is_equal(_num1()))
441 return p.rest*p.coeff;
444 ex add::expand(unsigned options) const
446 if (flags & status_flags::expanded)
449 epvector * vp = expandchildren(options);
451 // the terms have not changed, so it is safe to declare this expanded
452 setflag(status_flags::expanded);
456 return (new add(vp,overall_coeff))->setflag(status_flags::expanded | status_flags::dynallocated);
460 // static member variables
465 unsigned add::precedence = 40;