- introduced info_flag::algebraic.
[ginac.git] / ginac / power.cpp
1 /** @file power.cpp
2  *
3  *  Implementation of GiNaC's symbolic exponentiation (basis^exponent). */
4
5 /*
6  *  GiNaC Copyright (C) 1999-2000 Johannes Gutenberg University Mainz, Germany
7  *
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.
12  *
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.
17  *
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
21  */
22
23 #include <vector>
24 #include <iostream>
25 #include <stdexcept>
26
27 #include "power.h"
28 #include "expairseq.h"
29 #include "add.h"
30 #include "mul.h"
31 #include "numeric.h"
32 #include "inifcns.h"
33 #include "relational.h"
34 #include "symbol.h"
35 #include "archive.h"
36 #include "debugmsg.h"
37 #include "utils.h"
38
39 #ifndef NO_NAMESPACE_GINAC
40 namespace GiNaC {
41 #endif // ndef NO_NAMESPACE_GINAC
42
43 GINAC_IMPLEMENT_REGISTERED_CLASS(power, basic)
44
45 typedef vector<int> intvector;
46
47 //////////
48 // default constructor, destructor, copy constructor assignment operator and helpers
49 //////////
50
51 // public
52
53 power::power() : basic(TINFO_power)
54 {
55     debugmsg("power default constructor",LOGLEVEL_CONSTRUCT);
56 }
57
58 power::~power()
59 {
60     debugmsg("power destructor",LOGLEVEL_DESTRUCT);
61     destroy(0);
62 }
63
64 power::power(const power & other)
65 {
66     debugmsg("power copy constructor",LOGLEVEL_CONSTRUCT);
67     copy(other);
68 }
69
70 const power & power::operator=(const power & other)
71 {
72     debugmsg("power operator=",LOGLEVEL_ASSIGNMENT);
73     if (this != &other) {
74         destroy(1);
75         copy(other);
76     }
77     return *this;
78 }
79
80 // protected
81
82 void power::copy(const power & other)
83 {
84     inherited::copy(other);
85     basis=other.basis;
86     exponent=other.exponent;
87 }
88
89 void power::destroy(bool call_parent)
90 {
91     if (call_parent) inherited::destroy(call_parent);
92 }
93
94 //////////
95 // other constructors
96 //////////
97
98 // public
99
100 power::power(const ex & lh, const ex & rh) : basic(TINFO_power), basis(lh), exponent(rh)
101 {
102     debugmsg("power constructor from ex,ex",LOGLEVEL_CONSTRUCT);
103     GINAC_ASSERT(basis.return_type()==return_types::commutative);
104 }
105
106 power::power(const ex & lh, const numeric & rh) : basic(TINFO_power), basis(lh), exponent(rh)
107 {
108     debugmsg("power constructor from ex,numeric",LOGLEVEL_CONSTRUCT);
109     GINAC_ASSERT(basis.return_type()==return_types::commutative);
110 }
111
112 //////////
113 // archiving
114 //////////
115
116 /** Construct object from archive_node. */
117 power::power(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
118 {
119     debugmsg("power constructor from archive_node", LOGLEVEL_CONSTRUCT);
120     n.find_ex("basis", basis, sym_lst);
121     n.find_ex("exponent", exponent, sym_lst);
122 }
123
124 /** Unarchive the object. */
125 ex power::unarchive(const archive_node &n, const lst &sym_lst)
126 {
127     return (new power(n, sym_lst))->setflag(status_flags::dynallocated);
128 }
129
130 /** Archive the object. */
131 void power::archive(archive_node &n) const
132 {
133     inherited::archive(n);
134     n.add_ex("basis", basis);
135     n.add_ex("exponent", exponent);
136 }
137
138 //////////
139 // functions overriding virtual functions from bases classes
140 //////////
141
142 // public
143
144 basic * power::duplicate() const
145 {
146     debugmsg("power duplicate",LOGLEVEL_DUPLICATE);
147     return new power(*this);
148 }
149
150 void power::print(ostream & os, unsigned upper_precedence) const
151 {
152     debugmsg("power print",LOGLEVEL_PRINT);
153     if (exponent.is_equal(_ex1_2())) {
154         os << "sqrt(" << basis << ")";
155     } else {
156         if (precedence<=upper_precedence) os << "(";
157         basis.print(os,precedence);
158         os << "^";
159         exponent.print(os,precedence);
160         if (precedence<=upper_precedence) os << ")";
161     }
162 }
163
164 void power::printraw(ostream & os) const
165 {
166     debugmsg("power printraw",LOGLEVEL_PRINT);
167
168     os << "power(";
169     basis.printraw(os);
170     os << ",";
171     exponent.printraw(os);
172     os << ",hash=" << hashvalue << ",flags=" << flags << ")";
173 }
174
175 void power::printtree(ostream & os, unsigned indent) const
176 {
177     debugmsg("power printtree",LOGLEVEL_PRINT);
178
179     os << string(indent,' ') << "power: "
180        << "hash=" << hashvalue << " (0x" << hex << hashvalue << dec << ")"
181        << ", flags=" << flags << endl;
182     basis.printtree(os,indent+delta_indent);
183     exponent.printtree(os,indent+delta_indent);
184 }
185
186 static void print_sym_pow(ostream & os, unsigned type, const symbol &x, int exp)
187 {
188     // Optimal output of integer powers of symbols to aid compiler CSE
189     if (exp == 1) {
190         x.printcsrc(os, type, 0);
191     } else if (exp == 2) {
192         x.printcsrc(os, type, 0);
193         os << "*";
194         x.printcsrc(os, type, 0);
195     } else if (exp & 1) {
196         x.printcsrc(os, 0);
197         os << "*";
198         print_sym_pow(os, type, x, exp-1);
199     } else {
200         os << "(";
201         print_sym_pow(os, type, x, exp >> 1);
202         os << ")*(";
203         print_sym_pow(os, type, x, exp >> 1);
204         os << ")";
205     }
206 }
207
208 void power::printcsrc(ostream & os, unsigned type, unsigned upper_precedence) const
209 {
210     debugmsg("power print csrc", LOGLEVEL_PRINT);
211     
212     // Integer powers of symbols are printed in a special, optimized way
213     if (exponent.info(info_flags::integer) &&
214         (is_ex_exactly_of_type(basis, symbol) ||
215          is_ex_exactly_of_type(basis, constant))) {
216         int exp = ex_to_numeric(exponent).to_int();
217         if (exp > 0)
218             os << "(";
219         else {
220             exp = -exp;
221             if (type == csrc_types::ctype_cl_N)
222                 os << "recip(";
223             else
224                 os << "1.0/(";
225         }
226         print_sym_pow(os, type, static_cast<const symbol &>(*basis.bp), exp);
227         os << ")";
228
229     // <expr>^-1 is printed as "1.0/<expr>" or with the recip() function of CLN
230     } else if (exponent.compare(_num_1()) == 0) {
231         if (type == csrc_types::ctype_cl_N)
232             os << "recip(";
233         else
234             os << "1.0/(";
235         basis.bp->printcsrc(os, type, 0);
236         os << ")";
237
238     // Otherwise, use the pow() or expt() (CLN) functions
239     } else {
240         if (type == csrc_types::ctype_cl_N)
241             os << "expt(";
242         else
243             os << "pow(";
244         basis.bp->printcsrc(os, type, 0);
245         os << ",";
246         exponent.bp->printcsrc(os, type, 0);
247         os << ")";
248     }
249 }
250
251 bool power::info(unsigned inf) const
252 {
253     switch (inf) {
254         case info_flags::polynomial:
255         case info_flags::integer_polynomial:
256         case info_flags::cinteger_polynomial:
257         case info_flags::rational_polynomial:
258         case info_flags::crational_polynomial:
259             return exponent.info(info_flags::nonnegint);
260         case info_flags::rational_function:
261             return exponent.info(info_flags::integer);
262         case info_flags::algebraic:
263             return (!exponent.info(info_flags::integer) ||
264                     basis.info(inf));
265     }
266     return inherited::info(inf);
267 }
268
269 unsigned power::nops() const
270 {
271     return 2;
272 }
273
274 ex & power::let_op(int i)
275 {
276     GINAC_ASSERT(i>=0);
277     GINAC_ASSERT(i<2);
278
279     return i==0 ? basis : exponent;
280 }
281
282 int power::degree(const symbol & s) const
283 {
284     if (is_exactly_of_type(*exponent.bp,numeric)) {
285         if ((*basis.bp).compare(s)==0)
286             return ex_to_numeric(exponent).to_int();
287         else
288             return basis.degree(s) * ex_to_numeric(exponent).to_int();
289     }
290     return 0;
291 }
292
293 int power::ldegree(const symbol & s) const 
294 {
295     if (is_exactly_of_type(*exponent.bp,numeric)) {
296         if ((*basis.bp).compare(s)==0)
297             return ex_to_numeric(exponent).to_int();
298         else
299             return basis.ldegree(s) * ex_to_numeric(exponent).to_int();
300     }
301     return 0;
302 }
303
304 ex power::coeff(const symbol & s, int n) const
305 {
306     if ((*basis.bp).compare(s)!=0) {
307         // basis not equal to s
308         if (n==0) {
309             return *this;
310         } else {
311             return _ex0();
312         }
313     } else if (is_exactly_of_type(*exponent.bp,numeric)&&
314                (static_cast<const numeric &>(*exponent.bp).compare(numeric(n))==0)) {
315         return _ex1();
316     }
317
318     return _ex0();
319 }
320
321 ex power::eval(int level) const
322 {
323     // simplifications: ^(x,0) -> 1 (0^0 handled here)
324     //                  ^(x,1) -> x
325     //                  ^(0,c1) -> 0 or exception (depending on real value of c1)
326     //                  ^(1,x) -> 1
327     //                  ^(c1,c2) -> *(c1^n,c1^(c2-n)) (c1, c2 numeric(), 0<(c2-n)<1 except if c1,c2 are rational, but c1^c2 is not)
328     //                  ^(^(x,c1),c2) -> ^(x,c1*c2) (c1, c2 numeric(), c2 integer or -1 < c1 <= 1, case c1=1 should not happen, see below!)
329     //                  ^(*(x,y,z),c1) -> *(x^c1,y^c1,z^c1) (c1 integer)
330     //                  ^(*(x,c1),c2) -> ^(x,c2)*c1^c2 (c1, c2 numeric(), c1>0)
331     //                  ^(*(x,c1),c2) -> ^(-x,c2)*c1^c2 (c1, c2 numeric(), c1<0)
332     
333     debugmsg("power eval",LOGLEVEL_MEMBER_FUNCTION);
334     
335     if ((level==1) && (flags & status_flags::evaluated))
336         return *this;
337     else if (level == -max_recursion_level)
338         throw(std::runtime_error("max recursion level reached"));
339     
340     const ex & ebasis    = level==1 ? basis    : basis.eval(level-1);
341     const ex & eexponent = level==1 ? exponent : exponent.eval(level-1);
342     
343     bool basis_is_numerical = 0;
344     bool exponent_is_numerical = 0;
345     numeric * num_basis;
346     numeric * num_exponent;
347     
348     if (is_exactly_of_type(*ebasis.bp,numeric)) {
349         basis_is_numerical = 1;
350         num_basis = static_cast<numeric *>(ebasis.bp);
351     }
352     if (is_exactly_of_type(*eexponent.bp,numeric)) {
353         exponent_is_numerical = 1;
354         num_exponent = static_cast<numeric *>(eexponent.bp);
355     }
356     
357     // ^(x,0) -> 1 (0^0 also handled here)
358     if (eexponent.is_zero())
359         if (ebasis.is_zero())
360             throw (std::domain_error("power::eval(): pow(0,0) is undefined"));
361         else
362             return _ex1();
363     
364     // ^(x,1) -> x
365     if (eexponent.is_equal(_ex1()))
366         return ebasis;
367     
368     // ^(0,c1) -> 0 or exception (depending on real value of c1)
369     if (ebasis.is_zero() && exponent_is_numerical) {
370         if ((num_exponent->real()).is_zero())
371             throw (std::domain_error("power::eval(): pow(0,I) is undefined"));
372         else if ((num_exponent->real()).is_negative())
373             throw (std::overflow_error("power::eval(): division by zero"));
374         else
375             return _ex0();
376     }
377     
378     // ^(1,x) -> 1
379     if (ebasis.is_equal(_ex1()))
380         return _ex1();
381     
382     if (basis_is_numerical && exponent_is_numerical) {
383         // ^(c1,c2) -> c1^c2 (c1, c2 numeric(),
384         // except if c1,c2 are rational, but c1^c2 is not)
385         bool basis_is_crational = num_basis->is_crational();
386         bool exponent_is_crational = num_exponent->is_crational();
387         numeric res = (*num_basis).power(*num_exponent);
388         
389         if ((!basis_is_crational || !exponent_is_crational)
390             || res.is_crational()) {
391             return res;
392         }
393         GINAC_ASSERT(!num_exponent->is_integer());  // has been handled by now
394         // ^(c1,n/m) -> *(c1^q,c1^(n/m-q)), 0<(n/m-h)<1, q integer
395         if (basis_is_crational && exponent_is_crational
396             && num_exponent->is_real()
397             && !num_exponent->is_integer()) {
398             numeric n = num_exponent->numer();
399             numeric m = num_exponent->denom();
400             numeric r;
401             numeric q = iquo(n, m, r);
402             if (r.is_negative()) {
403                 r = r.add(m);
404                 q = q.sub(_num1());
405             }
406             if (q.is_zero())  // the exponent was in the allowed range 0<(n/m)<1
407                 return this->hold();
408             else {
409                 epvector res;
410                 res.push_back(expair(ebasis,r.div(m)));
411                 return (new mul(res,ex(num_basis->power(q))))->setflag(status_flags::dynallocated | status_flags::evaluated);
412             }
413         }
414     }
415     
416     // ^(^(x,c1),c2) -> ^(x,c1*c2)
417     // (c1, c2 numeric(), c2 integer or -1 < c1 <= 1,
418     // case c1==1 should not happen, see below!)
419     if (exponent_is_numerical && is_ex_exactly_of_type(ebasis,power)) {
420         const power & sub_power = ex_to_power(ebasis);
421         const ex & sub_basis = sub_power.basis;
422         const ex & sub_exponent = sub_power.exponent;
423         if (is_ex_exactly_of_type(sub_exponent,numeric)) {
424             const numeric & num_sub_exponent = ex_to_numeric(sub_exponent);
425             GINAC_ASSERT(num_sub_exponent!=numeric(1));
426             if (num_exponent->is_integer() || abs(num_sub_exponent)<1) {
427                 return power(sub_basis,num_sub_exponent.mul(*num_exponent));
428             }
429         }
430     }
431     
432     // ^(*(x,y,z),c1) -> *(x^c1,y^c1,z^c1) (c1 integer)
433     if (exponent_is_numerical && num_exponent->is_integer() &&
434         is_ex_exactly_of_type(ebasis,mul)) {
435         return expand_mul(ex_to_mul(ebasis), *num_exponent);
436     }
437     
438     // ^(*(...,x;c1),c2) -> ^(*(...,x;1),c2)*c1^c2 (c1, c2 numeric(), c1>0)
439     // ^(*(...,x,c1),c2) -> ^(*(...,x;-1),c2)*(-c1)^c2 (c1, c2 numeric(), c1<0)
440     if (exponent_is_numerical && is_ex_exactly_of_type(ebasis,mul)) {
441         GINAC_ASSERT(!num_exponent->is_integer()); // should have been handled above
442         const mul & mulref=ex_to_mul(ebasis);
443         if (!mulref.overall_coeff.is_equal(_ex1())) {
444             const numeric & num_coeff=ex_to_numeric(mulref.overall_coeff);
445             if (num_coeff.is_real()) {
446                 if (num_coeff.is_positive()>0) {
447                     mul * mulp=new mul(mulref);
448                     mulp->overall_coeff=_ex1();
449                     mulp->clearflag(status_flags::evaluated);
450                     mulp->clearflag(status_flags::hash_calculated);
451                     return (new mul(power(*mulp,exponent),
452                                     power(num_coeff,*num_exponent)))->
453                         setflag(status_flags::dynallocated);
454                 } else {
455                     GINAC_ASSERT(num_coeff.compare(_num0())<0);
456                     if (num_coeff.compare(_num_1())!=0) {
457                         mul * mulp=new mul(mulref);
458                         mulp->overall_coeff=_ex_1();
459                         mulp->clearflag(status_flags::evaluated);
460                         mulp->clearflag(status_flags::hash_calculated);
461                         return (new mul(power(*mulp,exponent),
462                                         power(abs(num_coeff),*num_exponent)))->
463                             setflag(status_flags::dynallocated);
464                     }
465                 }
466             }
467         }
468     }
469         
470     if (are_ex_trivially_equal(ebasis,basis) &&
471         are_ex_trivially_equal(eexponent,exponent)) {
472         return this->hold();
473     }
474     return (new power(ebasis, eexponent))->setflag(status_flags::dynallocated |
475                                                    status_flags::evaluated);
476 }
477
478 ex power::evalf(int level) const
479 {
480     debugmsg("power evalf",LOGLEVEL_MEMBER_FUNCTION);
481
482     ex ebasis;
483     ex eexponent;
484     
485     if (level==1) {
486         ebasis = basis;
487         eexponent = exponent;
488     } else if (level == -max_recursion_level) {
489         throw(std::runtime_error("max recursion level reached"));
490     } else {
491         ebasis = basis.evalf(level-1);
492         if (!is_ex_exactly_of_type(eexponent,numeric))
493             eexponent = exponent.evalf(level-1);
494         else
495             eexponent = exponent;
496     }
497
498     return power(ebasis,eexponent);
499 }
500
501 ex power::subs(const lst & ls, const lst & lr) const
502 {
503     const ex & subsed_basis=basis.subs(ls,lr);
504     const ex & subsed_exponent=exponent.subs(ls,lr);
505
506     if (are_ex_trivially_equal(basis,subsed_basis)&&
507         are_ex_trivially_equal(exponent,subsed_exponent)) {
508         return *this;
509     }
510     
511     return power(subsed_basis, subsed_exponent);
512 }
513
514 ex power::simplify_ncmul(const exvector & v) const
515 {
516     return inherited::simplify_ncmul(v);
517 }
518
519 // protected
520
521 /** Implementation of ex::diff() for a power.
522  *  @see ex::diff */
523 ex power::derivative(const symbol & s) const
524 {
525     if (exponent.info(info_flags::real)) {
526         // D(b^r) = r * b^(r-1) * D(b) (faster than the formula below)
527         return mul(mul(exponent, power(basis, exponent - _ex1())), basis.diff(s));
528     } else {
529         // D(b^e) = b^e * (D(e)*ln(b) + e*D(b)/b)
530         return mul(power(basis, exponent),
531                    add(mul(exponent.diff(s), log(basis)),
532                        mul(mul(exponent, basis.diff(s)), power(basis, -1))));
533     }
534 }
535
536 int power::compare_same_type(const basic & other) const
537 {
538     GINAC_ASSERT(is_exactly_of_type(other, power));
539     const power & o=static_cast<const power &>(const_cast<basic &>(other));
540
541     int cmpval;
542     cmpval=basis.compare(o.basis);
543     if (cmpval==0) {
544         return exponent.compare(o.exponent);
545     }
546     return cmpval;
547 }
548
549 unsigned power::return_type(void) const
550 {
551     return basis.return_type();
552 }
553    
554 unsigned power::return_type_tinfo(void) const
555 {
556     return basis.return_type_tinfo();
557 }
558
559 ex power::expand(unsigned options) const
560 {
561     if (flags & status_flags::expanded)
562         return *this;
563     
564     ex expanded_basis = basis.expand(options);
565     
566     if (!is_ex_exactly_of_type(exponent,numeric) ||
567         !ex_to_numeric(exponent).is_integer()) {
568         if (are_ex_trivially_equal(basis,expanded_basis)) {
569             return this->hold();
570         } else {
571             return (new power(expanded_basis,exponent))->
572                 setflag(status_flags::dynallocated |
573                         status_flags::expanded);
574         }
575     }
576     
577     // integer numeric exponent
578     const numeric & num_exponent = ex_to_numeric(exponent);
579     int int_exponent = num_exponent.to_int();
580     
581     if (int_exponent > 0 && is_ex_exactly_of_type(expanded_basis,add)) {
582         return expand_add(ex_to_add(expanded_basis), int_exponent);
583     }
584     
585     if (is_ex_exactly_of_type(expanded_basis,mul)) {
586         return expand_mul(ex_to_mul(expanded_basis), num_exponent);
587     }
588     
589     // cannot expand further
590     if (are_ex_trivially_equal(basis,expanded_basis)) {
591         return this->hold();
592     } else {
593         return (new power(expanded_basis,exponent))->
594                setflag(status_flags::dynallocated |
595                        status_flags::expanded);
596     }
597 }
598
599 //////////
600 // new virtual functions which can be overridden by derived classes
601 //////////
602
603 // none
604
605 //////////
606 // non-virtual functions in this class
607 //////////
608
609 /** expand a^n where a is an add and n is an integer.
610  *  @see power::expand */
611 ex power::expand_add(const add & a, int n) const
612 {
613     if (n==2)
614         return expand_add_2(a);
615     
616     int m = a.nops();
617     exvector sum;
618     sum.reserve((n+1)*(m-1));
619     intvector k(m-1);
620     intvector k_cum(m-1); // k_cum[l]:=sum(i=0,l,k[l]);
621     intvector upper_limit(m-1);
622     int l;
623     
624     for (int l=0; l<m-1; l++) {
625         k[l] = 0;
626         k_cum[l] = 0;
627         upper_limit[l] = n;
628     }
629     
630     while (1) {
631         exvector term;
632         term.reserve(m+1);
633         for (l=0; l<m-1; l++) {
634             const ex & b = a.op(l);
635             GINAC_ASSERT(!is_ex_exactly_of_type(b,add));
636             GINAC_ASSERT(!is_ex_exactly_of_type(b,power)||
637                          !is_ex_exactly_of_type(ex_to_power(b).exponent,numeric)||
638                          !ex_to_numeric(ex_to_power(b).exponent).is_pos_integer()||
639                          !is_ex_exactly_of_type(ex_to_power(b).basis,add)||
640                          !is_ex_exactly_of_type(ex_to_power(b).basis,mul)||
641                          !is_ex_exactly_of_type(ex_to_power(b).basis,power));
642             if (is_ex_exactly_of_type(b,mul)) {
643                 term.push_back(expand_mul(ex_to_mul(b),numeric(k[l])));
644             } else {
645                 term.push_back(power(b,k[l]));
646             }
647         }
648         
649         const ex & b = a.op(l);
650         GINAC_ASSERT(!is_ex_exactly_of_type(b,add));
651         GINAC_ASSERT(!is_ex_exactly_of_type(b,power)||
652                      !is_ex_exactly_of_type(ex_to_power(b).exponent,numeric)||
653                      !ex_to_numeric(ex_to_power(b).exponent).is_pos_integer()||
654                      !is_ex_exactly_of_type(ex_to_power(b).basis,add)||
655                      !is_ex_exactly_of_type(ex_to_power(b).basis,mul)||
656                      !is_ex_exactly_of_type(ex_to_power(b).basis,power));
657         if (is_ex_exactly_of_type(b,mul)) {
658             term.push_back(expand_mul(ex_to_mul(b),numeric(n-k_cum[m-2])));
659         } else {
660             term.push_back(power(b,n-k_cum[m-2]));
661         }
662         
663         numeric f = binomial(numeric(n),numeric(k[0]));
664         for (l=1; l<m-1; l++) {
665             f=f*binomial(numeric(n-k_cum[l-1]),numeric(k[l]));
666         }
667         term.push_back(f);
668
669         /*
670         cout << "begin term" << endl;
671         for (int i=0; i<m-1; i++) {
672             cout << "k[" << i << "]=" << k[i] << endl;
673             cout << "k_cum[" << i << "]=" << k_cum[i] << endl;
674             cout << "upper_limit[" << i << "]=" << upper_limit[i] << endl;
675         }
676         for (exvector::const_iterator cit=term.begin(); cit!=term.end(); ++cit) {
677             cout << *cit << endl;
678         }
679         cout << "end term" << endl;
680         */
681
682         // TODO: optimize this
683         sum.push_back((new mul(term))->setflag(status_flags::dynallocated));
684         
685         // increment k[]
686         l=m-2;
687         while ((l>=0)&&((++k[l])>upper_limit[l])) {
688             k[l]=0;    
689             l--;
690         }
691         if (l<0) break;
692
693         // recalc k_cum[] and upper_limit[]
694         if (l==0) {
695             k_cum[0]=k[0];
696         } else {
697             k_cum[l]=k_cum[l-1]+k[l];
698         }
699         for (int i=l+1; i<m-1; i++) {
700             k_cum[i]=k_cum[i-1]+k[i];
701         }
702
703         for (int i=l+1; i<m-1; i++) {
704             upper_limit[i]=n-k_cum[i-1];
705         }   
706     }
707     return (new add(sum))->setflag(status_flags::dynallocated |
708                                    status_flags::expanded );
709 }
710
711
712 /** Special case of power::expand_add. Expands a^2 where a is an add.
713  *  @see power::expand_add */
714 ex power::expand_add_2(const add & a) const
715 {
716     epvector sum;
717     unsigned a_nops=a.nops();
718     sum.reserve((a_nops*(a_nops+1))/2);
719     epvector::const_iterator last=a.seq.end();
720
721     // power(+(x,...,z;c),2)=power(+(x,...,z;0),2)+2*c*+(x,...,z;0)+c*c
722     // first part: ignore overall_coeff and expand other terms
723     for (epvector::const_iterator cit0=a.seq.begin(); cit0!=last; ++cit0) {
724         const ex & r=(*cit0).rest;
725         const ex & c=(*cit0).coeff;
726         
727         GINAC_ASSERT(!is_ex_exactly_of_type(r,add));
728         GINAC_ASSERT(!is_ex_exactly_of_type(r,power)||
729                !is_ex_exactly_of_type(ex_to_power(r).exponent,numeric)||
730                !ex_to_numeric(ex_to_power(r).exponent).is_pos_integer()||
731                !is_ex_exactly_of_type(ex_to_power(r).basis,add)||
732                !is_ex_exactly_of_type(ex_to_power(r).basis,mul)||
733                !is_ex_exactly_of_type(ex_to_power(r).basis,power));
734
735         if (are_ex_trivially_equal(c,_ex1())) {
736             if (is_ex_exactly_of_type(r,mul)) {
737                 sum.push_back(expair(expand_mul(ex_to_mul(r),_num2()),_ex1()));
738             } else {
739                 sum.push_back(expair((new power(r,_ex2()))->setflag(status_flags::dynallocated),
740                                      _ex1()));
741             }
742         } else {
743             if (is_ex_exactly_of_type(r,mul)) {
744                 sum.push_back(expair(expand_mul(ex_to_mul(r),_num2()),
745                                      ex_to_numeric(c).power_dyn(_num2())));
746             } else {
747                 sum.push_back(expair((new power(r,_ex2()))->setflag(status_flags::dynallocated),
748                                      ex_to_numeric(c).power_dyn(_num2())));
749             }
750         }
751             
752         for (epvector::const_iterator cit1=cit0+1; cit1!=last; ++cit1) {
753             const ex & r1=(*cit1).rest;
754             const ex & c1=(*cit1).coeff;
755             sum.push_back(a.combine_ex_with_coeff_to_pair((new mul(r,r1))->setflag(status_flags::dynallocated),
756                                                           _num2().mul(ex_to_numeric(c)).mul_dyn(ex_to_numeric(c1))));
757         }
758     }
759
760     GINAC_ASSERT(sum.size()==(a.seq.size()*(a.seq.size()+1))/2);
761
762     // second part: add terms coming from overall_factor (if != 0)
763     if (!a.overall_coeff.is_equal(_ex0())) {
764         for (epvector::const_iterator cit=a.seq.begin(); cit!=a.seq.end(); ++cit) {
765             sum.push_back(a.combine_pair_with_coeff_to_pair(*cit,ex_to_numeric(a.overall_coeff).mul_dyn(_num2())));
766         }
767         sum.push_back(expair(ex_to_numeric(a.overall_coeff).power_dyn(_num2()),_ex1()));
768     }
769         
770     GINAC_ASSERT(sum.size()==(a_nops*(a_nops+1))/2);
771     
772     return (new add(sum))->setflag(status_flags::dynallocated |
773                                    status_flags::expanded );
774 }
775
776 /** Expand factors of m in m^n where m is a mul and n is and integer
777  *  @see power::expand */
778 ex power::expand_mul(const mul & m, const numeric & n) const
779 {
780     if (n.is_equal(_num0()))
781         return _ex1();
782     
783     epvector distrseq;
784     distrseq.reserve(m.seq.size());
785     epvector::const_iterator last = m.seq.end();
786     epvector::const_iterator cit = m.seq.begin();
787     while (cit!=last) {
788         if (is_ex_exactly_of_type((*cit).rest,numeric)) {
789             distrseq.push_back(m.combine_pair_with_coeff_to_pair(*cit,n));
790         } else {
791             // it is safe not to call mul::combine_pair_with_coeff_to_pair()
792             // since n is an integer
793             distrseq.push_back(expair((*cit).rest,
794                                       ex_to_numeric((*cit).coeff).mul(n)));
795         }
796         ++cit;
797     }
798     return (new mul(distrseq,ex_to_numeric(m.overall_coeff).power_dyn(n)))
799         ->setflag(status_flags::dynallocated);
800 }
801
802 /*
803 ex power::expand_commutative_3(const ex & basis, const numeric & exponent,
804                              unsigned options) const
805 {
806     // obsolete
807
808     exvector distrseq;
809     epvector splitseq;
810
811     const add & addref=static_cast<const add &>(*basis.bp);
812
813     splitseq=addref.seq;
814     splitseq.pop_back();
815     ex first_operands=add(splitseq);
816     ex last_operand=addref.recombine_pair_to_ex(*(addref.seq.end()-1));
817     
818     int n=exponent.to_int();
819     for (int k=0; k<=n; k++) {
820         distrseq.push_back(binomial(n,k)*power(first_operands,numeric(k))*
821                            power(last_operand,numeric(n-k)));
822     }
823     return ex((new add(distrseq))->setflag(status_flags::expanded |
824                                            status_flags::dynallocated )).
825            expand(options);
826 }
827 */
828
829 /*
830 ex power::expand_noncommutative(const ex & basis, const numeric & exponent,
831                                 unsigned options) const
832 {
833     ex rest_power=ex(power(basis,exponent.add(_num_1()))).
834                   expand(options | expand_options::internal_do_not_expand_power_operands);
835
836     return ex(mul(rest_power,basis),0).
837            expand(options | expand_options::internal_do_not_expand_mul_operands);
838 }
839 */
840
841 //////////
842 // static member variables
843 //////////
844
845 // protected
846
847 unsigned power::precedence = 60;
848
849 //////////
850 // global constants
851 //////////
852
853 const power some_power;
854 const type_info & typeid_power=typeid(some_power);
855
856 // helper function
857
858 ex sqrt(const ex & a)
859 {
860     return power(a,_ex1_2());
861 }
862
863 #ifndef NO_NAMESPACE_GINAC
864 } // namespace GiNaC
865 #endif // ndef NO_NAMESPACE_GINAC