]> www.ginac.de Git - ginac.git/blobdiff - ginac/expairseq.cpp
- permutation_sign() and shaker_sort() are no longer inlined
[ginac.git] / ginac / expairseq.cpp
index bad422cd55570e9f273ddbe7e21bb5f1f8912312..9421570a2bfc6c3cb35a76ed6b010f72f0c5d56d 100644 (file)
@@ -26,6 +26,8 @@
 
 #include "expairseq.h"
 #include "lst.h"
+#include "relational.h"
+#include "print.h"
 #include "archive.h"
 #include "debugmsg.h"
 #include "utils.h"
@@ -101,11 +103,7 @@ void expairseq::copy(const expairseq &other)
 #endif // EXPAIRSEQ_USE_HASHTAB
 }
 
-void expairseq::destroy(bool call_parent)
-{
-       if (call_parent)
-               basic::destroy(call_parent);
-}
+DEFAULT_DESTROY(expairseq)
 
 //////////
 // other ctors
@@ -147,7 +145,6 @@ expairseq::expairseq(epvector *vp, const ex &oc)
 // archiving
 //////////
 
-/** Construct object from archive_node. */
 expairseq::expairseq(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
 #if EXPAIRSEQ_USE_HASHTAB
        , hashtabsize(0)
@@ -165,13 +162,6 @@ expairseq::expairseq(const archive_node &n, const lst &sym_lst) : inherited(n, s
        n.find_ex("overall_coeff", overall_coeff, sym_lst);
 }
 
-/** Unarchive the object. */
-ex expairseq::unarchive(const archive_node &n, const lst &sym_lst)
-{
-       return (new expairseq(n, sym_lst))->setflag(status_flags::dynallocated);
-}
-
-/** Archive the object. */
 void expairseq::archive(archive_node &n) const
 {
        inherited::archive(n);
@@ -184,6 +174,8 @@ void expairseq::archive(archive_node &n) const
        n.add_ex("overall_coeff", overall_coeff);
 }
 
+DEFAULT_UNARCHIVE(expairseq)
+
 //////////
 // functions overriding virtual functions from bases classes
 //////////
@@ -196,103 +188,89 @@ basic *expairseq::duplicate() const
        return new expairseq(*this);
 }
 
-void expairseq::print(std::ostream &os, unsigned upper_precedence) const
+void expairseq::print(const print_context & c, unsigned level) const
 {
        debugmsg("expairseq print",LOGLEVEL_PRINT);
-       os << "[[";
-       printseq(os,',',precedence,upper_precedence);
-       os << "]]";
-}
 
