]> www.ginac.de Git - ginac.git/blobdiff - ginac/indexed.cpp
fixed a bug in the raising/lowering of dummy indices and extended it to work
[ginac.git] / ginac / indexed.cpp
index 5759b24d4c93e6f21e64a07e9ed392145e62db70..dcd6d9510d6d0ac688802373f30f7d93e0f07362 100644 (file)
@@ -3,7 +3,7 @@
  *  Implementation of GiNaC's indexed expressions. */
 
 /*
- *  GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2002 Johannes Gutenberg University Mainz, Germany
  *
  *  This program is free software; you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License as published by
@@ -20,8 +20,8 @@
  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 
+#include <iostream>
 #include <stdexcept>
-#include <algorithm>
 
 #include "indexed.h"
 #include "idx.h"
 #include "mul.h"
 #include "ncmul.h"
 #include "power.h"
+#include "relational.h"
 #include "symmetry.h"
 #include "lst.h"
 #include "print.h"
 #include "archive.h"
 #include "utils.h"
-#include "debugmsg.h"
 
 namespace GiNaC {
 
 GINAC_IMPLEMENT_REGISTERED_CLASS(indexed, exprseq)
 
 //////////
-// default constructor, destructor, copy constructor assignment operator and helpers
+// default ctor, dtor, copy ctor, assignment operator and helpers
 //////////
 
 indexed::indexed() : symtree(sy_none())
 {
-       debugmsg("indexed default constructor", LOGLEVEL_CONSTRUCT);
        tinfo_key = TINFO_indexed;
 }
 
@@ -64,63 +63,54 @@ DEFAULT_DESTROY(indexed)
 
 indexed::indexed(const ex & b) : inherited(b), symtree(sy_none())
 {
-       debugmsg("indexed constructor from ex", LOGLEVEL_CONSTRUCT);
        tinfo_key = TINFO_indexed;
        validate();
 }
 
 indexed::indexed(const ex & b, const ex & i1) : inherited(b, i1), symtree(sy_none())
 {
-       debugmsg("indexed constructor from ex,ex", LOGLEVEL_CONSTRUCT);
        tinfo_key = TINFO_indexed;
        validate();
 }
 
 indexed::indexed(const ex & b, const ex & i1, const ex & i2) : inherited(b, i1, i2), symtree(sy_none())
 {
-       debugmsg("indexed constructor from ex,ex,ex", LOGLEVEL_CONSTRUCT);
        tinfo_key = TINFO_indexed;
        validate();
 }
 
 indexed::indexed(const ex & b, const ex & i1, const ex & i2, const ex & i3) : inherited(b, i1, i2, i3), symtree(sy_none())
 {
-       debugmsg("indexed constructor from ex,ex,ex,ex", LOGLEVEL_CONSTRUCT);
        tinfo_key = TINFO_indexed;
        validate();
 }
 
 indexed::indexed(const ex & b, const ex & i1, const ex & i2, const ex & i3, const ex & i4) : inherited(b, i1, i2, i3, i4), symtree(sy_none())
 {
-       debugmsg("indexed constructor from ex,ex,ex,ex,ex", LOGLEVEL_CONSTRUCT);
        tinfo_key = TINFO_indexed;
        validate();
 }
 
 indexed::indexed(const ex & b, const symmetry & symm, const ex & i1, const ex & i2) : inherited(b, i1, i2), symtree(symm)
 {
-       debugmsg("indexed constructor from ex,symmetry,ex,ex", LOGLEVEL_CONSTRUCT);
        tinfo_key = TINFO_indexed;
        validate();
 }
 
 indexed::indexed(const ex & b, const symmetry & symm, const ex & i1, const ex & i2, const ex & i3) : inherited(b, i1, i2, i3), symtree(symm)
 {
-       debugmsg("indexed constructor from ex,symmetry,ex,ex,ex", LOGLEVEL_CONSTRUCT);
        tinfo_key = TINFO_indexed;
        validate();
 }
 
 indexed::indexed(const ex & b, const symmetry & symm, const ex & i1, const ex & i2, const ex & i3, const ex & i4) : inherited(b, i1, i2, i3, i4), symtree(symm)
 {
-       debugmsg("indexed constructor from ex,symmetry,ex,ex,ex,ex", LOGLEVEL_CONSTRUCT);
        tinfo_key = TINFO_indexed;
        validate();
 }
 
 indexed::indexed(const ex & b, const exvector & v) : inherited(b), symtree(sy_none())
 {
-       debugmsg("indexed constructor from ex,exvector", LOGLEVEL_CONSTRUCT);
        seq.insert(seq.end(), v.begin(), v.end());
        tinfo_key = TINFO_indexed;
        validate();
@@ -128,7 +118,6 @@ indexed::indexed(const ex & b, const exvector & v) : inherited(b), symtree(sy_no
 
 indexed::indexed(const ex & b, const symmetry & symm, const exvector & v) : inherited(b), symtree(symm)
 {
-       debugmsg("indexed constructor from ex,symmetry,exvector", LOGLEVEL_CONSTRUCT);
        seq.insert(seq.end(), v.begin(), v.end());
        tinfo_key = TINFO_indexed;
        validate();
@@ -136,19 +125,16 @@ indexed::indexed(const ex & b, const symmetry & symm, const exvector & v) : inhe
 
 indexed::indexed(const symmetry & symm, const exprseq & es) : inherited(es), symtree(symm)
 {
-       debugmsg("indexed constructor from symmetry,exprseq", LOGLEVEL_CONSTRUCT);
        tinfo_key = TINFO_indexed;
 }
 
 indexed::indexed(const symmetry & symm, const exvector & v, bool discardable) : inherited(v, discardable), symtree(symm)
 {
-       debugmsg("indexed constructor from symmetry,exvector", LOGLEVEL_CONSTRUCT);
        tinfo_key = TINFO_indexed;
 }
 
 indexed::indexed(const symmetry & symm, exvector * vp) : inherited(vp), symtree(symm)
 {
-       debugmsg("indexed constructor from symmetry,exvector *", LOGLEVEL_CONSTRUCT);
        tinfo_key = TINFO_indexed;
 }
 
@@ -158,7 +144,6 @@ indexed::indexed(const symmetry & symm, exvector * vp) : inherited(vp), symtree(
 
 indexed::indexed(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
 {
-       debugmsg("indexed constructor from archive_node", LOGLEVEL_CONSTRUCT);
        if (!n.find_ex("symmetry", symtree, sym_lst)) {
                // GiNaC versions <= 0.9.0 had an unsigned "symmetry" property
                unsigned symm = 0;
@@ -192,7 +177,6 @@ DEFAULT_UNARCHIVE(indexed)
 
 void indexed::print(const print_context & c, unsigned level) const
 {
-       debugmsg("indexed print", LOGLEVEL_PRINT);
        GINAC_ASSERT(seq.size() > 0);
 
        if (is_of_type(c, print_tree)) {
@@ -264,7 +248,7 @@ ex indexed::eval(int level) const
 
        // If the base object is 0, the whole object is 0
        if (base.is_zero())
-               return _ex0();
+               return _ex0;
 
        // If the base object is a product, pull out the numeric factor
        if (is_ex_exactly_of_type(base, mul) && is_ex_exactly_of_type(base.op(base.nops() - 1), numeric)) {
@@ -282,7 +266,7 @@ ex indexed::eval(int level) const
                if (sig != INT_MAX) {
                        // Something has changed while sorting indices, more evaluations later
                        if (sig == 0)
-                               return _ex0();
+                               return _ex0;
                        return ex(sig) * thisexprseq(v);
                }
        }
@@ -291,24 +275,6 @@ ex indexed::eval(int level) const
        return ex_to<basic>(base).eval_indexed(*this);
 }
 
-int indexed::degree(const ex & s) const
-{
-       return is_equal(ex_to<basic>(s)) ? 1 : 0;
-}
-
-int indexed::ldegree(const ex & s) const
-{
-       return is_equal(ex_to<basic>(s)) ? 1 : 0;
-}
-
-ex indexed::coeff(const ex & s, int n) const
-{
-       if (is_equal(ex_to<basic>(s)))
-               return n==1 ? _ex1() : _ex0();
-       else
-               return n==0 ? ex(*this) : _ex0();
-}
-
 ex indexed::thisexprseq(const exvector & v) const
 {
        return indexed(ex_to<symmetry>(symtree), v);
@@ -327,7 +293,7 @@ ex indexed::expand(unsigned options) const
 
                // expand_indexed expands (a+b).i -> a.i + b.i
                const ex & base = seq[0];
-               ex sum = _ex0();
+               ex sum = _ex0;
                for (unsigned i=0; i<base.nops(); i++) {
                        exvector s = seq;
                        s[0] = base.op(i);
@@ -363,9 +329,10 @@ void indexed::printindices(const print_context & c, unsigned level) const
 
                        while (it != itend) {
                                bool cur_covariant = (is_ex_of_type(*it, varidx) ? ex_to<varidx>(*it).is_covariant() : true);
-                               if (first || cur_covariant != covariant) {
+                               if (first || cur_covariant != covariant) { // Variance changed
+                                       // The empty {} prevents indices from ending up on top of each other
                                        if (!first)
-                                               c.s << "}";
+                                               c.s << "}{}";
                                        covariant = cur_covariant;
                                        if (covariant)
                                                c.s << "_{";
@@ -415,7 +382,7 @@ void indexed::validate(void) const
  *  @see ex::diff */
 ex indexed::derivative(const symbol & s) const
 {
-       return _ex0();
+       return _ex0;
 }
 
 //////////
