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     if (inf==info_flags::polynomial ||
 254         inf==info_flags::integer_polynomial ||
 255         inf==info_flags::cinteger_polynomial ||
 256         inf==info_flags::rational_polynomial ||
 257         inf==info_flags::crational_polynomial) {
 258         return exponent.info(info_flags::nonnegint);
 259     } else if (inf==info_flags::rational_function) {
 260         return exponent.info(info_flags::integer);
 261     } else {
 262         return inherited::info(inf);
 263     }
 264 }
 265
 266 unsigned power::nops() const
 267 {
 268     return 2;
 269 }
 270
 271 ex & power::let_op(int i)
 272 {
 273     GINAC_ASSERT(i>=0);
 274     GINAC_ASSERT(i<2);
 275
 276     return i==0 ? basis : exponent;
 277 }
 278
 279 int power::degree(const symbol & s) const
 280 {
 281     if (is_exactly_of_type(*exponent.bp,numeric)) {
 282         if ((*basis.bp).compare(s)==0)
 283             return ex_to_numeric(exponent).to_int();
 284         else
 285             return basis.degree(s) * ex_to_numeric(exponent).to_int();
 286     }
 287     return 0;
 288 }
 289
 290 int power::ldegree(const symbol & s) const
 291 {
 292     if (is_exactly_of_type(*exponent.bp,numeric)) {
 293         if ((*basis.bp).compare(s)==0)
 294             return ex_to_numeric(exponent).to_int();
 295         else
 296             return basis.ldegree(s) * ex_to_numeric(exponent).to_int();
 297     }
 298     return 0;
 299 }
 300
 301 ex power::coeff(const symbol & s, int n) const
 302 {
 303     if ((*basis.bp).compare(s)!=0) {
 304         // basis not equal to s
 305         if (n==0) {
 306             return *this;
 307         } else {
 308             return _ex0();
 309         }
 310     } else if (is_exactly_of_type(*exponent.bp,numeric)&&
 311                (static_cast<const numeric &>(*exponent.bp).compare(numeric(n))==0)) {
 312         return _ex1();
 313     }
 314
 315     return _ex0();
 316 }
 317
 318 ex power::eval(int level) const
 319 {
 320     // simplifications: ^(x,0) -> 1 (0^0 handled here)
 321     //                  ^(x,1) -> x
 322     //                  ^(0,x) -> 0 (except if x is real and negative, in which case an exception is thrown)
 323     //                  ^(1,x) -> 1
 324     //                  ^(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)
 325     //                  ^(^(x,c1),c2) -> ^(x,c1*c2) (c1, c2 numeric(), c2 integer or -1 < c1 <= 1, case c1=1 should not happen, see below!)
 326     //                  ^(*(x,y,z),c1) -> *(x^c1,y^c1,z^c1) (c1 integer)
 327     //                  ^(*(x,c1),c2) -> ^(x,c2)*c1^c2 (c1, c2 numeric(), c1>0)
 328     //                  ^(*(x,c1),c2) -> ^(-x,c2)*c1^c2 (c1, c2 numeric(), c1<0)
 329
 330     debugmsg("power eval",LOGLEVEL_MEMBER_FUNCTION);
 331
 332     if ((level==1)&&(flags & status_flags::evaluated)) {
 333         return *this;
 334     } else if (level == -max_recursion_level) {
 335         throw(std::runtime_error("max recursion level reached"));
 336     }
 337
 338     const ex & ebasis    = level==1 ? basis    : basis.eval(level-1);
 339     const ex & eexponent = level==1 ? exponent : exponent.eval(level-1);
 340
 341     bool basis_is_numerical = 0;
 342     bool exponent_is_numerical = 0;
 343     numeric * num_basis;
 344     numeric * num_exponent;
 345
 346     if (is_exactly_of_type(*ebasis.bp,numeric)) {
 347         basis_is_numerical = 1;
 348         num_basis = static_cast<numeric *>(ebasis.bp);
 349     }
 350     if (is_exactly_of_type(*eexponent.bp,numeric)) {
 351         exponent_is_numerical = 1;
 352         num_exponent = static_cast<numeric *>(eexponent.bp);
 353     }
 354
 355     // ^(x,0) -> 1 (0^0 also handled here)
 356     if (eexponent.is_zero())
 357         if (ebasis.is_zero())
 358             throw (std::domain_error("power::eval(): pow(0,0) is undefined"));
 359         else
 360             return _ex1();
 361
 362     // ^(x,1) -> x
 363     if (eexponent.is_equal(_ex1()))
 364         return ebasis;
 365
 366     // ^(0,x) -> 0 (except if x is real and negative)
 367     if (ebasis.is_zero()) {
 368         if (exponent_is_numerical && num_exponent->is_negative()) {
 369             throw(std::overflow_error("power::eval(): division by zero"));
 370         } else
 371             return _ex0();
 372     }
 373
 374     // ^(1,x) -> 1
 375     if (ebasis.is_equal(_ex1()))
 376         return _ex1();
 377
 378     if (basis_is_numerical && exponent_is_numerical) {
 379         // ^(c1,c2) -> c1^c2 (c1, c2 numeric(),
 380         // except if c1,c2 are rational, but c1^c2 is not)
 381         bool basis_is_crational = num_basis->is_crational();
 382         bool exponent_is_crational = num_exponent->is_crational();
 383         numeric res = (*num_basis).power(*num_exponent);
 384
 385         if ((!basis_is_crational || !exponent_is_crational)
 386             || res.is_crational()) {
 387             return res;
 388         }
 389         GINAC_ASSERT(!num_exponent->is_integer());  // has been handled by now
 390         // ^(c1,n/m) -> *(c1^q,c1^(n/m-q)), 0<(n/m-h)<1, q integer
 391         if (basis_is_crational && exponent_is_crational
 392             && num_exponent->is_real()
 393             && !num_exponent->is_integer()) {
 394             numeric n = num_exponent->numer();
 395             numeric m = num_exponent->denom();
 396             numeric r;
 397             numeric q = iquo(n, m, r);
 398             if (r.is_negative()) {
 399                 r = r.add(m);
 400                 q = q.sub(_num1());
 401             }
 402             if (q.is_zero())  // the exponent was in the allowed range 0<(n/m)<1
 403                 return this->hold();
 404             else {
 405                 epvector res;
 406                 res.push_back(expair(ebasis,r.div(m)));
 407                 return (new mul(res,ex(num_basis->power(q))))->setflag(status_flags::dynallocated | status_flags::evaluated);
 408             }
 409         }
 410     }
 411
 412     // ^(^(x,c1),c2) -> ^(x,c1*c2)
 413     // (c1, c2 numeric(), c2 integer or -1 < c1 <= 1,
 414     // case c1==1 should not happen, see below!)
 415     if (exponent_is_numerical && is_ex_exactly_of_type(ebasis,power)) {
 416         const power & sub_power = ex_to_power(ebasis);
 417         const ex & sub_basis = sub_power.basis;
 418         const ex & sub_exponent = sub_power.exponent;
 419         if (is_ex_exactly_of_type(sub_exponent,numeric)) {
 420             const numeric & num_sub_exponent = ex_to_numeric(sub_exponent);
 421             GINAC_ASSERT(num_sub_exponent!=numeric(1));
 422             if (num_exponent->is_integer() || abs(num_sub_exponent)<1) {
 423                 return power(sub_basis,num_sub_exponent.mul(*num_exponent));
 424             }
 425         }
 426     }
 427
 428     // ^(*(x,y,z),c1) -> *(x^c1,y^c1,z^c1) (c1 integer)
 429     if (exponent_is_numerical && num_exponent->is_integer() &&
 430         is_ex_exactly_of_type(ebasis,mul)) {
 431         return expand_mul(ex_to_mul(ebasis), *num_exponent);
 432     }
 433
 434     // ^(*(...,x;c1),c2) -> ^(*(...,x;1),c2)*c1^c2 (c1, c2 numeric(), c1>0)
 435     // ^(*(...,x,c1),c2) -> ^(*(...,x;-1),c2)*(-c1)^c2 (c1, c2 numeric(), c1<0)
 436     if (exponent_is_numerical && is_ex_exactly_of_type(ebasis,mul)) {
 437         GINAC_ASSERT(!num_exponent->is_integer()); // should have been handled above
 438         const mul & mulref=ex_to_mul(ebasis);
 439         if (!mulref.overall_coeff.is_equal(_ex1())) {
 440             const numeric & num_coeff=ex_to_numeric(mulref.overall_coeff);
 441             if (num_coeff.is_real()) {
 442                 if (num_coeff.is_positive()>0) {
 443                     mul * mulp=new mul(mulref);
 444                     mulp->overall_coeff=_ex1();
 445                     mulp->clearflag(status_flags::evaluated);
 446                     mulp->clearflag(status_flags::hash_calculated);
 447                     return (new mul(power(*mulp,exponent),
 448                                     power(num_coeff,*num_exponent)))->
 449                         setflag(status_flags::dynallocated);
 450                 } else {
 451                     GINAC_ASSERT(num_coeff.compare(_num0())<0);
 452                     if (num_coeff.compare(_num_1())!=0) {
 453                         mul * mulp=new mul(mulref);
 454                         mulp->overall_coeff=_ex_1();
 455                         mulp->clearflag(status_flags::evaluated);
 456                         mulp->clearflag(status_flags::hash_calculated);
 457                         return (new mul(power(*mulp,exponent),
 458                                         power(abs(num_coeff),*num_exponent)))->
 459                             setflag(status_flags::dynallocated);
 460                     }
 461                 }
 462             }
 463         }
 464     }
 465
 466     if (are_ex_trivially_equal(ebasis,basis) &&
 467         are_ex_trivially_equal(eexponent,exponent)) {
 468         return this->hold();
 469     }
 470     return (new power(ebasis, eexponent))->setflag(status_flags::dynallocated |
 471                                                    status_flags::evaluated);
 472 }
 473
 474 ex power::evalf(int level) const
 475 {
 476     debugmsg("power evalf",LOGLEVEL_MEMBER_FUNCTION);
 477
 478     ex ebasis;
 479     ex eexponent;
 480
 481     if (level==1) {
 482         ebasis = basis;
 483         eexponent = exponent;
 484     } else if (level == -max_recursion_level) {
 485         throw(std::runtime_error("max recursion level reached"));
 486     } else {
 487         ebasis = basis.evalf(level-1);
 488         if (!is_ex_exactly_of_type(eexponent,numeric))
 489             eexponent = exponent.evalf(level-1);
 490         else
 491             eexponent = exponent;
 492     }
 493
 494     return power(ebasis,eexponent);
 495 }
 496
 497 ex power::subs(const lst & ls, const lst & lr) const
 498 {
 499     const ex & subsed_basis=basis.subs(ls,lr);
 500     const ex & subsed_exponent=exponent.subs(ls,lr);
 501
 502     if (are_ex_trivially_equal(basis,subsed_basis)&&
 503         are_ex_trivially_equal(exponent,subsed_exponent)) {
 504         return *this;
 505     }
 506
 507     return power(subsed_basis, subsed_exponent);
 508 }
 509
 510 ex power::simplify_ncmul(const exvector & v) const
 511 {
 512     return inherited::simplify_ncmul(v);
 513 }
 514
 515 // protected
 516
 517 /** Implementation of ex::diff() for a power.
 518  *  @see ex::diff */
 519 ex power::derivative(const symbol & s) const
 520 {
 521     if (exponent.info(info_flags::real)) {
 522         // D(b^r) = r * b^(r-1) * D(b) (faster than the formula below)
 523         return mul(mul(exponent, power(basis, exponent - _ex1())), basis.diff(s));
 524     } else {
 525         // D(b^e) = b^e * (D(e)*ln(b) + e*D(b)/b)
 526         return mul(power(basis, exponent),
 527                    add(mul(exponent.diff(s), log(basis)),
 528                        mul(mul(exponent, basis.diff(s)), power(basis, -1))));
 529     }
 530 }
 531
 532 int power::compare_same_type(const basic & other) const
 533 {
 534     GINAC_ASSERT(is_exactly_of_type(other, power));
 535     const power & o=static_cast<const power &>(const_cast<basic &>(other));
 536
 537     int cmpval;
 538     cmpval=basis.compare(o.basis);
 539     if (cmpval==0) {
 540         return exponent.compare(o.exponent);
 541     }
 542     return cmpval;
 543 }
 544
 545 unsigned power::return_type(void) const
 546 {
 547     return basis.return_type();
 548 }
 549
 550 unsigned power::return_type_tinfo(void) const
 551 {
 552     return basis.return_type_tinfo();
 553 }
 554
 555 ex power::expand(unsigned options) const
 556 {
 557     ex expanded_basis = basis.expand(options);
 558
 559     if (!is_ex_exactly_of_type(exponent,numeric)||
 560         !ex_to_numeric(exponent).is_integer()) {
 561         if (are_ex_trivially_equal(basis,expanded_basis)) {
 562             return this->hold();
 563         } else {
 564             return (new power(expanded_basis,exponent))->
 565                     setflag(status_flags::dynallocated);
 566         }
 567     }
 568
 569     // integer numeric exponent
 570     const numeric & num_exponent=ex_to_numeric(exponent);
 571     int int_exponent = num_exponent.to_int();
 572
 573     if (int_exponent > 0 && is_ex_exactly_of_type(expanded_basis,add)) {
 574         return expand_add(ex_to_add(expanded_basis), int_exponent);
 575     }
 576
 577     if (is_ex_exactly_of_type(expanded_basis,mul)) {
 578         return expand_mul(ex_to_mul(expanded_basis), num_exponent);
 579     }
 580
 581     // cannot expand further
 582     if (are_ex_trivially_equal(basis,expanded_basis)) {
 583         return this->hold();
 584     } else {
 585         return (new power(expanded_basis,exponent))->
 586                setflag(status_flags::dynallocated);
 587     }
 588 }
 589
 590 //////////
 591 // new virtual functions which can be overridden by derived classes
 592 //////////
 593
 594 // none
 595
 596 //////////
 597 // non-virtual functions in this class
 598 //////////
 599
 600 /** expand a^n where a is an add and n is an integer.
 601  *  @see power::expand */
 602 ex power::expand_add(const add & a, int n) const
 603 {
 604     if (n==2)
 605         return expand_add_2(a);
 606
 607     int m = a.nops();
 608     exvector sum;
 609     sum.reserve((n+1)*(m-1));
 610     intvector k(m-1);
 611     intvector k_cum(m-1); // k_cum[l]:=sum(i=0,l,k[l]);
 612     intvector upper_limit(m-1);
 613     int l;
 614
 615     for (int l=0; l<m-1; l++) {
 616         k[l]=0;
 617         k_cum[l]=0;
 618         upper_limit[l]=n;
 619     }
 620
 621     while (1) {
 622         exvector term;
 623         term.reserve(m+1);
 624         for (l=0; l<m-1; l++) {
 625             const ex & b=a.op(l);
 626             GINAC_ASSERT(!is_ex_exactly_of_type(b,add));
 627             GINAC_ASSERT(!is_ex_exactly_of_type(b,power)||
 628                    !is_ex_exactly_of_type(ex_to_power(b).exponent,numeric)||
 629                    !ex_to_numeric(ex_to_power(b).exponent).is_pos_integer());
 630             if (is_ex_exactly_of_type(b,mul)) {
 631                 term.push_back(expand_mul(ex_to_mul(b),numeric(k[l])));
 632             } else {
 633                 term.push_back(power(b,k[l]));
 634             }
 635         }
 636
 637         const ex & b=a.op(l);
 638         GINAC_ASSERT(!is_ex_exactly_of_type(b,add));
 639         GINAC_ASSERT(!is_ex_exactly_of_type(b,power)||
 640                !is_ex_exactly_of_type(ex_to_power(b).exponent,numeric)||
 641                !ex_to_numeric(ex_to_power(b).exponent).is_pos_integer());
 642         if (is_ex_exactly_of_type(b,mul)) {
 643             term.push_back(expand_mul(ex_to_mul(b),numeric(n-k_cum[m-2])));
 644         } else {
 645             term.push_back(power(b,n-k_cum[m-2]));
 646         }
 647
 648         numeric f=binomial(numeric(n),numeric(k[0]));
 649         for (l=1; l<m-1; l++) {
 650             f=f*binomial(numeric(n-k_cum[l-1]),numeric(k[l]));
 651         }
 652         term.push_back(f);
 653
 654         /*
 655         cout << "begin term" << endl;
 656         for (int i=0; i<m-1; i++) {
 657             cout << "k[" << i << "]=" << k[i] << endl;
 658             cout << "k_cum[" << i << "]=" << k_cum[i] << endl;
 659             cout << "upper_limit[" << i << "]=" << upper_limit[i] << endl;
 660         }
 661         for (exvector::const_iterator cit=term.begin(); cit!=term.end(); ++cit) {
 662             cout << *cit << endl;
 663         }
 664         cout << "end term" << endl;
 665         */
 666
 667         // TODO: optimize this
 668         sum.push_back((new mul(term))->setflag(status_flags::dynallocated));
 669
 670         // increment k[]
 671         l=m-2;
 672         while ((l>=0)&&((++k[l])>upper_limit[l])) {
 673             k[l]=0;
 674             l--;
 675         }
 676         if (l<0) break;
 677
 678         // recalc k_cum[] and upper_limit[]
 679         if (l==0) {
 680             k_cum[0]=k[0];
 681         } else {
 682             k_cum[l]=k_cum[l-1]+k[l];
 683         }
 684         for (int i=l+1; i<m-1; i++) {
 685             k_cum[i]=k_cum[i-1]+k[i];
 686         }
 687
 688         for (int i=l+1; i<m-1; i++) {
 689             upper_limit[i]=n-k_cum[i-1];
 690         }
 691     }
 692     return (new add(sum))->setflag(status_flags::dynallocated);
 693 }
 694
 695
 696 /** Special case of power::expand. Expands a^2 where a is an add.
 697  *  @see power::expand_add */
 698 ex power::expand_add_2(const add & a) const
 699 {
 700     epvector sum;
 701     unsigned a_nops=a.nops();
 702     sum.reserve((a_nops*(a_nops+1))/2);
 703     epvector::const_iterator last=a.seq.end();
 704
 705     // power(+(x,...,z;c),2)=power(+(x,...,z;0),2)+2*c*+(x,...,z;0)+c*c
 706     // first part: ignore overall_coeff and expand other terms
 707     for (epvector::const_iterator cit0=a.seq.begin(); cit0!=last; ++cit0) {
 708         const ex & r=(*cit0).rest;
 709         const ex & c=(*cit0).coeff;
 710
 711         GINAC_ASSERT(!is_ex_exactly_of_type(r,add));
 712         GINAC_ASSERT(!is_ex_exactly_of_type(r,power)||
 713                !is_ex_exactly_of_type(ex_to_power(r).exponent,numeric)||
 714                !ex_to_numeric(ex_to_power(r).exponent).is_pos_integer()||
 715                !is_ex_exactly_of_type(ex_to_power(r).basis,add)||
 716                !is_ex_exactly_of_type(ex_to_power(r).basis,mul)||
 717                !is_ex_exactly_of_type(ex_to_power(r).basis,power));
 718
 719         if (are_ex_trivially_equal(c,_ex1())) {
 720             if (is_ex_exactly_of_type(r,mul)) {
 721                 sum.push_back(expair(expand_mul(ex_to_mul(r),_num2()),_ex1()));
 722             } else {
 723                 sum.push_back(expair((new power(r,_ex2()))->setflag(status_flags::dynallocated),
 724                                      _ex1()));
 725             }
 726         } else {
 727             if (is_ex_exactly_of_type(r,mul)) {
 728                 sum.push_back(expair(expand_mul(ex_to_mul(r),_num2()),
 729                                      ex_to_numeric(c).power_dyn(_num2())));
 730             } else {
 731                 sum.push_back(expair((new power(r,_ex2()))->setflag(status_flags::dynallocated),
 732                                      ex_to_numeric(c).power_dyn(_num2())));
 733             }
 734         }
 735
 736         for (epvector::const_iterator cit1=cit0+1; cit1!=last; ++cit1) {
 737             const ex & r1=(*cit1).rest;
 738             const ex & c1=(*cit1).coeff;
 739             sum.push_back(a.combine_ex_with_coeff_to_pair((new mul(r,r1))->setflag(status_flags::dynallocated),
 740                                                           _num2().mul(ex_to_numeric(c)).mul_dyn(ex_to_numeric(c1))));
 741         }
 742     }
 743
 744     GINAC_ASSERT(sum.size()==(a.seq.size()*(a.seq.size()+1))/2);
 745
 746     // second part: add terms coming from overall_factor (if != 0)
 747     if (!a.overall_coeff.is_equal(_ex0())) {
 748         for (epvector::const_iterator cit=a.seq.begin(); cit!=a.seq.end(); ++cit) {
 749             sum.push_back(a.combine_pair_with_coeff_to_pair(*cit,ex_to_numeric(a.overall_coeff).mul_dyn(_num2())));
 750         }
 751         sum.push_back(expair(ex_to_numeric(a.overall_coeff).power_dyn(_num2()),_ex1()));
 752     }
 753
 754     GINAC_ASSERT(sum.size()==(a_nops*(a_nops+1))/2);
 755
 756     return (new add(sum))->setflag(status_flags::dynallocated);
 757 }
 758
 759 /** Expand m^n where m is a mul and n is and integer
 760  *  @see power::expand */
 761 ex power::expand_mul(const mul & m, const numeric & n) const
 762 {
 763     if (n.is_equal(_num0()))
 764         return _ex1();
 765
 766     epvector distrseq;
 767     distrseq.reserve(m.seq.size());
 768     epvector::const_iterator last=m.seq.end();
 769     epvector::const_iterator cit=m.seq.begin();
 770     while (cit!=last) {
 771         if (is_ex_exactly_of_type((*cit).rest,numeric)) {
 772             distrseq.push_back(m.combine_pair_with_coeff_to_pair(*cit,n));
 773         } else {
 774             // it is safe not to call mul::combine_pair_with_coeff_to_pair()
 775             // since n is an integer
 776             distrseq.push_back(expair((*cit).rest,
 777                                       ex_to_numeric((*cit).coeff).mul(n)));
 778         }
 779         ++cit;
 780     }
 781     return (new mul(distrseq,ex_to_numeric(m.overall_coeff).power_dyn(n)))
 782                  ->setflag(status_flags::dynallocated);
 783 }
 784
 785 /*
 786 ex power::expand_commutative_3(const ex & basis, const numeric & exponent,
 787                              unsigned options) const
 788 {
 789     // obsolete
 790
 791     exvector distrseq;
 792     epvector splitseq;
 793
 794     const add & addref=static_cast<const add &>(*basis.bp);
 795
 796     splitseq=addref.seq;
 797     splitseq.pop_back();
 798     ex first_operands=add(splitseq);
 799     ex last_operand=addref.recombine_pair_to_ex(*(addref.seq.end()-1));
 800
 801     int n=exponent.to_int();
 802     for (int k=0; k<=n; k++) {
 803         distrseq.push_back(binomial(n,k)*power(first_operands,numeric(k))*
 804                            power(last_operand,numeric(n-k)));
 805     }
 806     return ex((new add(distrseq))->setflag(status_flags::sub_expanded |
 807                                            status_flags::expanded |
 808                                            status_flags::dynallocated  )).
 809            expand(options);
 810 }
 811 */
 812
 813 /*
 814 ex power::expand_noncommutative(const ex & basis, const numeric & exponent,
 815                                 unsigned options) const
 816 {
 817     ex rest_power=ex(power(basis,exponent.add(_num_1()))).
 818                   expand(options | expand_options::internal_do_not_expand_power_operands);
 819
 820     return ex(mul(rest_power,basis),0).
 821            expand(options | expand_options::internal_do_not_expand_mul_operands);
 822 }
 823 */
 824
 825 //////////
 826 // static member variables
 827 //////////
 828
 829 // protected
 830
 831 unsigned power::precedence = 60;
 832
 833 //////////
 834 // global constants
 835 //////////
 836
 837 const power some_power;
 838 const type_info & typeid_power=typeid(some_power);
 839
 840 // helper function
 841
 842 ex sqrt(const ex & a)
 843 {
 844     return power(a,_ex1_2());
 845 }
 846
 847 #ifndef NO_NAMESPACE_GINAC
 848 } // namespace GiNaC
 849 #endif // ndef NO_NAMESPACE_GINAC