ginac/mul.cpp

   1 /** @file mul.cpp
   2  *
   3  *  Implementation of GiNaC's products of expressions. */
   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 <stdexcept>
  25
  26 #include "mul.h"
  27 #include "add.h"
  28 #include "power.h"
  29 #include "archive.h"
  30 #include "debugmsg.h"
  31 #include "utils.h"
  32
  33 #ifndef NO_NAMESPACE_GINAC
  34 namespace GiNaC {
  35 #endif // ndef NO_NAMESPACE_GINAC
  36
  37 GINAC_IMPLEMENT_REGISTERED_CLASS(mul, expairseq)
  38
  39 //////////
  40 // default constructor, destructor, copy constructor assignment operator and helpers
  41 //////////
  42
  43 // public
  44
  45 mul::mul()
  46 {
  47     debugmsg("mul default constructor",LOGLEVEL_CONSTRUCT);
  48     tinfo_key = TINFO_mul;
  49 }
  50
  51 mul::~mul()
  52 {
  53     debugmsg("mul destructor",LOGLEVEL_DESTRUCT);
  54     destroy(0);
  55 }
  56
  57 mul::mul(const mul & other)
  58 {
  59     debugmsg("mul copy constructor",LOGLEVEL_CONSTRUCT);
  60     copy(other);
  61 }
  62
  63 const mul & mul::operator=(const mul & other)
  64 {
  65     debugmsg("mul operator=",LOGLEVEL_ASSIGNMENT);
  66     if (this != &other) {
  67         destroy(1);
  68         copy(other);
  69     }
  70     return *this;
  71 }
  72
  73 // protected
  74
  75 void mul::copy(const mul & other)
  76 {
  77     inherited::copy(other);
  78 }
  79
  80 void mul::destroy(bool call_parent)
  81 {
  82     if (call_parent) inherited::destroy(call_parent);
  83 }
  84
  85 //////////
  86 // other constructors
  87 //////////
  88
  89 // public
  90
  91 mul::mul(const ex & lh, const ex & rh)
  92 {
  93     debugmsg("mul constructor from ex,ex",LOGLEVEL_CONSTRUCT);
  94     tinfo_key = TINFO_mul;
  95     overall_coeff = _ex1();
  96     construct_from_2_ex(lh,rh);
  97     GINAC_ASSERT(is_canonical());
  98 }
  99
 100 mul::mul(const exvector & v)
 101 {
 102     debugmsg("mul constructor from exvector",LOGLEVEL_CONSTRUCT);
 103     tinfo_key = TINFO_mul;
 104     overall_coeff = _ex1();
 105     construct_from_exvector(v);
 106     GINAC_ASSERT(is_canonical());
 107 }
 108
 109 mul::mul(const epvector & v)
 110 {
 111     debugmsg("mul constructor from epvector",LOGLEVEL_CONSTRUCT);
 112     tinfo_key = TINFO_mul;
 113     overall_coeff = _ex1();
 114     construct_from_epvector(v);
 115     GINAC_ASSERT(is_canonical());
 116 }
 117
 118 mul::mul(const epvector & v, const ex & oc)
 119 {
 120     debugmsg("mul constructor from epvector,ex",LOGLEVEL_CONSTRUCT);
 121     tinfo_key = TINFO_mul;
 122     overall_coeff = oc;
 123     construct_from_epvector(v);
 124     GINAC_ASSERT(is_canonical());
 125 }
 126
 127 mul::mul(epvector * vp, const ex & oc)
 128 {
 129     debugmsg("mul constructor from epvector *,ex",LOGLEVEL_CONSTRUCT);
 130     tinfo_key = TINFO_mul;
 131     GINAC_ASSERT(vp!=0);
 132     overall_coeff = oc;
 133     construct_from_epvector(*vp);
 134     delete vp;
 135     GINAC_ASSERT(is_canonical());
 136 }
 137
 138 mul::mul(const ex & lh, const ex & mh, const ex & rh)
 139 {
 140     debugmsg("mul constructor from ex,ex,ex",LOGLEVEL_CONSTRUCT);
 141     tinfo_key = TINFO_mul;
 142     exvector factors;
 143     factors.reserve(3);
 144     factors.push_back(lh);
 145     factors.push_back(mh);
 146     factors.push_back(rh);
 147     overall_coeff = _ex1();
 148     construct_from_exvector(factors);
 149     GINAC_ASSERT(is_canonical());
 150 }
 151
 152 //////////
 153 // archiving
 154 //////////
 155
 156 /** Construct object from archive_node. */
 157 mul::mul(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
 158 {
 159     debugmsg("mul constructor from archive_node", LOGLEVEL_CONSTRUCT);
 160 }
 161
 162 /** Unarchive the object. */
 163 ex mul::unarchive(const archive_node &n, const lst &sym_lst)
 164 {
 165     return (new mul(n, sym_lst))->setflag(status_flags::dynallocated);
 166 }
 167
 168 /** Archive the object. */
 169 void mul::archive(archive_node &n) const
 170 {
 171     inherited::archive(n);
 172 }
 173
 174 //////////
 175 // functions overriding virtual functions from bases classes
 176 //////////
 177
 178 // public
 179
 180 basic * mul::duplicate() const
 181 {
 182     debugmsg("mul duplicate",LOGLEVEL_ASSIGNMENT);
 183     return new mul(*this);
 184 }
 185
 186 void mul::print(ostream & os, unsigned upper_precedence) const
 187 {
 188     debugmsg("mul print",LOGLEVEL_PRINT);
 189     if (precedence<=upper_precedence) os << "(";
 190     bool first=true;
 191     // first print the overall numeric coefficient:
 192     numeric coeff = ex_to_numeric(overall_coeff);
 193     if (coeff.csgn()==-1) os << '-';
 194     if (!coeff.is_equal(_num1()) &&
 195         !coeff.is_equal(_num_1())) {
 196         if (coeff.is_rational()) {
 197             if (coeff.is_negative())
 198                 os << -coeff;
 199             else
 200                 os << coeff;
 201         } else {
 202             if (coeff.csgn()==-1)
 203                 (-coeff).print(os, precedence);
 204             else
 205                 coeff.print(os, precedence);
 206         }
 207         os << '*';
 208     }
 209     // then proceed with the remaining factors:
 210     for (epvector::const_iterator cit=seq.begin(); cit!=seq.end(); ++cit) {
 211         if (!first) {
 212             os << '*';
 213         } else {
 214             first=false;
 215         }
 216         recombine_pair_to_ex(*cit).print(os,precedence);
 217     }
 218     if (precedence<=upper_precedence) os << ")";
 219 }
 220
 221 void mul::printraw(ostream & os) const
 222 {
 223     debugmsg("mul printraw",LOGLEVEL_PRINT);
 224
 225     os << "*(";
 226     for (epvector::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
 227         os << "(";
 228         (*it).rest.bp->printraw(os);
 229         os << ",";
 230         (*it).coeff.bp->printraw(os);
 231         os << "),";
 232     }
 233     os << ",hash=" << hashvalue << ",flags=" << flags;
 234     os << ")";
 235 }
 236
 237 void mul::printcsrc(ostream & os, unsigned type, unsigned upper_precedence) const
 238 {
 239     debugmsg("mul print csrc", LOGLEVEL_PRINT);
 240     if (precedence <= upper_precedence)
 241         os << "(";
 242
 243     if (!overall_coeff.is_equal(_ex1())) {
 244         overall_coeff.bp->printcsrc(os,type,precedence);
 245         os << "*";
 246     }
 247
 248     // Print arguments, separated by "*" or "/"
 249     epvector::const_iterator it = seq.begin();
 250     epvector::const_iterator itend = seq.end();
 251     while (it != itend) {
 252
 253         // If the first argument is a negative integer power, it gets printed as "1.0/<expr>"
 254         if (it == seq.begin() && ex_to_numeric(it->coeff).is_integer() && it->coeff.compare(_num0()) < 0) {
 255             if (type == csrc_types::ctype_cl_N)
 256                 os << "recip(";
 257             else
 258                 os << "1.0/";
 259         }
 260
 261         // If the exponent is 1 or -1, it is left out
 262         if (it->coeff.compare(_ex1()) == 0 || it->coeff.compare(_num_1()) == 0)
 263             it->rest.bp->printcsrc(os, type, precedence);
 264         else
 265             // outer parens around ex needed for broken gcc-2.95 parser:
 266             (ex(power(it->rest, abs(ex_to_numeric(it->coeff))))).bp->printcsrc(os, type, upper_precedence);
 267
 268         // Separator is "/" for negative integer powers, "*" otherwise
 269         it++;
 270         if (it != itend) {
 271             if (ex_to_numeric(it->coeff).is_integer() && it->coeff.compare(_num0()) < 0)
 272                 os << "/";
 273             else
 274                 os << "*";
 275         }
 276     }
 277     if (precedence <= upper_precedence)
 278         os << ")";
 279 }
 280
 281 bool mul::info(unsigned inf) const
 282 {
 283     // TODO: optimize
 284     if (inf==info_flags::polynomial ||
 285         inf==info_flags::integer_polynomial ||
 286         inf==info_flags::cinteger_polynomial ||
 287         inf==info_flags::rational_polynomial ||
 288         inf==info_flags::crational_polynomial ||
 289         inf==info_flags::rational_function) {
 290         for (epvector::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
 291             if (!(recombine_pair_to_ex(*it).info(inf)))
 292                 return false;
 293         }
 294         return overall_coeff.info(inf);
 295     } else {
 296         return inherited::info(inf);
 297     }
 298 }
 299
 300 typedef vector<int> intvector;
 301
 302 int mul::degree(const symbol & s) const
 303 {
 304     int deg_sum = 0;
 305     for (epvector::const_iterator cit=seq.begin(); cit!=seq.end(); ++cit) {
 306         deg_sum+=(*cit).rest.degree(s) * ex_to_numeric((*cit).coeff).to_int();
 307     }
 308     return deg_sum;
 309 }
 310
 311 int mul::ldegree(const symbol & s) const
 312 {
 313     int deg_sum = 0;
 314     for (epvector::const_iterator cit=seq.begin(); cit!=seq.end(); ++cit) {
 315         deg_sum+=(*cit).rest.ldegree(s) * ex_to_numeric((*cit).coeff).to_int();
 316     }
 317     return deg_sum;
 318 }
 319
 320 ex mul::coeff(const symbol & s, int n) const
 321 {
 322     exvector coeffseq;
 323     coeffseq.reserve(seq.size()+1);
 324
 325     if (n==0) {
 326         // product of individual coeffs
 327         // if a non-zero power of s is found, the resulting product will be 0
 328         epvector::const_iterator it=seq.begin();
 329         while (it!=seq.end()) {
 330             coeffseq.push_back(recombine_pair_to_ex(*it).coeff(s,n));
 331             ++it;
 332         }
 333         coeffseq.push_back(overall_coeff);
 334         return (new mul(coeffseq))->setflag(status_flags::dynallocated);
 335     }
 336
 337     epvector::const_iterator it=seq.begin();
 338     bool coeff_found=0;
 339     while (it!=seq.end()) {
 340         ex t=recombine_pair_to_ex(*it);
 341         ex c=t.coeff(s,n);
 342         if (!c.is_zero()) {
 343             coeffseq.push_back(c);
 344             coeff_found=1;
 345         } else {
 346             coeffseq.push_back(t);
 347         }
 348         ++it;
 349     }
 350     if (coeff_found) {
 351         coeffseq.push_back(overall_coeff);
 352         return (new mul(coeffseq))->setflag(status_flags::dynallocated);
 353     }
 354
 355     return _ex0();
 356 }
 357
 358 ex mul::eval(int level) const
 359 {
 360     // simplifications  *(...,x;0) -> 0
 361     //                  *(+(x,y,...);c) -> *(+(*(x,c),*(y,c),...)) (c numeric())
 362     //                  *(x;1) -> x
 363     //                  *(;c) -> c
 364
 365     debugmsg("mul eval",LOGLEVEL_MEMBER_FUNCTION);
 366
 367     epvector * evaled_seqp=evalchildren(level);
 368     if (evaled_seqp!=0) {
 369         // do more evaluation later
 370         return (new mul(evaled_seqp,overall_coeff))->
 371                    setflag(status_flags::dynallocated);
 372     }
 373
 374 #ifdef DO_GINAC_ASSERT
 375     for (epvector::const_iterator cit=seq.begin(); cit!=seq.end(); ++cit) {
 376         GINAC_ASSERT((!is_ex_exactly_of_type((*cit).rest,mul))||
 377                (!(ex_to_numeric((*cit).coeff).is_integer())));
 378         GINAC_ASSERT(!((*cit).is_numeric_with_coeff_1()));
 379         if (is_ex_exactly_of_type(recombine_pair_to_ex(*cit),numeric)) {
 380             printtree(cerr,0);
 381         }
 382         GINAC_ASSERT(!is_ex_exactly_of_type(recombine_pair_to_ex(*cit),numeric));
 383         /* for paranoia */
 384         expair p=split_ex_to_pair(recombine_pair_to_ex(*cit));
 385         GINAC_ASSERT(p.rest.is_equal((*cit).rest));
 386         GINAC_ASSERT(p.coeff.is_equal((*cit).coeff));
 387         /* end paranoia */
 388     }
 389 #endif // def DO_GINAC_ASSERT
 390
 391     if (flags & status_flags::evaluated) {
 392         GINAC_ASSERT(seq.size()>0);
 393         GINAC_ASSERT((seq.size()>1)||!overall_coeff.is_equal(_ex1()));
 394         return *this;
 395     }
 396
 397     int seq_size=seq.size();
 398     if (overall_coeff.is_equal(_ex0())) {
 399         // *(...,x;0) -> 0
 400         return _ex0();
 401     } else if (seq_size==0) {
 402         // *(;c) -> c
 403         return overall_coeff;
 404     } else if ((seq_size==1)&&overall_coeff.is_equal(_ex1())) {
 405         // *(x;1) -> x
 406         return recombine_pair_to_ex(*(seq.begin()));
 407     } else if ((seq_size==1) &&
 408                is_ex_exactly_of_type((*seq.begin()).rest,add) &&
 409                ex_to_numeric((*seq.begin()).coeff).is_equal(_num1())) {
 410         // *(+(x,y,...);c) -> +(*(x,c),*(y,c),...) (c numeric(), no powers of +())
 411         const add & addref=ex_to_add((*seq.begin()).rest);
 412         epvector distrseq;
 413         distrseq.reserve(addref.seq.size());
 414         for (epvector::const_iterator cit=addref.seq.begin(); cit!=addref.seq.end(); ++cit) {
 415             distrseq.push_back(addref.combine_pair_with_coeff_to_pair(*cit,
 416                                    overall_coeff));
 417         }
 418         return (new add(distrseq,
 419                         ex_to_numeric(addref.overall_coeff).
 420                         mul_dyn(ex_to_numeric(overall_coeff))))
 421             ->setflag(status_flags::dynallocated |
 422                       status_flags::evaluated );
 423     }
 424     return this->hold();
 425 }
 426
 427 ex mul::evalf(int level) const
 428 {
 429     if (level==1)
 430         return mul(seq,overall_coeff);
 431
 432     if (level==-max_recursion_level)
 433         throw(std::runtime_error("max recursion level reached"));
 434
 435     epvector s;
 436     s.reserve(seq.size());
 437
 438     --level;
 439     for (epvector::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
 440         s.push_back(combine_ex_with_coeff_to_pair((*it).rest.evalf(level),
 441                                                   (*it).coeff));
 442     }
 443     return mul(s,overall_coeff.evalf(level));
 444 }
 445
 446 exvector mul::get_indices(void) const
 447 {
 448     // return union of indices of factors
 449     exvector iv;
 450     for (epvector::const_iterator cit=seq.begin(); cit!=seq.end(); ++cit) {
 451         exvector subiv=(*cit).rest.get_indices();
 452         iv.reserve(iv.size()+subiv.size());
 453         for (exvector::const_iterator cit2=subiv.begin(); cit2!=subiv.end(); ++cit2) {
 454             iv.push_back(*cit2);
 455         }
 456     }
 457     return iv;
 458 }
 459
 460 ex mul::simplify_ncmul(const exvector & v) const
 461 {
 462     throw(std::logic_error("mul::simplify_ncmul() should never have been called!"));
 463 }
 464
 465 // protected
 466
 467 /** Implementation of ex::diff() for a product. It applies the product rule.
 468  *  @see ex::diff */
 469 ex mul::derivative(const symbol & s) const
 470 {
 471     exvector new_seq;
 472     new_seq.reserve(seq.size());
 473
 474     // D(a*b*c)=D(a)*b*c+a*D(b)*c+a*b*D(c)
 475     for (unsigned i=0; i!=seq.size(); i++) {
 476         epvector sub_seq = seq;
 477         sub_seq[i] = split_ex_to_pair(sub_seq[i].coeff*
 478                                       power(sub_seq[i].rest,sub_seq[i].coeff-1)*
 479                                       sub_seq[i].rest.diff(s));
 480         new_seq.push_back((new mul(sub_seq,overall_coeff))->setflag(status_flags::dynallocated));
 481     }
 482     return (new add(new_seq))->setflag(status_flags::dynallocated);
 483 }
 484
 485 int mul::compare_same_type(const basic & other) const
 486 {
 487     return inherited::compare_same_type(other);
 488 }
 489
 490 bool mul::is_equal_same_type(const basic & other) const
 491 {
 492     return inherited::is_equal_same_type(other);
 493 }
 494
 495 unsigned mul::return_type(void) const
 496 {
 497     if (seq.size()==0) {
 498         // mul without factors: should not happen, but commutes
 499         return return_types::commutative;
 500     }
 501
 502     bool all_commutative = 1;
 503     unsigned rt;
 504     epvector::const_iterator cit_noncommutative_element; // point to first found nc element
 505
 506     for (epvector::const_iterator cit=seq.begin(); cit!=seq.end(); ++cit) {
 507         rt=(*cit).rest.return_type();
 508         if (rt==return_types::noncommutative_composite) return rt; // one ncc -> mul also ncc
 509         if ((rt==return_types::noncommutative)&&(all_commutative)) {
 510             // first nc element found, remember position
 511             cit_noncommutative_element = cit;
 512             all_commutative = 0;
 513         }
 514         if ((rt==return_types::noncommutative)&&(!all_commutative)) {
 515             // another nc element found, compare type_infos
 516             if ((*cit_noncommutative_element).rest.return_type_tinfo()!=(*cit).rest.return_type_tinfo()) {
 517                 // diffent types -> mul is ncc
 518                 return return_types::noncommutative_composite;
 519             }
 520         }
 521     }
 522     // all factors checked
 523     return all_commutative ? return_types::commutative : return_types::noncommutative;
 524 }
 525
 526 unsigned mul::return_type_tinfo(void) const
 527 {
 528     if (seq.size()==0) {
 529         // mul without factors: should not happen
 530         return tinfo_key;
 531     }
 532     // return type_info of first noncommutative element
 533     for (epvector::const_iterator cit=seq.begin(); cit!=seq.end(); ++cit) {
 534         if ((*cit).rest.return_type()==return_types::noncommutative) {
 535             return (*cit).rest.return_type_tinfo();
 536         }
 537     }
 538     // no noncommutative element found, should not happen
 539     return tinfo_key;
 540 }
 541
 542 ex mul::thisexpairseq(const epvector & v, const ex & oc) const
 543 {
 544     return (new mul(v,oc))->setflag(status_flags::dynallocated);
 545 }
 546
 547 ex mul::thisexpairseq(epvector * vp, const ex & oc) const
 548 {
 549     return (new mul(vp,oc))->setflag(status_flags::dynallocated);
 550 }
 551
 552 expair mul::split_ex_to_pair(const ex & e) const
 553 {
 554     if (is_ex_exactly_of_type(e,power)) {
 555         const power & powerref=ex_to_power(e);
 556         if (is_ex_exactly_of_type(powerref.exponent,numeric)) {
 557             return expair(powerref.basis,powerref.exponent);
 558         }
 559     }
 560     return expair(e,_ex1());
 561 }
 562
 563 expair mul::combine_ex_with_coeff_to_pair(const ex & e,
 564                                           const ex & c) const
 565 {
 566     // to avoid duplication of power simplification rules,
 567     // we create a temporary power object
 568     // otherwise it would be hard to correctly simplify
 569     // expression like (4^(1/3))^(3/2)
 570     if (are_ex_trivially_equal(c,_ex1())) {
 571         return split_ex_to_pair(e);
 572     }
 573     return split_ex_to_pair(power(e,c));
 574 }
 575
 576 expair mul::combine_pair_with_coeff_to_pair(const expair & p,
 577                                             const ex & c) const
 578 {
 579     // to avoid duplication of power simplification rules,
 580     // we create a temporary power object
 581     // otherwise it would be hard to correctly simplify
 582     // expression like (4^(1/3))^(3/2)
 583     if (are_ex_trivially_equal(c,_ex1())) {
 584         return p;
 585     }
 586     return split_ex_to_pair(power(recombine_pair_to_ex(p),c));
 587 }
 588
 589 ex mul::recombine_pair_to_ex(const expair & p) const
 590 {
 591     // if (p.coeff.compare(_ex1())==0) {
 592     // if (are_ex_trivially_equal(p.coeff,_ex1())) {
 593     if (ex_to_numeric(p.coeff).is_equal(_num1())) {
 594         return p.rest;
 595     } else {
 596         return power(p.rest,p.coeff);
 597     }
 598 }
 599
 600 bool mul::expair_needs_further_processing(epp it)
 601 {
 602     if (is_ex_exactly_of_type((*it).rest,mul) &&
 603         ex_to_numeric((*it).coeff).is_integer()) {
 604         // combined pair is product with integer power -> expand it
 605         *it=split_ex_to_pair(recombine_pair_to_ex(*it));
 606         return true;
 607     }
 608     if (is_ex_exactly_of_type((*it).rest,numeric)) {
 609         expair ep=split_ex_to_pair(recombine_pair_to_ex(*it));
 610         if (!ep.is_equal(*it)) {
 611             // combined pair is a numeric power which can be simplified
 612             *it=ep;
 613             return true;
 614         }
 615         if (ex_to_numeric((*it).coeff).is_equal(_num1())) {
 616             // combined pair has coeff 1 and must be moved to the end
 617             return true;
 618         }
 619     }
 620     return false;
 621 }
 622
 623 ex mul::default_overall_coeff(void) const
 624 {
 625     return _ex1();
 626 }
 627
 628 void mul::combine_overall_coeff(const ex & c)
 629 {
 630     GINAC_ASSERT(is_ex_exactly_of_type(overall_coeff,numeric));
 631     GINAC_ASSERT(is_ex_exactly_of_type(c,numeric));
 632     overall_coeff = ex_to_numeric(overall_coeff).mul_dyn(ex_to_numeric(c));
 633 }
 634
 635 void mul::combine_overall_coeff(const ex & c1, const ex & c2)
 636 {
 637     GINAC_ASSERT(is_ex_exactly_of_type(overall_coeff,numeric));
 638     GINAC_ASSERT(is_ex_exactly_of_type(c1,numeric));
 639     GINAC_ASSERT(is_ex_exactly_of_type(c2,numeric));
 640     overall_coeff = ex_to_numeric(overall_coeff).
 641                         mul_dyn(ex_to_numeric(c1).power(ex_to_numeric(c2)));
 642 }
 643
 644 bool mul::can_make_flat(const expair & p) const
 645 {
 646     GINAC_ASSERT(is_ex_exactly_of_type(p.coeff,numeric));
 647     // this assertion will probably fail somewhere
 648     // it would require a more careful make_flat, obeying the power laws
 649     // probably should return true only if p.coeff is integer
 650     return ex_to_numeric(p.coeff).is_equal(_num1());
 651 }
 652
 653 ex mul::expand(unsigned options) const
 654 {
 655     if (flags & status_flags::expanded)
 656         return *this;
 657
 658     exvector sub_expanded_seq;
 659     intvector positions_of_adds;
 660     intvector number_of_add_operands;
 661
 662     epvector * expanded_seqp = expandchildren(options);
 663
 664     const epvector & expanded_seq = expanded_seqp==0 ? seq : *expanded_seqp;
 665
 666     positions_of_adds.resize(expanded_seq.size());
 667     number_of_add_operands.resize(expanded_seq.size());
 668
 669     int number_of_adds = 0;
 670     int number_of_expanded_terms = 1;
 671
 672     unsigned current_position = 0;
 673     epvector::const_iterator last = expanded_seq.end();
 674     for (epvector::const_iterator cit=expanded_seq.begin(); cit!=last; ++cit) {
 675         if (is_ex_exactly_of_type((*cit).rest,add)&&
 676             (ex_to_numeric((*cit).coeff).is_equal(_num1()))) {
 677             positions_of_adds[number_of_adds] = current_position;
 678             const add & expanded_addref = ex_to_add((*cit).rest);
 679             unsigned addref_nops = expanded_addref.nops();
 680             number_of_add_operands[number_of_adds] = addref_nops;
 681             number_of_expanded_terms *= addref_nops;
 682             number_of_adds++;
 683         }
 684         current_position++;
 685     }
 686
 687     if (number_of_adds==0) {
 688         if (expanded_seqp==0) {
 689             return this->setflag(status_flags::expanded);
 690         }
 691         return (new mul(expanded_seqp,overall_coeff))->
 692             setflag(status_flags::dynallocated |
 693                     status_flags::expanded);
 694     }
 695
 696     exvector distrseq;
 697     distrseq.reserve(number_of_expanded_terms);
 698
 699     intvector k;
 700     k.resize(number_of_adds);
 701
 702     int l;
 703     for (l=0; l<number_of_adds; l++) {
 704         k[l]=0;
 705     }
 706
 707     while (1) {
 708         epvector term;
 709         term = expanded_seq;
 710         for (l=0; l<number_of_adds; l++) {
 711             const add & addref=ex_to_add(expanded_seq[positions_of_adds[l]].rest);
 712             GINAC_ASSERT(term[positions_of_adds[l]].coeff.compare(_ex1())==0);
 713             term[positions_of_adds[l]]=split_ex_to_pair(addref.op(k[l]));
 714         }
 715         distrseq.push_back((new mul(term,overall_coeff))->
 716                            setflag(status_flags::dynallocated |
 717                                    status_flags::expanded));
 718
 719         // increment k[]
 720         l=number_of_adds-1;
 721         while ((l>=0) && ((++k[l])>=number_of_add_operands[l])) {
 722             k[l]=0;
 723             l--;
 724         }
 725         if (l<0) break;
 726     }
 727
 728     if (expanded_seqp!=0)
 729         delete expanded_seqp;
 730
 731     return (new add(distrseq))->setflag(status_flags::dynallocated |
 732                                         status_flags::expanded);
 733 }
 734
 735 //////////
 736 // new virtual functions which can be overridden by derived classes
 737 //////////
 738
 739 // none
 740
 741 //////////
 742 // non-virtual functions in this class
 743 //////////
 744
 745 epvector * mul::expandchildren(unsigned options) const
 746 {
 747     epvector::const_iterator last = seq.end();
 748     epvector::const_iterator cit = seq.begin();
 749     while (cit!=last) {
 750         const ex & factor = recombine_pair_to_ex(*cit);
 751         const ex & expanded_factor = factor.expand(options);
 752         if (!are_ex_trivially_equal(factor,expanded_factor)) {
 753
 754             // something changed, copy seq, eval and return it
 755             epvector *s=new epvector;
 756             s->reserve(seq.size());
 757
 758             // copy parts of seq which are known not to have changed
 759             epvector::const_iterator cit2 = seq.begin();
 760             while (cit2!=cit) {
 761                 s->push_back(*cit2);
 762                 ++cit2;
 763             }
 764             // copy first changed element
 765             s->push_back(split_ex_to_pair(expanded_factor));
 766             ++cit2;
 767             // copy rest
 768             while (cit2!=last) {
 769                 s->push_back(split_ex_to_pair(recombine_pair_to_ex(*cit2).expand(options)));
 770                 ++cit2;
 771             }
 772             return s;
 773         }
 774         ++cit;
 775     }
 776
 777     return 0; // nothing has changed
 778 }
 779
 780 //////////
 781 // static member variables
 782 //////////
 783
 784 // protected
 785
 786 unsigned mul::precedence = 50;
 787
 788
 789 //////////
 790 // global constants
 791 //////////
 792
 793 const mul some_mul;
 794 const type_info & typeid_mul = typeid(some_mul);
 795
 796 #ifndef NO_NAMESPACE_GINAC
 797 } // namespace GiNaC
 798 #endif // ndef NO_NAMESPACE_GINAC