3 * Implementation of GiNaC's sums of expressions. */
6 * GiNaC Copyright (C) 1999-2000 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
32 #ifndef NO_NAMESPACE_GINAC
34 #endif // ndef NO_NAMESPACE_GINAC
36 GINAC_IMPLEMENT_REGISTERED_CLASS(add, expairseq)
39 // default constructor, destructor, copy constructor assignment operator and helpers
46 debugmsg("add default constructor",LOGLEVEL_CONSTRUCT);
47 tinfo_key = TINFO_add;
52 debugmsg("add destructor",LOGLEVEL_DESTRUCT);
56 add::add(const add & other)
58 debugmsg("add copy constructor",LOGLEVEL_CONSTRUCT);
62 const add & add::operator=(const add & other)
64 debugmsg("add operator=",LOGLEVEL_ASSIGNMENT);
74 void add::copy(const add & other)
76 inherited::copy(other);
79 void add::destroy(bool call_parent)
81 if (call_parent) inherited::destroy(call_parent);
90 add::add(const ex & lh, const ex & rh)
92 debugmsg("add constructor from ex,ex",LOGLEVEL_CONSTRUCT);
93 tinfo_key = TINFO_add;
94 overall_coeff = _ex0();
95 construct_from_2_ex(lh,rh);
96 GINAC_ASSERT(is_canonical());
99 add::add(const exvector & v)
101 debugmsg("add constructor from exvector",LOGLEVEL_CONSTRUCT);
102 tinfo_key = TINFO_add;
103 overall_coeff = _ex0();
104 construct_from_exvector(v);
105 GINAC_ASSERT(is_canonical());
109 add::add(const epvector & v, bool do_not_canonicalize)
111 debugmsg("add constructor from epvector,bool",LOGLEVEL_CONSTRUCT);
112 tinfo_key = TINFO_add;
113 if (do_not_canonicalize) {
115 #ifdef EXPAIRSEQ_USE_HASHTAB
116 combine_same_terms(); // to build hashtab
117 #endif // def EXPAIRSEQ_USE_HASHTAB
119 construct_from_epvector(v);
121 GINAC_ASSERT(is_canonical());
125 add::add(const epvector & v)
127 debugmsg("add constructor from epvector",LOGLEVEL_CONSTRUCT);
128 tinfo_key = TINFO_add;
129 overall_coeff = _ex0();
130 construct_from_epvector(v);
131 GINAC_ASSERT(is_canonical());
134 add::add(const epvector & v, const ex & oc)
136 debugmsg("add constructor from epvector,ex",LOGLEVEL_CONSTRUCT);
137 tinfo_key = TINFO_add;
139 construct_from_epvector(v);
140 GINAC_ASSERT(is_canonical());
143 add::add(epvector * vp, const ex & oc)
145 debugmsg("add constructor from epvector *,ex",LOGLEVEL_CONSTRUCT);
146 tinfo_key = TINFO_add;
149 construct_from_epvector(*vp);
151 GINAC_ASSERT(is_canonical());
158 /** Construct object from archive_node. */
159 add::add(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
161 debugmsg("add constructor from archive_node", LOGLEVEL_CONSTRUCT);
164 /** Unarchive the object. */
165 ex add::unarchive(const archive_node &n, const lst &sym_lst)
167 return (new add(n, sym_lst))->setflag(status_flags::dynallocated);
170 /** Archive the object. */
171 void add::archive(archive_node &n) const
173 inherited::archive(n);
177 // functions overriding virtual functions from bases classes
182 basic * add::duplicate() const
184 debugmsg("add duplicate",LOGLEVEL_DUPLICATE);
185 return new add(*this);
188 void add::print(ostream & os, unsigned upper_precedence) const
190 debugmsg("add print",LOGLEVEL_PRINT);
191 if (precedence<=upper_precedence) os << "(";
194 // first print the overall numeric coefficient, if present:
195 if (!overall_coeff.is_zero()) {
199 // then proceed with the remaining factors:
200 for (epvector::const_iterator cit=seq.begin(); cit!=seq.end(); ++cit) {
201 coeff = ex_to_numeric(cit->coeff);
203 if (coeff.csgn()==-1) os << '-'; else os << '+';
205 if (coeff.csgn()==-1) os << '-';
208 if (!coeff.is_equal(_num1()) &&
209 !coeff.is_equal(_num_1())) {
210 if (coeff.is_rational()) {
211 if (coeff.is_negative())
216 if (coeff.csgn()==-1)
217 (-coeff).print(os, precedence);
219 coeff.print(os, precedence);
225 if (precedence<=upper_precedence) os << ")";
228 void add::printraw(ostream & os) const
230 debugmsg("add printraw",LOGLEVEL_PRINT);
233 for (epvector::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
235 (*it).rest.bp->printraw(os);
237 (*it).coeff.bp->printraw(os);
240 os << ",hash=" << hashvalue << ",flags=" << flags;
244 void add::printcsrc(ostream & os, unsigned type, unsigned upper_precedence) const
246 debugmsg("add print csrc", LOGLEVEL_PRINT);
247 if (precedence <= upper_precedence)
250 // Print arguments, separated by "+"
251 epvector::const_iterator it = seq.begin();
252 epvector::const_iterator itend = seq.end();
253 while (it != itend) {
255 // If the coefficient is -1, it is replaced by a single minus sign
256 if (it->coeff.compare(_num1()) == 0) {
257 it->rest.bp->printcsrc(os, type, precedence);
258 } else if (it->coeff.compare(_num_1()) == 0) {
260 it->rest.bp->printcsrc(os, type, precedence);
261 } else if (ex_to_numeric(it->coeff).numer().compare(_num1()) == 0) {
262 it->rest.bp->printcsrc(os, type, precedence);
264 ex_to_numeric(it->coeff).denom().printcsrc(os, type, precedence);
265 } else if (ex_to_numeric(it->coeff).numer().compare(_num_1()) == 0) {
267 it->rest.bp->printcsrc(os, type, precedence);
269 ex_to_numeric(it->coeff).denom().printcsrc(os, type, precedence);
271 it->coeff.bp->printcsrc(os, type, precedence);
273 it->rest.bp->printcsrc(os, type, precedence);
276 // Separator is "+", except if the following expression would have a leading minus sign
278 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)))
282 if (!overall_coeff.is_equal(_ex0())) {
283 if (overall_coeff.info(info_flags::positive)) os << '+';
284 overall_coeff.bp->printcsrc(os,type,precedence);
287 if (precedence <= upper_precedence)
291 bool add::info(unsigned inf) const
294 case info_flags::polynomial:
295 case info_flags::integer_polynomial:
296 case info_flags::cinteger_polynomial:
297 case info_flags::rational_polynomial:
298 case info_flags::crational_polynomial:
299 case info_flags::rational_function: {
300 for (epvector::const_iterator i=seq.begin(); i!=seq.end(); ++i) {
301 if (!(recombine_pair_to_ex(*i).info(inf)))
304 return overall_coeff.info(inf);
306 case info_flags::algebraic: {
307 for (epvector::const_iterator i=seq.begin(); i!=seq.end(); ++i) {
308 if ((recombine_pair_to_ex(*i).info(inf)))
314 return inherited::info(inf);
317 int add::degree(const symbol & s) const
320 if (!overall_coeff.is_equal(_ex0())) {
324 for (epvector::const_iterator cit=seq.begin(); cit!=seq.end(); ++cit) {
325 cur_deg=(*cit).rest.degree(s);
326 if (cur_deg>deg) deg=cur_deg;
331 int add::ldegree(const symbol & s) const
334 if (!overall_coeff.is_equal(_ex0())) {
338 for (epvector::const_iterator cit=seq.begin(); cit!=seq.end(); ++cit) {
339 cur_deg = (*cit).rest.ldegree(s);
340 if (cur_deg<deg) deg=cur_deg;
345 ex add::coeff(const symbol & s, int n) const
348 coeffseq.reserve(seq.size());
350 epvector::const_iterator it=seq.begin();
351 while (it!=seq.end()) {
352 coeffseq.push_back(combine_ex_with_coeff_to_pair((*it).rest.coeff(s,n),
357 return (new add(coeffseq,overall_coeff))->setflag(status_flags::dynallocated);
359 return (new add(coeffseq))->setflag(status_flags::dynallocated);
362 ex add::eval(int level) const
364 // simplifications: +(;c) -> c
367 debugmsg("add eval",LOGLEVEL_MEMBER_FUNCTION);
369 epvector * evaled_seqp=evalchildren(level);
370 if (evaled_seqp!=0) {
371 // do more evaluation later
372 return (new add(evaled_seqp,overall_coeff))->
373 setflag(status_flags::dynallocated);
376 #ifdef DO_GINAC_ASSERT
377 for (epvector::const_iterator cit=seq.begin(); cit!=seq.end(); ++cit) {
378 GINAC_ASSERT(!is_ex_exactly_of_type((*cit).rest,add));
379 if (is_ex_exactly_of_type((*cit).rest,numeric)) {
382 GINAC_ASSERT(!is_ex_exactly_of_type((*cit).rest,numeric));
384 #endif // def DO_GINAC_ASSERT
386 if (flags & status_flags::evaluated) {
387 GINAC_ASSERT(seq.size()>0);
388 GINAC_ASSERT((seq.size()>1)||!overall_coeff.is_equal(_ex0()));
392 int seq_size=seq.size();
395 return overall_coeff;
396 } else if ((seq_size==1)&&overall_coeff.is_equal(_ex0())) {
398 return recombine_pair_to_ex(*(seq.begin()));
403 exvector add::get_indices(void) const
405 // FIXME: all terms in the sum should have the same indices (compatible
406 // tensors) however this is not checked, since there is no function yet
407 // which compares indices (idxvector can be unsorted)
411 return (seq.begin())->rest.get_indices();
414 ex add::simplify_ncmul(const exvector & v) const
417 return inherited::simplify_ncmul(v);
419 return (*seq.begin()).rest.simplify_ncmul(v);
424 /** Implementation of ex::diff() for a sum. It differentiates each term.
426 ex add::derivative(const symbol & s) const
428 // D(a+b+c)=D(a)+D(b)+D(c)
429 return (new add(diffchildren(s)))->setflag(status_flags::dynallocated);
432 int add::compare_same_type(const basic & other) const
434 return inherited::compare_same_type(other);
437 bool add::is_equal_same_type(const basic & other) const
439 return inherited::is_equal_same_type(other);
442 unsigned add::return_type(void) const
445 return return_types::commutative;
447 return (*seq.begin()).rest.return_type();
450 unsigned add::return_type_tinfo(void) const
455 return (*seq.begin()).rest.return_type_tinfo();
458 ex add::thisexpairseq(const epvector & v, const ex & oc) const
460 return (new add(v,oc))->setflag(status_flags::dynallocated);
463 ex add::thisexpairseq(epvector * vp, const ex & oc) const
465 return (new add(vp,oc))->setflag(status_flags::dynallocated);
468 expair add::split_ex_to_pair(const ex & e) const
470 if (is_ex_exactly_of_type(e,mul)) {
471 const mul & mulref=ex_to_mul(e);
472 ex numfactor=mulref.overall_coeff;
473 // mul * mulcopyp=static_cast<mul *>(mulref.duplicate());
474 mul * mulcopyp=new mul(mulref);
475 mulcopyp->overall_coeff=_ex1();
476 mulcopyp->clearflag(status_flags::evaluated);
477 mulcopyp->clearflag(status_flags::hash_calculated);
478 return expair(mulcopyp->setflag(status_flags::dynallocated),numfactor);
480 return expair(e,_ex1());
483 expair add::combine_ex_with_coeff_to_pair(const ex & e,
486 GINAC_ASSERT(is_ex_exactly_of_type(c,numeric));
487 if (is_ex_exactly_of_type(e,mul)) {
488 const mul & mulref=ex_to_mul(e);
489 ex numfactor=mulref.overall_coeff;
490 //mul * mulcopyp=static_cast<mul *>(mulref.duplicate());
491 mul * mulcopyp=new mul(mulref);
492 mulcopyp->overall_coeff=_ex1();
493 mulcopyp->clearflag(status_flags::evaluated);
494 mulcopyp->clearflag(status_flags::hash_calculated);
495 if (are_ex_trivially_equal(c,_ex1())) {
496 return expair(mulcopyp->setflag(status_flags::dynallocated),numfactor);
497 } else if (are_ex_trivially_equal(numfactor,_ex1())) {
498 return expair(mulcopyp->setflag(status_flags::dynallocated),c);
500 return expair(mulcopyp->setflag(status_flags::dynallocated),
501 ex_to_numeric(numfactor).mul_dyn(ex_to_numeric(c)));
502 } else if (is_ex_exactly_of_type(e,numeric)) {
503 if (are_ex_trivially_equal(c,_ex1())) {
504 return expair(e,_ex1());
506 return expair(ex_to_numeric(e).mul_dyn(ex_to_numeric(c)),_ex1());
511 expair add::combine_pair_with_coeff_to_pair(const expair & p,
514 GINAC_ASSERT(is_ex_exactly_of_type(p.coeff,numeric));
515 GINAC_ASSERT(is_ex_exactly_of_type(c,numeric));
517 if (is_ex_exactly_of_type(p.rest,numeric)) {
518 GINAC_ASSERT(ex_to_numeric(p.coeff).is_equal(_num1())); // should be normalized
519 return expair(ex_to_numeric(p.rest).mul_dyn(ex_to_numeric(c)),_ex1());
522 return expair(p.rest,ex_to_numeric(p.coeff).mul_dyn(ex_to_numeric(c)));
525 ex add::recombine_pair_to_ex(const expair & p) const
527 //if (p.coeff.compare(_ex1())==0) {
528 //if (are_ex_trivially_equal(p.coeff,_ex1())) {
529 if (ex_to_numeric(p.coeff).is_equal(_num1())) {
532 return p.rest*p.coeff;
536 ex add::expand(unsigned options) const
538 if (flags & status_flags::expanded)
541 epvector * vp = expandchildren(options);
545 return (new add(vp,overall_coeff))->
546 setflag(status_flags::expanded |
547 status_flags::dynallocated);
551 // new virtual functions which can be overridden by derived classes
557 // non-virtual functions in this class
563 // static member variables
568 unsigned add::precedence = 40;
575 const type_info & typeid_add = typeid(some_add);
577 #ifndef NO_NAMESPACE_GINAC
579 #endif // ndef NO_NAMESPACE_GINAC