@@ -526,7 +493,7 @@ exvector power::get_free_indices(void) const
 
 /** Rename dummy indices in an expression.
  *
- *  @param e Expression to be worked on
+ *  @param e Expression to work on
  *  @param local_dummy_indices The set of dummy indices that appear in the
  *    expression "e"
  *  @param global_dummy_indices The set of dummy indices that have appeared
@@ -556,7 +523,6 @@ static ex rename_dummy_indices(const ex & e, exvector & global_dummy_indices, ex
                        }
                        it++;
                }
-               shaker_sort(global_dummy_indices.begin(), global_dummy_indices.end(), ex_is_less(), ex_swap());
 
                // If this is the first set of local indices, do nothing
                if (old_global_size == 0)
@@ -571,6 +537,7 @@ static ex rename_dummy_indices(const ex & e, exvector & global_dummy_indices, ex
        shaker_sort(local_syms.begin(), local_syms.end(), ex_is_less(), ex_swap());
        for (unsigned i=0; i<global_size; i++)
                global_syms.push_back(global_dummy_indices[i].op(0));
+       shaker_sort(global_syms.begin(), global_syms.end(), ex_is_less(), ex_swap());
 
        // Remove common indices
        exlist local_uniq, global_uniq;
@@ -587,6 +554,80 @@ static ex rename_dummy_indices(const ex & e, exvector & global_dummy_indices, ex
        }
 }
 
+/** Given a set of indices, extract those of class varidx. */
+static void find_variant_indices(const exvector & v, exvector & variant_indices)
+{
+       exvector::const_iterator it1, itend;
+       for (it1 = v.begin(), itend = v.end(); it1 != itend; ++it1) {
+               if (is_exactly_a<varidx>(*it1))
+                       variant_indices.push_back(*it1);
+       }
+}
+
+/** Raise/lower dummy indices in a single indexed objects to canonicalize their
+ *  variance.
+ *
+ *  @param e Object to work on
+ *  @param variant_dummy_indices The set of indices that might need repositioning (will be changed by this function)
+ *  @param moved_indices The set of indices that have been repositioned (will be changed by this function)
+ *  @return true if 'e' was changed */
+bool reposition_dummy_indices(ex & e, exvector & variant_dummy_indices, exvector & moved_indices)
+{
+       bool something_changed = false;
+
+       // If a dummy index is encountered for the first time in the
+       // product, pull it up, otherwise, pull it down
+       exvector::const_iterator it2, it2start, it2end;
+       for (it2start = ex_to<indexed>(e).seq.begin(), it2end = ex_to<indexed>(e).seq.end(), it2 = it2start + 1; it2 != it2end; ++it2) {
+               if (!is_exactly_a<varidx>(*it2))
+                       continue;
+
+               exvector::iterator vit, vitend;
+               for (vit = variant_dummy_indices.begin(), vitend = variant_dummy_indices.end(); vit != vitend; ++vit) {
+                       if (it2->op(0).is_equal(vit->op(0))) {
+                               if (ex_to<varidx>(*it2).is_covariant()) {
+                                       e = e.subs(lst(
+                                               *it2 == ex_to<varidx>(*it2).toggle_variance(),
+                                               ex_to<varidx>(*it2).toggle_variance() == *it2
+                                       ));
+                                       something_changed = true;
+                                       it2 = ex_to<indexed>(e).seq.begin() + (it2 - it2start);
+                                       it2start = ex_to<indexed>(e).seq.begin();
+                                       it2end = ex_to<indexed>(e).seq.end();
+                               }
+                               moved_indices.push_back(*vit);
+                               variant_dummy_indices.erase(vit);
+                               goto next_index;
+                       }
+               }
+
+               for (vit = moved_indices.begin(), vitend = moved_indices.end(); vit != vitend; ++vit) {
+                       if (it2->op(0).is_equal(vit->op(0))) {
+                               if (ex_to<varidx>(*it2).is_contravariant()) {
+                                       e = e.subs(*it2 == ex_to<varidx>(*it2).toggle_variance());
+                                       something_changed = true;
+                                       it2 = ex_to<indexed>(e).seq.begin() + (it2 - it2start);
+                                       it2start = ex_to<indexed>(e).seq.begin();
+                                       it2end = ex_to<indexed>(e).seq.end();
+                               }
+                               goto next_index;
+                       }
+               }
+
+next_index: ;
+       }
+
+       return something_changed;
+}
+
+/* Ordering that only compares the base expressions of indexed objects. */
+struct ex_base_is_less : public std::binary_function<ex, ex, bool> {
+       bool operator() (const ex &lh, const ex &rh) const
+       {
+               return (is_a<indexed>(lh) ? lh.op(0) : lh).compare(is_a<indexed>(rh) ? rh.op(0) : rh) < 0;
+       }
+};
+
 /** Simplify product of indexed expressions (commutative, noncommutative and
  *  simple squares), return list of free indices. */
 ex simplify_indexed_product(const ex & e, exvector & free_indices, exvector & dummy_indices, const scalar_products & sp)
