Happy New Year!

[ginac.git] / ginac / symmetry.h

diff --git a/ginac/symmetry.h b/ginac/symmetry.h
index a002885e82b6360fccb53ded09682e2d97f864e9..4f921fdf8f686955de22409500cce043f99a9094 100644 (file)
--- a/ginac/symmetry.h
+++ b/ginac/symmetry.h
@@ -3,7 +3,7 @@
  *  Interface to GiNaC's symmetry definitions. */
 
 /*
- *  GiNaC Copyright (C) 1999-2004 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2019 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
@@ -17,18 +17,18 @@
  *
  *  You should have received a copy of the GNU General Public License
  *  along with this program; if not, write to the Free Software
- *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
 
-#ifndef __GINAC_SYMMETRY_H__
-#define __GINAC_SYMMETRY_H__
-
-#include <set>
+#ifndef GINAC_SYMMETRY_H
+#define GINAC_SYMMETRY_H
 
 #include "ex.h"
+#include "archive.h"
 
-namespace GiNaC {
+#include <set>
 
+namespace GiNaC {
 
 class sy_is_less;
 class sy_swap;
@@ -61,6 +61,15 @@ public:
        /** Create node with two children. */
        symmetry(symmetry_type t, const symmetry &c1, const symmetry &c2);
 
+       // functions overriding virtual functions from base classes
+public:
+       /** Save (a.k.a. serialize) object into archive. */
+       void archive(archive_node& n) const override;
+       /** Read (a.k.a. deserialize) object from archive. */
+       void read_archive(const archive_node& n, lst& syms) override;
+protected:
+       unsigned calchash() const override;
+
        // non-virtual functions in this class
 public:
        /** Get symmetry type. */
@@ -80,7 +89,10 @@ public:
 
        /** Check whether this node actually represents any kind of symmetry. */
        bool has_symmetry() const {return type != none || !children.empty(); }
-
+       /** Check whether this node involves anything non symmetric. */
+       bool has_nonsymmetric() const;
+       /** Check whether this node involves a cyclic symmetry. */
+       bool has_cyclic() const;
 protected:
        void do_print(const print_context & c, unsigned level) const;
        void do_print_tree(const print_tree & c, unsigned level) const;
@@ -96,6 +108,7 @@ private:
        /** Vector of child nodes. */
        exvector children;
 };
+GINAC_DECLARE_UNARCHIVER(symmetry); 
 
 
 // global functions
@@ -120,13 +133,23 @@ inline symmetry sy_cycl(const symmetry &c1, const symmetry &c2) { return symmetr
 inline symmetry sy_cycl(const symmetry &c1, const symmetry &c2, const symmetry &c3) { return symmetry(symmetry::cyclic, c1, c2).add(c3); }
 inline symmetry sy_cycl(const symmetry &c1, const symmetry &c2, const symmetry &c3, const symmetry &c4) { return symmetry(symmetry::cyclic, c1, c2).add(c3).add(c4); }
 
+// These return references to preallocated common symmetries (similar to
+// the numeric flyweights).
+const symmetry & not_symmetric();
+const symmetry & symmetric2();
+const symmetry & symmetric3();
+const symmetry & symmetric4();
+const symmetry & antisymmetric2();
+const symmetry & antisymmetric3();
+const symmetry & antisymmetric4();
+
 /** Canonicalize the order of elements of an expression vector, according to
  *  the symmetry properties defined in a symmetry tree.
  *
  *  @param v Start of expression vector
  *  @param symm Root node of symmetry tree
  *  @return the overall sign introduced by the reordering (+1, -1 or 0)
- *          or INT_MAX if nothing changed */
+ *          or numeric_limits<int>::max() if nothing changed */
 extern int canonicalize(exvector::iterator v, const symmetry &symm);
 
 /** Symmetrize expression over a set of objects (symbols, indices). */
@@ -147,7 +170,7 @@ inline ex antisymmetrize(const ex & e, const exvector & v)
        return antisymmetrize(e, v.begin(), v.end());
 }
 
-/** Symmetrize expression by cyclic permuation over a set of objects
+/** Symmetrize expression by cyclic permutation over a set of objects
  *  (symbols, indices). */
 ex symmetrize_cyclic(const ex & e, exvector::const_iterator first, exvector::const_iterator last);
 
@@ -158,14 +181,6 @@ inline ex symmetrize_cyclic(const ex & e, const exvector & v)
        return symmetrize(e, v.begin(), v.end());
 }
 
-// utility functions
-
-/** Specialization of is_exactly_a<symmetry>(obj) for symmetry objects. */
-template<> inline bool is_exactly_a<symmetry>(const basic & obj)
-{
-       return obj.tinfo()==TINFO_symmetry;
-}
-
 } // namespace GiNaC
 
-#endif // ndef __GINAC_SYMMETRY_H__
+#endif // ndef GINAC_SYMMETRY_H