Update copyright statements.
[ginac.git] / ginac / symmetry.h
1 /** @file symmetry.h
2  *
3  *  Interface to GiNaC's symmetry definitions. */
4
5 /*
6  *  GiNaC Copyright (C) 1999-2014 Johannes Gutenberg University Mainz, Germany
7  *
8  *  This program is free software; you can redistribute it and/or modify
9  *  it under the terms of the GNU General Public License as published by
10  *  the Free Software Foundation; either version 2 of the License, or
11  *  (at your option) any later version.
12  *
13  *  This program is distributed in the hope that it will be useful,
14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  *  GNU General Public License for more details.
17  *
18  *  You should have received a copy of the GNU General Public License
19  *  along with this program; if not, write to the Free Software
20  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
21  */
22
23 #ifndef GINAC_SYMMETRY_H
24 #define GINAC_SYMMETRY_H
25
26 #include "ex.h"
27 #include "archive.h"
28
29 #include <set>
30
31 namespace GiNaC {
32
33 class sy_is_less;
34 class sy_swap;
35
36 /** This class describes the symmetry of a group of indices. These objects
37  *  can be grouped into a tree to form complex mixed symmetries. */
38 class symmetry : public basic
39 {
40         friend class sy_is_less;
41         friend class sy_swap;
42         friend int canonicalize(exvector::iterator v, const symmetry &symm);
43
44         GINAC_DECLARE_REGISTERED_CLASS(symmetry, basic)
45
46         // types
47 public:
48         /** Type of symmetry */
49         typedef enum {
50                 none,          /**< no symmetry properties */
51                 symmetric,     /**< totally symmetric */
52                 antisymmetric, /**< totally antisymmetric */
53                 cyclic         /**< cyclic symmetry */
54         } symmetry_type;
55
56         // other constructors
57 public:
58         /** Create leaf node that represents one index. */
59         symmetry(unsigned i);
60
61         /** Create node with two children. */
62         symmetry(symmetry_type t, const symmetry &c1, const symmetry &c2);
63
64         // non-virtual functions in this class
65 public:
66         /** Get symmetry type. */
67         symmetry_type get_type() const {return type;}
68
69         /** Set symmetry type. */
70         void set_type(symmetry_type t) {type = t;}
71
72         /** Add child node, check index sets for consistency. */
73         symmetry &add(const symmetry &c);
74
75         /** Verify that all indices of this node are in the range [0..n-1].
76          *  This function throws an exception if the verification fails.
77          *  If the top node has a type != none and no children, add all indices
78          *  in the range [0..n-1] as children. */
79         void validate(unsigned n);
80
81         /** Check whether this node actually represents any kind of symmetry. */
82         bool has_symmetry() const {return type != none || !children.empty(); }
83         /** Check whether this node involves anything non symmetric. */
84         bool has_nonsymmetric() const;
85         /** Check whether this node involves a cyclic symmetry. */
86         bool has_cyclic() const;
87
88         /** Save (a.k.a. serialize) object into archive. */
89         void archive(archive_node& n) const;
90         /** Read (a.k.a. deserialize) object from archive. */
91         void read_archive(const archive_node& n, lst& syms);
92 protected:
93         void do_print(const print_context & c, unsigned level) const;
94         void do_print_tree(const print_tree & c, unsigned level) const;
95         unsigned calchash() const;
96
97         // member variables
98 private:
99         /** Type of symmetry described by this node. */
100         symmetry_type type;
101
102         /** Sorted union set of all indices handled by this node. */
103         std::set<unsigned> indices;
104
105         /** Vector of child nodes. */
106         exvector children;
107 };
108 GINAC_DECLARE_UNARCHIVER(symmetry); 
109
110
111 // global functions
112
113 inline symmetry sy_none() { return symmetry(); }
114 inline symmetry sy_none(const symmetry &c1, const symmetry &c2) { return symmetry(symmetry::none, c1, c2); }
115 inline symmetry sy_none(const symmetry &c1, const symmetry &c2, const symmetry &c3) { return symmetry(symmetry::none, c1, c2).add(c3); }
116 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); }
117
118 inline symmetry sy_symm() { symmetry s; s.set_type(symmetry::symmetric); return s; }
119 inline symmetry sy_symm(const symmetry &c1, const symmetry &c2) { return symmetry(symmetry::symmetric, c1, c2); }
120 inline symmetry sy_symm(const symmetry &c1, const symmetry &c2, const symmetry &c3) { return symmetry(symmetry::symmetric, c1, c2).add(c3); }
121 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); }
122
123 inline symmetry sy_anti() { symmetry s; s.set_type(symmetry::antisymmetric); return s; }
124 inline symmetry sy_anti(const symmetry &c1, const symmetry &c2) { return symmetry(symmetry::antisymmetric, c1, c2); }
125 inline symmetry sy_anti(const symmetry &c1, const symmetry &c2, const symmetry &c3) { return symmetry(symmetry::antisymmetric, c1, c2).add(c3); }
126 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); }
127
128 inline symmetry sy_cycl() { symmetry s; s.set_type(symmetry::cyclic); return s; }
129 inline symmetry sy_cycl(const symmetry &c1, const symmetry &c2) { return symmetry(symmetry::cyclic, c1, c2); }
130 inline symmetry sy_cycl(const symmetry &c1, const symmetry &c2, const symmetry &c3) { return symmetry(symmetry::cyclic, c1, c2).add(c3); }
131 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); }
132
133 // These return references to preallocated common symmetries (similar to
134 // the numeric flyweights).
135 const symmetry & not_symmetric();
136 const symmetry & symmetric2();
137 const symmetry & symmetric3();
138 const symmetry & symmetric4();
139 const symmetry & antisymmetric2();
140 const symmetry & antisymmetric3();
141 const symmetry & antisymmetric4();
142
143 /** Canonicalize the order of elements of an expression vector, according to
144  *  the symmetry properties defined in a symmetry tree.
145  *
146  *  @param v Start of expression vector
147  *  @param symm Root node of symmetry tree
148  *  @return the overall sign introduced by the reordering (+1, -1 or 0)
149  *          or numeric_limits<int>::max() if nothing changed */
150 extern int canonicalize(exvector::iterator v, const symmetry &symm);
151
152 /** Symmetrize expression over a set of objects (symbols, indices). */
153 ex symmetrize(const ex & e, exvector::const_iterator first, exvector::const_iterator last);
154
155 /** Symmetrize expression over a set of objects (symbols, indices). */
156 inline ex symmetrize(const ex & e, const exvector & v)
157 {
158         return symmetrize(e, v.begin(), v.end());
159 }
160
161 /** Antisymmetrize expression over a set of objects (symbols, indices). */
162 ex antisymmetrize(const ex & e, exvector::const_iterator first, exvector::const_iterator last);
163
164 /** Antisymmetrize expression over a set of objects (symbols, indices). */
165 inline ex antisymmetrize(const ex & e, const exvector & v)
166 {
167         return antisymmetrize(e, v.begin(), v.end());
168 }
169
170 /** Symmetrize expression by cyclic permuation over a set of objects
171  *  (symbols, indices). */
172 ex symmetrize_cyclic(const ex & e, exvector::const_iterator first, exvector::const_iterator last);
173
174 /** Symmetrize expression by cyclic permutation over a set of objects
175  *  (symbols, indices). */
176 inline ex symmetrize_cyclic(const ex & e, const exvector & v)
177 {
178         return symmetrize(e, v.begin(), v.end());
179 }
180
181 } // namespace GiNaC
182
183 #endif // ndef GINAC_SYMMETRY_H