@@ -601,13 +642,13 @@ ex simplify_indexed_product(const ex & e, exvector & free_indices, exvector & du
 
        if (is_ex_exactly_of_type(e, power)) {
                // We only get called for simple squares, split a^2 -> a*a
-               GINAC_ASSERT(e.op(1).is_equal(_ex2()));
+               GINAC_ASSERT(e.op(1).is_equal(_ex2));
                v.push_back(e.op(0));
                v.push_back(e.op(0));
        } else {
                for (unsigned i=0; i<e.nops(); i++) {
                        ex f = e.op(i);
-                       if (is_ex_exactly_of_type(f, power) && f.op(1).is_equal(_ex2())) {
+                       if (is_ex_exactly_of_type(f, power) && f.op(1).is_equal(_ex2)) {
                                v.push_back(f.op(0));
                    v.push_back(f.op(0));
                        } else if (is_ex_exactly_of_type(f, ncmul)) {
@@ -663,7 +704,7 @@ try_again:
                        if (free.empty()) {
                                if (sp.is_defined(*it1, *it2)) {
                                        *it1 = sp.evaluate(*it1, *it2);
-                                       *it2 = _ex1();
+                                       *it2 = _ex1;
                                        goto contraction_done;
                                }
                        }
@@ -704,8 +745,7 @@ contraction_done:
        // Find free indices (concatenate them all and call find_free_and_dummy())
        // and all dummy indices that appear
        exvector un, individual_dummy_indices;
-       it1 = v.begin(); itend = v.end();
-       while (it1 != itend) {
+       for (it1 = v.begin(), itend = v.end(); it1 != itend; ++it1) {
                exvector free_indices_of_factor;
                if (is_ex_of_type(*it1, indexed)) {
                        exvector dummy_indices_of_factor;
@@ -714,12 +754,35 @@ contraction_done:
                } else
                        free_indices_of_factor = it1->get_free_indices();
                un.insert(un.end(), free_indices_of_factor.begin(), free_indices_of_factor.end());
-               it1++;
        }
        exvector local_dummy_indices;
        find_free_and_dummy(un, free_indices, local_dummy_indices);
        local_dummy_indices.insert(local_dummy_indices.end(), individual_dummy_indices.begin(), individual_dummy_indices.end());
 
+       // Filter out the dummy indices with variance
+       exvector variant_dummy_indices;
+       find_variant_indices(local_dummy_indices, variant_dummy_indices);
+
+       // Any indices with variance present at all?
+       if (!variant_dummy_indices.empty()) {
+
+               // Yes, bring the product into a canonical order that only depends on
+               // the base expressions of indexed objects
+               if (!non_commutative)
+                       std::sort(v.begin(), v.end(), ex_base_is_less());
+
+               exvector moved_indices;
+
+               // Iterate over all indexed objects in the product
+               for (it1 = v.begin(), itend = v.end(); it1 != itend; ++it1) {
+                       if (!is_ex_of_type(*it1, indexed))
+                               continue;
+
+                       if (reposition_dummy_indices(*it1, variant_dummy_indices, moved_indices))
+                               something_changed = true;
+               }
+       }
+
        ex r;
        if (something_changed)
                r = non_commutative ? ex(ncmul(v, true)) : ex(mul(v));
@@ -735,7 +798,7 @@ contraction_done:
                        dummy_syms.append(local_dummy_indices[i].op(0));
                if (r.symmetrize(dummy_syms).is_zero()) {
                        free_indices.clear();
-                       return _ex0();
+                       return _ex0;
                }
        }
 
@@ -757,11 +820,27 @@ ex simplify_indexed(const ex & e, exvector & free_indices, exvector & dummy_indi
        ex e_expanded = e.expand();
 
        // Simplification of single indexed object: just find the free indices
-       // and perform dummy index renaming
+       // and perform dummy index renaming/repositioning
        if (is_ex_of_type(e_expanded, indexed)) {
+
+               // Find the dummy indices
                const indexed &i = ex_to<indexed>(e_expanded);
                exvector local_dummy_indices;
                find_free_and_dummy(i.seq.begin() + 1, i.seq.end(), free_indices, local_dummy_indices);
+
+               // Filter out the dummy indices with variance
+               exvector variant_dummy_indices;
+               find_variant_indices(local_dummy_indices, variant_dummy_indices);
+
+               // Any indices with variance present at all?
+               if (!variant_dummy_indices.empty()) {
+
+                       // Yes, reposition them
+                       exvector moved_indices;
+                       reposition_dummy_indices(e_expanded, variant_dummy_indices, moved_indices);
+               }
+
+               // Rename the dummy indices
                return rename_dummy_indices(e_expanded, dummy_indices, local_dummy_indices);
        }
 
@@ -769,7 +848,7 @@ ex simplify_indexed(const ex & e, exvector & free_indices, exvector & dummy_indi
        // free indices in each term
        if (is_ex_exactly_of_type(e_expanded, add)) {
                bool first = true;
-               ex sum = _ex0();
+               ex sum = _ex0;
                free_indices.clear();
 
                for (unsigned i=0; i<e_expanded.nops(); i++) {
@@ -797,7 +876,7 @@ ex simplify_indexed(const ex & e, exvector & free_indices, exvector & dummy_indi
        // Simplification of products
        if (is_ex_exactly_of_type(e_expanded, mul)
         || is_ex_exactly_of_type(e_expanded, ncmul)
-        || (is_ex_exactly_of_type(e_expanded, power) && is_ex_of_type(e_expanded.op(0), indexed) && e_expanded.op(1).is_equal(_ex2())))
+        || (is_ex_exactly_of_type(e_expanded, power) && is_ex_of_type(e_expanded.op(0), indexed) && e_expanded.op(1).is_equal(_ex2)))
                return simplify_indexed_product(e_expanded, free_indices, dummy_indices, sp);
 
        // Cannot do anything