]> www.ginac.de Git - ginac.git/blobdiff - ginac/symmetry.cpp
print_tree prints the object addresses
[ginac.git] / ginac / symmetry.cpp
index a07fbe7eb11ccce7b5c8edc8fb623884f1536757..6cf5aaeac223a109f6280c8044bbd7cc68142748 100644 (file)
@@ -3,7 +3,7 @@
  *  Implementation of GiNaC's symmetry definitions. */
 
 /*
- *  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 <stdexcept>
 #include <functional>
-#include <algorithm>
 
 #include "symmetry.h"
 #include "lst.h"
 #include "numeric.h" // for factorial()
-#include "print.h"
+#include "operators.h"
 #include "archive.h"
 #include "utils.h"
-#include "debugmsg.h"
 
 namespace GiNaC {
 
-GINAC_IMPLEMENT_REGISTERED_CLASS(symmetry, basic)
+GINAC_IMPLEMENT_REGISTERED_CLASS_OPT(symmetry, basic,
+  print_func<print_context>(&symmetry::do_print).
+  print_func<print_tree>(&symmetry::do_print_tree))
+
+/*
+   Some notes about the structure of a symmetry tree:
+    - The leaf nodes of the tree are of type "none", have one index, and no
+      children (of course). They are constructed by the symmetry(unsigned)
+      constructor.
+    - Leaf nodes are the only nodes that only have one index.
+    - Container nodes contain two or more children. The "indices" set member
+      is the set union of the index sets of all children, and the "children"
+      vector stores the children themselves.
+    - The index set of each child of a "symm", "anti" or "cycl" node must
+      have the same size. It follows that the children of such a node are
+      either all leaf nodes, or all container nodes with two or more indices.
+*/
 
 //////////
-// default constructor, destructor, copy constructor assignment operator and helpers
+// default constructor
 //////////
 
 symmetry::symmetry() : type(none)
 {
-       debugmsg("symmetry default constructor", LOGLEVEL_CONSTRUCT);
        tinfo_key = TINFO_symmetry;
 }
 
-void symmetry::copy(const symmetry & other)
-{
-       inherited::copy(other);
-       type = other.type;
-       indices = other.indices;
-       children = other.children;
-}
-
-DEFAULT_DESTROY(symmetry)
-
 //////////
 // other constructors
 //////////
 
 symmetry::symmetry(unsigned i) : type(none)
 {
-       debugmsg("symmetry constructor from unsigned", LOGLEVEL_CONSTRUCT);
        indices.insert(i);
        tinfo_key = TINFO_symmetry;
 }
 
 symmetry::symmetry(symmetry_type t, const symmetry &c1, const symmetry &c2) : type(t)
 {
-       debugmsg("symmetry constructor from symmetry_type,symmetry &,symmetry &", LOGLEVEL_CONSTRUCT);
        add(c1); add(c2);
        tinfo_key = TINFO_symmetry;
 }
@@ -79,10 +81,8 @@ symmetry::symmetry(symmetry_type t, const symmetry &c1, const symmetry &c2) : ty
 //////////
 
 /** Construct object from archive_node. */
