]> www.ginac.de Git - ginac.git/blobdiff - ginac/idx.cpp
synced to 1.1
[ginac.git] / ginac / idx.cpp
index c72e478e305bc02398394aa7486ceafe3d1d9150..f69613c69065652569bc7adeb524e0f6ac6bf4e7 100644 (file)
@@ -3,7 +3,7 @@
  *  Implementation of GiNaC's indices. */
 
 /*
- *  GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2003 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
  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 
+#include <iostream>
+#include <sstream>
 #include <stdexcept>
-#include <algorithm>
 
 #include "idx.h"
 #include "symbol.h"
 #include "lst.h"
+#include "relational.h"
 #include "print.h"
 #include "archive.h"
 #include "utils.h"
-#include "debugmsg.h"
 
 namespace GiNaC {
 
@@ -38,23 +39,18 @@ GINAC_IMPLEMENT_REGISTERED_CLASS(varidx, idx)
 GINAC_IMPLEMENT_REGISTERED_CLASS(spinidx, varidx)
 
 //////////
-// default constructor, destructor, copy constructor assignment operator and helpers
+// default ctor, dtor, copy ctor, assignment operator and helpers
 //////////
 
-idx::idx() : inherited(TINFO_idx)
-{
-       debugmsg("idx default constructor", LOGLEVEL_CONSTRUCT);
-}
+idx::idx() : inherited(TINFO_idx) {}
 
 varidx::varidx() : covariant(false)
 {
-       debugmsg("varidx default constructor", LOGLEVEL_CONSTRUCT);
        tinfo_key = TINFO_varidx;
 }
 
 spinidx::spinidx() : dotted(false)
 {
-       debugmsg("spinidx default constructor", LOGLEVEL_CONSTRUCT);
        tinfo_key = TINFO_spinidx;
 }
 
@@ -87,7 +83,6 @@ DEFAULT_DESTROY(spinidx)
 
 idx::idx(const ex & v, const ex & d) : inherited(TINFO_idx), value(v), dim(d)
 {
-       debugmsg("idx constructor from ex,ex", LOGLEVEL_CONSTRUCT);
        if (is_dim_numeric())
                if (!dim.info(info_flags::posint))
                        throw(std::invalid_argument("dimension of space must be a positive integer"));
@@ -95,13 +90,11 @@ idx::idx(const ex & v, const ex & d) : inherited(TINFO_idx), value(v), dim(d)
 
 varidx::varidx(const ex & v, const ex & d, bool cov) : inherited(v, d), covariant(cov)
 {
-       debugmsg("varidx constructor from ex,ex,bool", LOGLEVEL_CONSTRUCT);
        tinfo_key = TINFO_varidx;
 }
 
 spinidx::spinidx(const ex & v, const ex & d, bool cov, bool dot) : inherited(v, d, cov), dotted(dot)
 {
-       debugmsg("spinidx constructor from ex,ex,bool,bool", LOGLEVEL_CONSTRUCT);
        tinfo_key = TINFO_spinidx;
 }
 
@@ -111,20 +104,17 @@ spinidx::spinidx(const ex & v, const ex & d, bool cov, bool dot) : inherited(v,
 
 idx::idx(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
 {
-       debugmsg("idx constructor from archive_node", LOGLEVEL_CONSTRUCT);
        n.find_ex("value", value, sym_lst);
        n.find_ex("dim", dim, sym_lst);
 }
 
 varidx::varidx(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
 {
-       debugmsg("varidx constructor from archive_node", LOGLEVEL_CONSTRUCT);
        n.find_bool("covariant", covariant);
 }
 
 spinidx::spinidx(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
 {
-       debugmsg("spinidx constructor from archive_node", LOGLEVEL_CONSTRUCT);
        n.find_bool("dotted", dotted);
 }
 
@@ -152,13 +142,11 @@ DEFAULT_UNARCHIVE(varidx)
 DEFAULT_UNARCHIVE(spinidx)
 
 //////////
-// functions overriding virtual functions from bases classes
+// functions overriding virtual functions from base classes
 //////////
 
 void idx::print(const print_context & c, unsigned level) const
 {
-       debugmsg("idx print", LOGLEVEL_PRINT);
-
        if (is_of_type(c, print_tree)) {
 
                c.s << std::string(level, ' ') << class_name()
@@ -170,21 +158,23 @@ void idx::print(const print_context & c, unsigned level) const
 
        } else {
 
-               if (!is_of_type(c, print_latex))
+               if (is_a<print_latex>(c))
+                       c.s << "{";
+               else
                        c.s << ".";
-               bool need_parens = !(is_ex_exactly_of_type(value, numeric) || is_ex_of_type(value, symbol));
+               bool need_parens = !(is_exactly_a<numeric>(value) || is_a<symbol>(value));
                if (need_parens)
                        c.s << "(";
                value.print(c);
                if (need_parens)
                        c.s << ")";
+               if (is_a<print_latex>(c))
+                       c.s << "}";
        }
 }
 
 void varidx::print(const print_context & c, unsigned level) const
 {
-       debugmsg("varidx print", LOGLEVEL_PRINT);
-
        if (is_of_type(c, print_tree)) {
 
                c.s << std::string(level, ' ') << class_name()
@@ -196,26 +186,27 @@ void varidx::print(const print_context & c, unsigned level) const
                dim.print(c, level + delta_indent);
 
        } else {
-
-               if (!is_of_type(c, print_latex)) {
+               if (is_a<print_latex>(c))
+                       c.s << "{";
+               else {
                        if (covariant)
                                c.s << ".";
                        else
                                c.s << "~";
                }
-               bool need_parens = !(is_ex_exactly_of_type(value, numeric) || is_ex_of_type(value, symbol));
+               bool need_parens = !(is_exactly_a<numeric>(value) || is_a<symbol>(value));
                if (need_parens)
                        c.s << "(";
                value.print(c);
                if (need_parens)
                        c.s << ")";
+               if (is_a<print_latex>(c))
+                       c.s << "}";
        }
 }
 
 void spinidx::print(const print_context & c, unsigned level) const
 {
-       debugmsg("spinidx print", LOGLEVEL_PRINT);
-
        if (is_of_type(c, print_tree)) {
 
                c.s << std::string(level, ' ') << class_name()
@@ -230,7 +221,12 @@ void spinidx::print(const print_context & c, unsigned level) const
        } else {
 
                bool is_tex = is_of_type(c, print_latex);
-               if (!is_tex) {
+               if (is_tex) {
+                       if (covariant)
+                               c.s << "_{";
+                       else
+                               c.s << "^{";
+               } else {
                        if (covariant)
                                c.s << ".";
                        else
@@ -242,7 +238,7 @@ void spinidx::print(const print_context & c, unsigned level) const
                        else
                                c.s << "*";
                }
-               bool need_parens = !(is_ex_exactly_of_type(value, numeric) || is_ex_of_type(value, symbol));
+               bool need_parens = !(is_exactly_a<numeric>(value) || is_a<symbol>(value));
                if (need_parens)
                        c.s << "(";
                value.print(c);
@@ -250,6 +246,8 @@ void spinidx::print(const print_context & c, unsigned level) const
                        c.s << ")";
                if (is_tex && dotted)
                        c.s << "}";
+               if (is_tex)
+                       c.s << "}";
        }
 }
 
@@ -276,7 +274,7 @@ ex & idx::let_op(int i)
  *  must be such that dummy indices lie next to each other. */
 int idx::compare_same_type(const basic & other) const
 {
-       GINAC_ASSERT(is_of_type(other, idx));
+       GINAC_ASSERT(is_a<idx>(other));
        const idx &o = static_cast<const idx &>(other);
 
        int cmpval = value.compare(o.value);
@@ -285,9 +283,17 @@ int idx::compare_same_type(const basic & other) const
        return dim.compare(o.dim);
 }
 