-void expairseq::printraw(std::ostream &os) const
-{
-       debugmsg("expairseq printraw",LOGLEVEL_PRINT);
-       
-       os << "expairseq(";
-       for (epvector::const_iterator cit=seq.begin(); cit!=seq.end(); ++cit) {
-               os << "(";
-               (*cit).rest.printraw(os);
-               os << ",";
-               (*cit).coeff.printraw(os);
-               os << "),";
-       }
-       os << ")";
-}
+       if (is_of_type(c, print_tree)) {
 
-void expairseq::printtree(std::ostream &os, unsigned indent) const
-{
-       debugmsg("expairseq printtree",LOGLEVEL_PRINT);
+               unsigned delta_indent = static_cast<const print_tree &>(c).delta_indent;
 
-       os << std::string(indent,' ') << "type=" << class_name()
-          << ", hash=" << hashvalue
-          << " (0x" << std::hex << hashvalue << std::dec << ")"
-          << ", flags=" << flags
-          << ", nops=" << nops() << std::endl;
-       for (unsigned i=0; i<seq.size(); ++i) {
-               seq[i].rest.printtree(os,indent+delta_indent);
-               seq[i].coeff.printtree(os,indent+delta_indent);
-               if (i!=seq.size()-1)
-                       os << std::string(indent+delta_indent,' ') << "-----" << std::endl;
-       }
-       if (!overall_coeff.is_equal(default_overall_coeff())) {
-               os << std::string(indent+delta_indent,' ') << "-----" << std::endl;
-               os << std::string(indent+delta_indent,' ') << "overall_coeff" << std::endl;
-               overall_coeff.printtree(os,indent+delta_indent);
-       }
-       os << std::string(indent+delta_indent,' ') << "=====" << std::endl;
+               c.s << std::string(level, ' ') << class_name()
+                   << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
+                   << ", nops=" << nops()
+                   << std::endl;
+               for (unsigned i=0; i<seq.size(); ++i) {
+                       seq[i].rest.print(c, level + delta_indent);
+                       seq[i].coeff.print(c, level + delta_indent);
+                       if (i != seq.size()-1)
+                               c.s << std::string(level + delta_indent, ' ') << "-----" << std::endl;
+               }
+               if (!overall_coeff.is_equal(default_overall_coeff())) {
+                       c.s << std::string(level + delta_indent, ' ') << "-----" << std::endl
+                           << std::string(level + delta_indent, ' ') << "overall_coeff" << std::endl;
+                       overall_coeff.print(c, level + delta_indent);
+               }
+               c.s << std::string(level + delta_indent,' ') << "=====" << std::endl;
 #if EXPAIRSEQ_USE_HASHTAB
-       os << std::string(indent+delta_indent,' ')
-          << "hashtab size " << hashtabsize << std::endl;
-       if (hashtabsize==0) return;
+               c.s << std::string(level + delta_indent,' ')
+                   << "hashtab size " << hashtabsize << std::endl;
+               if (hashtabsize == 0) return;
 #define MAXCOUNT 5
-       unsigned count[MAXCOUNT+1];
-       for (int i=0; i<MAXCOUNT+1; ++i)
-               count[i] = 0;
-       unsigned this_bin_fill;
-       unsigned cum_fill_sq = 0;
-       unsigned cum_fill = 0;
-       for (unsigned i=0; i<hashtabsize; ++i) {
-               this_bin_fill = 0;
-               if (hashtab[i].size()>0) {
-                       os << std::string(indent+delta_indent,' ') 
-                          << "bin " << i << " with entries ";
-                       for (epplist::const_iterator it=hashtab[i].begin();
-                            it!=hashtab[i].end(); ++it) {
-                               os << *it-seq.begin() << " ";
-                               ++this_bin_fill;
+               unsigned count[MAXCOUNT+1];
+               for (int i=0; i<MAXCOUNT+1; ++i)
+                       count[i] = 0;
+               unsigned this_bin_fill;
+               unsigned cum_fill_sq = 0;
+               unsigned cum_fill = 0;
+               for (unsigned i=0; i<hashtabsize; ++i) {
+                       this_bin_fill = 0;
+                       if (hashtab[i].size() > 0) {
+                               c.s << std::string(level + delta_indent, ' ')
+                                   << "bin " << i << " with entries ";
+                               for (epplist::const_iterator it=hashtab[i].begin();
+                                    it!=hashtab[i].end(); ++it) {
+                                       c.s << *it-seq.begin() << " ";
+                                       ++this_bin_fill;
+                               }
+                               os << std::endl;
+                               cum_fill += this_bin_fill;
+                               cum_fill_sq += this_bin_fill*this_bin_fill;
                        }
-                       os << std::endl;
-                       cum_fill += this_bin_fill;
-                       cum_fill_sq += this_bin_fill*this_bin_fill;
+                       if (this_bin_fill<MAXCOUNT)
+                               ++count[this_bin_fill];
+                       else
+                               ++count[MAXCOUNT];
                }
-               if (this_bin_fill<MAXCOUNT)
-                       ++count[this_bin_fill];
-               else
-                       ++count[MAXCOUNT];
-       }
-       unsigned fact = 1;
-       double cum_prob = 0;
-       double lambda = (1.0*seq.size())/hashtabsize;
-       for (int k=0; k<MAXCOUNT; ++k) {
-               if (k>0)
-                       fact *= k;
-               double prob = std::pow(lambda,k)/fact * std::exp(-lambda);
-               cum_prob += prob;
-               os << std::string(indent+delta_indent,' ') << "bins with " << k << " entries: "
-                  << int(1000.0*count[k]/hashtabsize)/10.0 << "% (expected: "
-                  << int(prob*1000)/10.0 << ")" << std::endl;
-       }
-       os << std::string(indent+delta_indent,' ') << "bins with more entries: "
-          << int(1000.0*count[MAXCOUNT]/hashtabsize)/10.0 << "% (expected: "
-          << int((1-cum_prob)*1000)/10.0 << ")" << std::endl;
-       
-       os << std::string(indent+delta_indent,' ') << "variance: "
-          << 1.0/hashtabsize*cum_fill_sq-(1.0/hashtabsize*cum_fill)*(1.0/hashtabsize*cum_fill)
-          << std::endl;
-       os << std::string(indent+delta_indent,' ') << "average fill: "
-          << (1.0*cum_fill)/hashtabsize
-          << " (should be equal to " << (1.0*seq.size())/hashtabsize << ")" << std::endl;
+               unsigned fact = 1;
+               double cum_prob = 0;
+               double lambda = (1.0*seq.size()) / hashtabsize;
+               for (int k=0; k<MAXCOUNT; ++k) {
+                       if (k>0)
+                               fact *= k;
+                       double prob = std::pow(lambda,k)/fact * std::exp(-lambda);
+                       cum_prob += prob;
+                       c.s << std::string(level + delta_indent, ' ') << "bins with " << k << " entries: "
+                           << int(1000.0*count[k]/hashtabsize)/10.0 << "% (expected: "
+                           << int(prob*1000)/10.0 << ")" << std::endl;
+               }
+               c.s << std::string(level + delta_indent, ' ') << "bins with more entries: "
+                   << int(1000.0*count[MAXCOUNT]/hashtabsize)/10.0 << "% (expected: "
+                   << int((1-cum_prob)*1000)/10.0 << ")" << std::endl;
+       
+               c.s << std::string(level + delta_indent, ' ') << "variance: "
+                   << 1.0/hashtabsize*cum_fill_sq-(1.0/hashtabsize*cum_fill)*(1.0/hashtabsize*cum_fill)
+                   << std::endl;
+               c.s << std::string(level + delta_indent, ' ') << "average fill: "
+                   << (1.0*cum_fill)/hashtabsize
+                   << " (should be equal to " << (1.0*seq.size())/hashtabsize << ")" << std::endl;
 #endif // EXPAIRSEQ_USE_HASHTAB
+
+       } else {
+               c.s << "[[";
+               printseq(c, ',', precedence(), level);
+               c.s << "]]";
+       }
 }
 
 bool expairseq::info(unsigned inf) const
@@ -344,13 +322,86 @@ ex expairseq::normal(lst &sym_lst, lst &repl_lst, int level) const
        return n.bp->basic::normal(sym_lst,repl_lst,level);
 }
 
-ex expairseq::subs(const lst &ls, const lst &lr) const
+bool expairseq::match(const ex & pattern, lst & repl_lst) const
 {
-       epvector *vp = subschildren(ls,lr);
-       if (vp==0)
-               return *this;
-       
-       return thisexpairseq(vp,overall_coeff);
+       // This differs from basic::match() because we want "a+b+c+d" to
+       // match "d+*+b" with "*" being "a+c", and we want to honor commutativity
+
+       if (tinfo() == pattern.bp->tinfo()) {
+
+               // Check whether global wildcard (one that matches the "rest of the
+               // expression", like "*" above) is present
+               bool has_global_wildcard = false;
+               ex global_wildcard;
+               for (unsigned int i=0; i<pattern.nops(); i++) {
+                       if (is_ex_exactly_of_type(pattern.op(i), wildcard)) {
+                               has_global_wildcard = true;
+                               global_wildcard = pattern.op(i);
+                               break;
+                       }
+               }
+
+               // Unfortunately, this is an O(N^2) operation because we can't
+               // sort the pattern in a useful way...
+
+               // Chop into terms
+               exvector ops;
+               ops.reserve(nops());
+               for (unsigned i=0; i<nops(); i++)
+                       ops.push_back(op(i));
+
+               // Now, for every term of the pattern, look for a matching term in
+               // the expression and remove the match
+               for (unsigned i=0; i<pattern.nops(); i++) {
+                       ex p = pattern.op(i);
+                       if (has_global_wildcard && p.is_equal(global_wildcard))
+                               continue;
+                       exvector::iterator it = ops.begin(), itend = ops.end();
+                       while (it != itend) {
+                               if (it->match(p, repl_lst)) {
+                                       ops.erase(it);
+                                       goto found;
+                               }
+                               it++;
+                       }
+                       return false; // no match found
+found:         ;
+               }
+
+               if (has_global_wildcard) {
+
+                       // Assign all the remaining terms to the global wildcard (unless
+                       // it has already been matched before, in which case the matches
+                       // must be equal)
+                       epvector *vp = new epvector();
+                       vp->reserve(ops.size());
+                       for (unsigned i=0; i<ops.size(); i++)
+                               vp->push_back(split_ex_to_pair(ops[i]));
+                       ex rest = thisexpairseq(vp, default_overall_coeff());
+                       for (unsigned i=0; i<repl_lst.nops(); i++) {
+                               if (repl_lst.op(i).op(0).is_equal(global_wildcard))
+                                       return rest.is_equal(*repl_lst.op(i).op(1).bp);
+                       }
+                       repl_lst.append(global_wildcard == rest);
+                       return true;
+
+               } else {
+
+                       // No global wildcard, then the match fails if there are any
+                       // unmatched terms left
+                       return ops.empty();
+               }
+       }
+       return inherited::match(pattern, repl_lst);
+}
+
+ex expairseq::subs(const lst &ls, const lst &lr, bool no_pattern) const
+{
+       epvector *vp = subschildren(ls, lr, no_pattern);
+       if (vp)
+               return thisexpairseq(vp, overall_coeff).bp->basic::subs(ls, lr, no_pattern);
+       else
+               return basic::subs(ls, lr, no_pattern);
 }
 
 // protected
@@ -445,9 +496,9 @@ bool expairseq::is_equal_same_type(const basic &other) const
        // compare number of elements in each hashtab entry
        if (hashtabsize!=o.hashtabsize) {
                std::cout << "this:" << std::endl;
-               printtree(std::cout,0);
+               print(print_tree(std::cout));
                std::cout << "other:" << std::endl;
-               other.printtree(std::cout,0);
+               other.print(print_tree(std::cout));
        }
                
        GINAC_ASSERT(hashtabsize==o.hashtabsize);
@@ -560,34 +611,34 @@ ex expairseq::thisexpairseq(epvector *vp, const ex &oc) const
        return expairseq(vp,oc);
 }
 