-symmetry::symmetry(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
+symmetry::symmetry(const archive_node &n, lst &sym_lst) : inherited(n, sym_lst)
 {
-       debugmsg("symmetry ctor from archive_node", LOGLEVEL_CONSTRUCT);
-
        unsigned t;
        if (!(n.find_unsigned("type", t)))
                throw (std::runtime_error("unknown symmetry type in archive"));
@@ -135,26 +135,25 @@ void symmetry::archive(archive_node &n) const
 DEFAULT_UNARCHIVE(symmetry)
 
 //////////
-// functions overriding virtual functions from bases classes
+// functions overriding virtual functions from base classes
 //////////
 
 int symmetry::compare_same_type(const basic & other) const
 {
-       GINAC_ASSERT(is_of_type(other, symmetry));
-       const symmetry &o = static_cast<const symmetry &>(other);
+       GINAC_ASSERT(is_a<symmetry>(other));
 
        // All symmetry trees are equal. They are not supposed to appear in
        // ordinary expressions anyway...
        return 0;
 }
 
-void symmetry::print(const print_context & c, unsigned level = 0) const
+void symmetry::do_print(const print_context & c, unsigned level) const
 {
-       debugmsg("symmetry print", LOGLEVEL_PRINT);
-
        if (children.empty()) {
                if (indices.size() > 0)
                        c.s << *(indices.begin());
+               else
+                       c.s << "none";
        } else {
                switch (type) {
                        case none: c.s << '!'; break;
@@ -164,15 +163,47 @@ void symmetry::print(const print_context & c, unsigned level = 0) const
                        default: c.s << '?'; break;
                }
                c.s << '(';
-               for (unsigned i=0; i<children.size(); i++) {
+               size_t num = children.size();
+               for (size_t i=0; i<num; i++) {
                        children[i].print(c);
-                       if (i != children.size() - 1)
+                       if (i != num - 1)
                                c.s << ",";
                }
                c.s << ')';
        }
 }
 
+void symmetry::do_print_tree(const print_tree & c, unsigned level) const
+{
+       c.s << std::string(level, ' ') << class_name() << " @" << this
+           << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
+           << ", type=";
+
+       switch (type) {
+               case none: c.s << "none"; break;
+               case symmetric: c.s << "symm"; break;
+               case antisymmetric: c.s << "anti"; break;
+               case cyclic: c.s << "cycl"; break;
+               default: c.s << "<unknown>"; break;
+       }
+
+       c.s << ", indices=(";
+       if (!indices.empty()) {
+               std::set<unsigned>::const_iterator i = indices.begin(), end = indices.end();
+               --end;
+               while (i != end)
+                       c.s << *i++ << ",";
+               c.s << *i;
+       }
+       c.s << ")\n";
+
+       exvector::const_iterator i = children.begin(), end = children.end();
+       while (i != end) {
+               i->print(c, level + c.delta_indent);
+               ++i;
+       }
+}
+
 //////////
 // non-virtual functions in this class
 //////////
@@ -181,7 +212,7 @@ symmetry &symmetry::add(const symmetry &c)
 {
        // All children must have the same number of indices
        if (type != none && !children.empty()) {
-               GINAC_ASSERT(is_ex_exactly_of_type(children[0], symmetry));
+               GINAC_ASSERT(is_exactly_a<symmetry>(children[0]));
                if (ex_to<symmetry>(children[0]).indices.size() != c.indices.size())
                        throw (std::logic_error("symmetry:add(): children must have same number of indices"));
        }
@@ -222,8 +253,8 @@ public:
 
        bool operator() (const ex &lh, const ex &rh) const
        {
-               GINAC_ASSERT(is_ex_exactly_of_type(lh, symmetry));
-               GINAC_ASSERT(is_ex_exactly_of_type(rh, symmetry));
+               GINAC_ASSERT(is_exactly_a<symmetry>(lh));
+               GINAC_ASSERT(is_exactly_a<symmetry>(rh));
                GINAC_ASSERT(ex_to<symmetry>(lh).indices.size() == ex_to<symmetry>(rh).indices.size());
                std::set<unsigned>::const_iterator ait = ex_to<symmetry>(lh).indices.begin(), aitend = ex_to<symmetry>(lh).indices.end(), bit = ex_to<symmetry>(rh).indices.begin();
                while (ait != aitend) {
@@ -248,8 +279,8 @@ public:
 
        void operator() (const ex &lh, const ex &rh)
        {
-               GINAC_ASSERT(is_ex_exactly_of_type(lh, symmetry));
-               GINAC_ASSERT(is_ex_exactly_of_type(rh, symmetry));
+               GINAC_ASSERT(is_exactly_a<symmetry>(lh));
+               GINAC_ASSERT(is_exactly_a<symmetry>(rh));
                GINAC_ASSERT(ex_to<symmetry>(lh).indices.size() == ex_to<symmetry>(rh).indices.size());
                std::set<unsigned>::const_iterator ait = ex_to<symmetry>(lh).indices.begin(), aitend = ex_to<symmetry>(lh).indices.end(), bit = ex_to<symmetry>(rh).indices.begin();
                while (ait != aitend) {
@@ -262,8 +293,8 @@ public:
 
 int canonicalize(exvector::iterator v, const symmetry &symm)
 {
-       // No children? Then do nothing
-       if (symm.children.empty())
+       // Less than two elements? Then do nothing
+       if (symm.indices.size() < 2)
                return INT_MAX;
 
        // Canonicalize children first
@@ -271,7 +302,7 @@ int canonicalize(exvector::iterator v, const symmetry &symm)
        int sign = 1;
        exvector::const_iterator first = symm.children.begin(), last = symm.children.end();
        while (first != last) {
-               GINAC_ASSERT(is_ex_exactly_of_type(*first, symmetry));
+               GINAC_ASSERT(is_exactly_a<symmetry>(*first));
                int child_sign = canonicalize(v, ex_to<symmetry>(*first));
                if (child_sign == 0)
                        return 0;
@@ -292,6 +323,8 @@ int canonicalize(exvector::iterator v, const symmetry &symm)
                case symmetry::antisymmetric:
                        // Sort the children in ascending order, keeping track of the signum
                        sign *= permutation_sign(first, last, sy_is_less(v), sy_swap(v, something_changed));
+                       if (sign == 0)
+                               return 0;
                        break;
                case symmetry::cyclic:
                        // Permute the smallest child to the front
@@ -308,14 +341,12 @@ int canonicalize(exvector::iterator v, const symmetry &symm)
 static ex symm(const ex & e, exvector::const_iterator first, exvector::const_iterator last, bool asymmetric)
 {
        // Need at least 2 objects for this operation
-       int num = last - first;
+       unsigned num = last - first;
        if (num < 2)
                return e;
 
-       // Transform object vector to a list
-       exlist iv_lst;
-       iv_lst.insert(iv_lst.begin(), first, last);
-       lst orig_lst(iv_lst, true);
+       // Transform object vector to a lst (for subs())
+       lst orig_lst(first, last);
 
        // Create index vectors for permutation
        unsigned *iv = new unsigned[num], *iv2;
@@ -330,7 +361,7 @@ static ex symm(const ex & e, exvector::const_iterator first, exvector::const_ite
                lst new_lst;
                for (unsigned i=0; i<num; i++)
                        new_lst.append(orig_lst.op(iv[i]));
-               ex term = e.subs(orig_lst, new_lst);
+               ex term = e.subs(orig_lst, new_lst, subs_options::no_pattern);
                if (asymmetric) {
                        memcpy(iv2, iv, num * sizeof(unsigned));
                        term *= permutation_sign(iv2, iv2 + num);
@@ -357,14 +388,12 @@ ex antisymmetrize(const ex & e, exvector::const_iterator first, exvector::const_
 ex symmetrize_cyclic(const ex & e, exvector::const_iterator first, exvector::const_iterator last)
 {
        // Need at least 2 objects for this operation
-       int num = last - first;
+       unsigned num = last - first;
        if (num < 2)
                return e;
 
-       // Transform object vector to a list
-       exlist iv_lst;
-       iv_lst.insert(iv_lst.begin(), first, last);
-       lst orig_lst(iv_lst, true);
+       // Transform object vector to a lst (for subs())
+       lst orig_lst(first, last);
        lst new_lst = orig_lst;
 
        // Loop over all cyclic permutations (the first permutation, which is
@@ -373,7 +402,7 @@ ex symmetrize_cyclic(const ex & e, exvector::const_iterator first, exvector::con
        for (unsigned i=0; i<num-1; i++) {
                ex perm = new_lst.op(0);
                new_lst.remove_first().append(perm);
-               sum += e.subs(orig_lst, new_lst);
+               sum += e.subs(orig_lst, new_lst, subs_options::no_pattern);
        }
        return sum / num;
 }
@@ -381,20 +410,14 @@ ex symmetrize_cyclic(const ex & e, exvector::const_iterator first, exvector::con
 /** Symmetrize expression over a list of objects (symbols, indices). */
 ex ex::symmetrize(const lst & l) const
 {
-       exvector v;
-       v.reserve(l.nops());
-       for (unsigned i=0; i<l.nops(); i++)
-               v.push_back(l.op(i));
+       exvector v(l.begin(), l.end());
        return symm(*this, v.begin(), v.end(), false);
 }
 
 /** Antisymmetrize expression over a list of objects (symbols, indices). */
 ex ex::antisymmetrize(const lst & l) const
 {
-       exvector v;
-       v.reserve(l.nops());
-       for (unsigned i=0; i<l.nops(); i++)
-               v.push_back(l.op(i));
+       exvector v(l.begin(), l.end());
        return symm(*this, v.begin(), v.end(), true);
 }
 
@@ -402,10 +425,7 @@ ex ex::antisymmetrize(const lst & l) const
  *  (symbols, indices). */
 ex ex::symmetrize_cyclic(const lst & l) const
 {
-       exvector v;
-       v.reserve(l.nops());
-       for (unsigned i=0; i<l.nops(); i++)
-               v.push_back(l.op(i));
+       exvector v(l.begin(), l.end());
        return GiNaC::symmetrize_cyclic(*this, v.begin(), v.end());
 }