* Interface to GiNaC's symmetry definitions. */
/*
- * GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
+ * GiNaC Copyright (C) 1999-2011 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
*
* 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;
/** Create node with two children. */
symmetry(symmetry_type t, const symmetry &c1, const symmetry &c2);
- // functions overriding virtual functions from base classes
-public:
- void print(const print_context & c, unsigned level = 0) const;
-
// non-virtual functions in this class
public:
/** Get symmetry type. */
void validate(unsigned n);
/** Check whether this node actually represents any kind of symmetry. */
- bool has_symmetry(void) const {return type != none || !children.empty(); }
+ 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;
+
+ /** Save (a.k.a. serialize) object into archive. */
+ void archive(archive_node& n) const;
+ /** Read (a.k.a. deserialize) object from archive. */
+ void read_archive(const archive_node& n, lst& syms);
+protected:
+ void do_print(const print_context & c, unsigned level) const;
+ void do_print_tree(const print_tree & c, unsigned level) const;
+ unsigned calchash() const;
// member variables
private:
/** Vector of child nodes. */
exvector children;
};
+GINAC_DECLARE_UNARCHIVER(symmetry);
// global functions
-inline const symmetry &ex_to_symmetry(const ex &e)
-{
- return static_cast<const symmetry &>(*e.bp);
-}
-
-inline symmetry &ex_to_nonconst_symmetry(const ex &e)
-{
- return static_cast<symmetry &>(*e.bp);
-}
-inline symmetry sy_none(void) { return symmetry(); }
+inline symmetry sy_none() { return symmetry(); }
inline symmetry sy_none(const symmetry &c1, const symmetry &c2) { return symmetry(symmetry::none, c1, c2); }
inline symmetry sy_none(const symmetry &c1, const symmetry &c2, const symmetry &c3) { return symmetry(symmetry::none, c1, c2).add(c3); }
inline symmetry sy_none(const symmetry &c1, const symmetry &c2, const symmetry &c3, const symmetry &c4) { return symmetry(symmetry::none, c1, c2).add(c3).add(c4); }
-inline symmetry sy_symm(void) { symmetry s; s.set_type(symmetry::symmetric); return s; }
+inline symmetry sy_symm() { symmetry s; s.set_type(symmetry::symmetric); return s; }
inline symmetry sy_symm(const symmetry &c1, const symmetry &c2) { return symmetry(symmetry::symmetric, c1, c2); }
inline symmetry sy_symm(const symmetry &c1, const symmetry &c2, const symmetry &c3) { return symmetry(symmetry::symmetric, c1, c2).add(c3); }
inline symmetry sy_symm(const symmetry &c1, const symmetry &c2, const symmetry &c3, const symmetry &c4) { return symmetry(symmetry::symmetric, c1, c2).add(c3).add(c4); }
-inline symmetry sy_anti(void) { symmetry s; s.set_type(symmetry::antisymmetric); return s; }
+inline symmetry sy_anti() { symmetry s; s.set_type(symmetry::antisymmetric); return s; }
inline symmetry sy_anti(const symmetry &c1, const symmetry &c2) { return symmetry(symmetry::antisymmetric, c1, c2); }
inline symmetry sy_anti(const symmetry &c1, const symmetry &c2, const symmetry &c3) { return symmetry(symmetry::antisymmetric, c1, c2).add(c3); }
inline symmetry sy_anti(const symmetry &c1, const symmetry &c2, const symmetry &c3, const symmetry &c4) { return symmetry(symmetry::antisymmetric, c1, c2).add(c3).add(c4); }
-inline symmetry sy_cycl(void) { symmetry s; s.set_type(symmetry::cyclic); return s; }
+inline symmetry sy_cycl() { symmetry s; s.set_type(symmetry::cyclic); return s; }
inline symmetry sy_cycl(const symmetry &c1, const symmetry &c2) { return symmetry(symmetry::cyclic, c1, c2); }
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). */
} // namespace GiNaC
-#endif // ndef __GINAC_SYMMETRY_H__
+#endif // ndef GINAC_SYMMETRY_H
git://www.ginac.de / ginac.git / blobdiff