ginac/power.cpp

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