-void expairseq::printpair(std::ostream &os, const expair &p, unsigned upper_precedence) const
+void expairseq::printpair(const print_context & c, const expair & p, unsigned upper_precedence) const
 {
-       os << "[[";
-       p.rest.bp->print(os,precedence);
-       os << ",";
-       p.coeff.bp->print(os,precedence);
-       os << "]]";
+       c.s << "[[";
+       p.rest.bp->print(c, precedence());
+       c.s << ",";
+       p.coeff.bp->print(c, precedence());
+       c.s << "]]";
 }
 
-void expairseq::printseq(std::ostream &os, char delim,
+void expairseq::printseq(const print_context & c, char delim,
                          unsigned this_precedence,
                          unsigned upper_precedence) const
 {
-       if (this_precedence<=upper_precedence)
-               os << "(";
-       epvector::const_iterator it,it_last;
-       it_last=seq.end();
-       --it_last;
+       if (this_precedence <= upper_precedence)
+               c.s << "(";
+       epvector::const_iterator it, it_last = seq.end() - 1;
        for (it=seq.begin(); it!=it_last; ++it) {
-               printpair(os,*it,this_precedence);
-               os << delim;
+               printpair(c, *it, this_precedence);
+               c.s << delim;
+       }
+       printpair(c, *it, this_precedence);
+       if (!overall_coeff.is_equal(default_overall_coeff())) {
+               c.s << delim;
+               overall_coeff.print(c, this_precedence);
        }
-       printpair(os,*it,this_precedence);
-       if (!overall_coeff.is_equal(default_overall_coeff()))
-               os << delim << overall_coeff;
        
-       if (this_precedence<=upper_precedence)
-               os << ")";
+       if (this_precedence <= upper_precedence)
+               c.s << ")";
 }
 
 
@@ -1014,7 +1065,6 @@ void expairseq::make_flat(const epvector &v)
        return;
 }
 