+bool idx::match_same_type(const basic & other) const
+{
+       GINAC_ASSERT(is_a<idx>(other));
+       const idx &o = static_cast<const idx &>(other);
+
+       return dim.is_equal(o.dim);
+}
+
 int varidx::compare_same_type(const basic & other) const
 {
-       GINAC_ASSERT(is_of_type(other, varidx));
+       GINAC_ASSERT(is_a<varidx>(other));
        const varidx &o = static_cast<const varidx &>(other);
 
        int cmpval = inherited::compare_same_type(other);
@@ -300,9 +306,19 @@ int varidx::compare_same_type(const basic & other) const
        return 0;
 }
 
+bool varidx::match_same_type(const basic & other) const
+{
+       GINAC_ASSERT(is_a<varidx>(other));
+       const varidx &o = static_cast<const varidx &>(other);
+
+       if (covariant != o.covariant)
+               return false;
+       return inherited::match_same_type(other);
+}
+
 int spinidx::compare_same_type(const basic & other) const
 {
-       GINAC_ASSERT(is_of_type(other, spinidx));
+       GINAC_ASSERT(is_a<spinidx>(other));
        const spinidx &o = static_cast<const spinidx &>(other);
 
        // Check dottedness first so dummy indices will end up next to each other
@@ -316,34 +332,21 @@ int spinidx::compare_same_type(const basic & other) const
        return 0;
 }
 
