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