-
 /** Brings this expairseq into a sorted (canonical) form. */
 void expairseq::canonicalize(void)
 {
@@ -1206,7 +1256,7 @@ void expairseq::sorted_insert(epplist &eppl, epp elem)
 
 void expairseq::build_hashtab_and_combine(epvector::iterator &first_numeric,
                                           epvector::iterator &last_non_zero,
-                                          vector<bool> &touched,
+                                          std::vector<bool> &touched,
                                           unsigned &number_of_zeroes)
 {
        epp current=seq.begin();
@@ -1252,7 +1302,7 @@ void expairseq::build_hashtab_and_combine(epvector::iterator &first_numeric,
 
 void expairseq::drop_coeff_0_terms(epvector::iterator &first_numeric,
                                    epvector::iterator &last_non_zero,
-                                   vector<bool> &touched,
+                                   std::vector<bool> &touched,
                                    unsigned &number_of_zeroes)
 {
        // move terms with coeff 0 to end and remove them from hashtab
@@ -1352,7 +1402,7 @@ void expairseq::combine_same_terms(void)
        epvector::iterator first_numeric = seq.end();
        epvector::iterator last_non_zero = seq.end()-1;
        
-       vector<bool> touched;
+       std::vector<bool> touched;
        touched.reserve(seq.size());
        for (unsigned i=0; i<seq.size(); ++i) touched[i]=false;
        
@@ -1410,32 +1460,32 @@ void expairseq::combine_same_terms(void)
  *  debugging or in assertions since being sorted is an invariance. */
 bool expairseq::is_canonical() const
 {
-       if (seq.size()<=1)
+       if (seq.size() <= 1)
                return 1;
        
 #if EXPAIRSEQ_USE_HASHTAB
-       if (hashtabsize>0) return 1; // not canoncalized
+       if (hashtabsize > 0) return 1; // not canoncalized
 #endif // EXPAIRSEQ_USE_HASHTAB
        
        epvector::const_iterator it = seq.begin();
        epvector::const_iterator it_last = it;
        for (++it; it!=seq.end(); it_last=it, ++it) {
-               if (!((*it_last).is_less(*it)||(*it_last).is_equal(*it))) {
-                       if (!is_ex_exactly_of_type((*it_last).rest,numeric)||
+               if (!((*it_last).is_less(*it) || (*it_last).is_equal(*it))) {
+                       if (!is_ex_exactly_of_type((*it_last).rest,numeric) ||
                                !is_ex_exactly_of_type((*it).rest,numeric)) {
                                // double test makes it easier to set a breakpoint...
-                               if (!is_ex_exactly_of_type((*it_last).rest,numeric)||
+                               if (!is_ex_exactly_of_type((*it_last).rest,numeric) ||
                                        !is_ex_exactly_of_type((*it).rest,numeric)) {
-                                       printpair(std::clog,*it_last,0);
+                                       printpair(std::clog, *it_last, 0);
                                        std::clog << ">";
-                                       printpair(std::clog,*it,0);
+                                       printpair(std::clog, *it, 0);
                                        std::clog << "\n";
                                        std::clog << "pair1:" << std::endl;
-                                       (*it_last).rest.printtree(std::clog);
-                                       (*it_last).coeff.printtree(std::clog);
+                                       (*it_last).rest.print(print_tree(std::clog));
+                                       (*it_last).coeff.print(print_tree(std::clog));
                                        std::clog << "pair2:" << std::endl;
-                                       (*it).rest.printtree(std::clog);
-                                       (*it).coeff.printtree(std::clog);
+                                       (*it).rest.print(print_tree(std::clog));
+                                       (*it).coeff.print(print_tree(std::clog));
                                        return 0;
                                }
                        }
@@ -1608,57 +1658,95 @@ epvector expairseq::diffchildren(const symbol &y) const
 /** Member-wise substitute in this sequence.
  *
  *  @see expairseq::subs()
- *  @return pointer to epvector containing pairs after application of subs or zero
- *  pointer, if no members were changed. */
-epvector * expairseq::subschildren(const lst &ls, const lst &lr) const
+ *  @return pointer to epvector containing pairs after application of subs,
+ *    or NULL pointer if no members were changed. */
+epvector * expairseq::subschildren(const lst &ls, const lst &lr, bool no_pattern) const
 {
-       // returns a NULL pointer if nothing had to be substituted
-       // returns a pointer to a newly created epvector otherwise
-       // (which has to be deleted somewhere else)
        GINAC_ASSERT(ls.nops()==lr.nops());
-       
-       epvector::const_iterator last = seq.end();
-       epvector::const_iterator cit = seq.begin();
-       while (cit!=last) {
-               const ex &subsed_ex=(*cit).rest.subs(ls,lr);
-               if (!are_ex_trivially_equal((*cit).rest,subsed_ex)) {
+
+       // The substitution is "complex" when any of the objects to be substituted
+       // is a product or power. In this case we have to recombine the pairs
+       // because the numeric coefficients may be part of the search pattern.
+       bool complex_subs = false;
+       for (unsigned i=0; i<ls.nops(); i++)
+               if (is_ex_exactly_of_type(ls.op(i), mul) || is_ex_exactly_of_type(ls.op(i), power)) {
+                       complex_subs = true;
+                       break;
+               }
+
+       if (complex_subs) {
+
+               // Substitute in the recombined pairs
+               epvector::const_iterator cit = seq.begin(), last = seq.end();
+               while (cit != last) {
+
+                       const ex &orig_ex = recombine_pair_to_ex(*cit);
+                       const ex &subsed_ex = orig_ex.subs(ls, lr, no_pattern);
+                       if (!are_ex_trivially_equal(orig_ex, subsed_ex)) {
+
+                               // Something changed, copy seq, subs and return it
+                               epvector *s = new epvector;
+                               s->reserve(seq.size());
+
+                               // Copy parts of seq which are known not to have changed
+                               s->insert(s->begin(), seq.begin(), cit);
+
+                               // Copy first changed element
+                               s->push_back(split_ex_to_pair(subsed_ex));
+                               ++cit;
+
+                               // Copy rest
+                               while (cit != last) {
+                                       s->push_back(split_ex_to_pair(recombine_pair_to_ex(*cit).subs(ls, lr, no_pattern)));
+                                       ++cit;
+                               }
+                               return s;
+                       }
+
+                       ++cit;
+               }
+
+       } else {
+
+               // Substitute only in the "rest" part of the pairs
+               epvector::const_iterator cit = seq.begin(), last = seq.end();
+               while (cit != last) {
+
+                       const ex &subsed_ex = cit->rest.subs(ls, lr, no_pattern);
+                       if (!are_ex_trivially_equal(cit->rest, subsed_ex)) {
                        
-                       // something changed, copy seq, subs and return it
-                       epvector *s = new epvector;
-                       s->reserve(seq.size());
+                               // Something changed, copy seq, subs and return it
+                               epvector *s = new epvector;
+                               s->reserve(seq.size());
+
+                               // Copy parts of seq which are known not to have changed
+                               s->insert(s->begin(), seq.begin(), cit);
                        
-                       // copy parts of seq which are known not to have changed
-                       epvector::const_iterator cit2 = seq.begin();
-                       while (cit2!=cit) {
-                               s->push_back(*cit2);
-                               ++cit2;
-                       }
-                       // copy first changed element
-                       s->push_back(combine_ex_with_coeff_to_pair(subsed_ex,
-                                                                  (*cit2).coeff));
-                       ++cit2;
-                       // copy rest
-                       while (cit2!=last) {
-                               s->push_back(combine_ex_with_coeff_to_pair((*cit2).rest.subs(ls,lr),
-                                                                          (*cit2).coeff));
-                               ++cit2;
+                               // Copy first changed element
+                               s->push_back(combine_ex_with_coeff_to_pair(subsed_ex, cit->coeff));
+                               ++cit;
+
+                               // Copy rest
+                               while (cit != last) {
+                                       s->push_back(combine_ex_with_coeff_to_pair(cit->rest.subs(ls, lr, no_pattern),
+                                                                                  cit->coeff));
+                                       ++cit;
+                               }
+                               return s;
                        }
-                       return s;
+
+                       ++cit;
                }
-               ++cit;
        }
        
-       return 0; // signalling nothing has changed
+       // Nothing has changed
+       return NULL;
 }
 
 //////////
 // static member variables
 //////////
 
-// protected
-
-unsigned expairseq::precedence = 10;
-
 #if EXPAIRSEQ_USE_HASHTAB
 unsigned expairseq::maxhashtabsize = 0x4000000U;
 unsigned expairseq::minhashtabsize = 0x1000U;