-bool idx::match(const ex & pattern, lst & repl_lst) const
+bool spinidx::match_same_type(const basic & other) const
 {
-       if (!is_ex_of_type(pattern, idx))
-               return false;
-       const idx &o = ex_to_idx(pattern);
-       if (!dim.is_equal(o.dim))
-               return false;
-       return value.match(o.value, repl_lst);
-}
+       GINAC_ASSERT(is_a<spinidx>(other));
+       const spinidx &o = static_cast<const spinidx &>(other);
 
-bool varidx::match(const ex & pattern, lst & repl_lst) const
-{
-       if (!is_ex_of_type(pattern, varidx))
-               return false;
-       const varidx &o = ex_to_varidx(pattern);
-       if (covariant != o.covariant)
+       if (dotted != o.dotted)
                return false;
-       return inherited::match(pattern, repl_lst);
+       return inherited::match_same_type(other);
 }
 
-bool spinidx::match(const ex & pattern, lst & repl_lst) const
+/** By default, basic::evalf would evaluate the index value but we don't want
+ *  a.1 to become a.(1.0). */
+ex idx::evalf(int level) const
 {
-       if (!is_ex_of_type(pattern, spinidx))
-               return false;
-       const spinidx &o = ex_to_spinidx(pattern);
-       if (dotted != o.dotted)
-               return false;
-       return inherited::match(pattern, repl_lst);
+       return *this;
 }
 
 ex idx::subs(const lst & ls, const lst & lr, bool no_pattern) const
@@ -352,10 +355,10 @@ ex idx::subs(const lst & ls, const lst & lr, bool no_pattern) const
 
        // First look for index substitutions
        for (unsigned i=0; i<ls.nops(); i++) {
-               if (is_equal(*(ls.op(i)).bp)) {
+               if (is_equal(ex_to<basic>(ls.op(i)))) {
 
                        // Substitution index->index
-                       if (is_ex_of_type(lr.op(i), idx))
+                       if (is_a<idx>(lr.op(i)))
                                return lr.op(i);
 
                        // Otherwise substitute value
@@ -377,6 +380,14 @@ ex idx::subs(const lst & ls, const lst & lr, bool no_pattern) const
        return i_copy->setflag(status_flags::dynallocated);
 }
 
+/** Implementation of ex::diff() for an index always returns 0.
+ *
+ *  @see ex::diff */
+ex idx::derivative(const symbol & s) const
+{
+       return _ex0;
+}
+
 //////////
 // new virtual functions
 //////////
@@ -385,16 +396,21 @@ bool idx::is_dummy_pair_same_type(const basic & other) const
 {
        const idx &o = static_cast<const idx &>(other);
 
-       // Only pure symbols form dummy pairs, "2n+1" doesn't
-       if (!is_ex_of_type(value, symbol))
+       // Only pure symbols form dummy pairs, numeric indices and expressions
+       // like "2n+1" don't
+       if (!is_a<symbol>(value))
                return false;
 
        // Value must be equal, of course
        if (!value.is_equal(o.value))
                return false;
 
-       // Also the dimension
-       return dim.is_equal(o.dim);
+       // Dimensions need not be equal but must be comparable (so we can
+       // determine the minimum dimension of contractions)
+       if (dim.is_equal(o.dim))
+               return true;
+
+       return (dim < o.dim || dim > o.dim || (is_exactly_a<numeric>(dim) && is_a<symbol>(o.dim)) || (is_a<symbol>(dim) && is_exactly_a<numeric>(o.dim)));
 }
 
 bool varidx::is_dummy_pair_same_type(const basic & other) const
@@ -424,6 +440,19 @@ bool spinidx::is_dummy_pair_same_type(const basic & other) const
 // non-virtual functions
 //////////
 
+ex idx::replace_dim(const ex & new_dim) const
+{
+       idx *i_copy = static_cast<idx *>(duplicate());
+       i_copy->dim = new_dim;
+       i_copy->clearflag(status_flags::hash_calculated);
+       return i_copy->setflag(status_flags::dynallocated);
+}
+
+ex idx::minimal_dim(const idx & other) const
+{
+       return GiNaC::minimal_dim(dim, other.dim);
+}
+
 ex varidx::toggle_variance(void) const
 {
        varidx *i_copy = static_cast<varidx *>(duplicate());
@@ -466,10 +495,10 @@ bool is_dummy_pair(const idx & i1, const idx & i2)
 bool is_dummy_pair(const ex & e1, const ex & e2)
 {
        // The expressions must be indices
-       if (!is_ex_of_type(e1, idx) || !is_ex_of_type(e2, idx))
+       if (!is_a<idx>(e1) || !is_a<idx>(e2))
                return false;
 
-       return is_dummy_pair(ex_to_idx(e1), ex_to_idx(e2));
+       return is_dummy_pair(ex_to<idx>(e1), ex_to<idx>(e2));
 }
 
 void find_free_and_dummy(exvector::const_iterator it, exvector::const_iterator itend, exvector & out_free, exvector & out_dummy)
@@ -483,7 +512,7 @@ void find_free_and_dummy(exvector::const_iterator it, exvector::const_iterator i
 
        // Only one index? Then it is a free one if it's not numeric
        if (itend - it == 1) {
-               if (ex_to_idx(*it).is_symbolic())
+               if (ex_to<idx>(*it).is_symbolic())
                        out_free.push_back(*it);
                return;
        }
@@ -491,7 +520,7 @@ void find_free_and_dummy(exvector::const_iterator it, exvector::const_iterator i
        // Sort index vector. This will cause dummy indices come to lie next
        // to each other (because the sort order is defined to guarantee this).
        exvector v(it, itend);
-       shaker_sort(v.begin(), v.end(), ex_is_less());
+       shaker_sort(v.begin(), v.end(), ex_is_less(), ex_swap());
 
        // Find dummy pairs and free indices
        it = v.begin(); itend = v.end();
@@ -503,13 +532,26 @@ void find_free_and_dummy(exvector::const_iterator it, exvector::const_iterator i
                        if (it == itend)
                                return;
                } else {
-                       if (!it->is_equal(*last) && ex_to_idx(*last).is_symbolic())
+                       if (!it->is_equal(*last) && ex_to<idx>(*last).is_symbolic())
                                out_free.push_back(*last);
                }
                last = it++;
        }
-       if (ex_to_idx(*last).is_symbolic())
+       if (ex_to<idx>(*last).is_symbolic())
                out_free.push_back(*last);
 }
 
+ex minimal_dim(const ex & dim1, const ex & dim2)
+{
+       if (dim1.is_equal(dim2) || dim1 < dim2 || (is_exactly_a<numeric>(dim1) && is_a<symbol>(dim2)))
+               return dim1;
+       else if (dim1 > dim2 || (is_a<symbol>(dim1) && is_exactly_a<numeric>(dim2)))
+               return dim2;
+       else {
+               std::ostringstream s;
+               s << "minimal_dim(): index dimensions " << dim1 << " and " << dim2 << " cannot be ordered";
+               throw (std::runtime_error(s.str()));
+       }
+}
+
 } // namespace GiNaC