A better return_type_tinfo() mechanism.
[ginac.git] / ginac / color.h
1 /** @file color.h
2  *
3  *  Interface to GiNaC's color (SU(3) Lie algebra) objects. */
4
5 /*
6  *  GiNaC Copyright (C) 1999-2008 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_COLOR_H__
24 #define __GINAC_COLOR_H__
25
26 #include "indexed.h"
27 #include "tensor.h"
28
29 #include <set>
30
31 namespace GiNaC {
32
33
34 /** This class holds a generator T_a or the unity element of the Lie algebra
35  *  of SU(3), as used for calculations in quantum chromodynamics. A
36  *  representation label (an unsigned 8-bit integer) is used to distinguish
37  *  elements from different Lie algebras (objects with different labels
38  *  commutate). These objects implement an abstract representation of the
39  *  group, not a specific matrix representation. The indices used for color
40  *  objects should not have a variance. */
41 class color : public indexed
42 {
43         GINAC_DECLARE_REGISTERED_CLASS(color, indexed)
44         // other constructors
45 public:
46         color(const ex & b, unsigned char rl = 0);
47         color(const ex & b, const ex & i1, unsigned char rl = 0);
48
49         // internal constructors
50         color(unsigned char rl, const exvector & v, bool discardable = false);
51         color(unsigned char rl, std::auto_ptr<exvector> vp);
52
53         // functions overriding virtual functions from base classes
54 protected:
55         ex eval_ncmul(const exvector & v) const;
56         bool match_same_type(const basic & other) const;
57         ex thiscontainer(const exvector & v) const;
58         ex thiscontainer(std::auto_ptr<exvector> vp) const;
59         unsigned return_type() const { return return_types::noncommutative; }
60         return_type_t return_type_tinfo() const;
61
62         // non-virtual functions in this class
63 public:
64         unsigned char get_representation_label() const {return representation_label;}
65
66         // member variables
67 private:
68         unsigned char representation_label; /**< Representation label to distinguish independent color matrices coming from separated fermion lines */
69 };
70
71
72 /** This class represents the su(3) unity element. */
73 class su3one : public tensor
74 {
75         GINAC_DECLARE_REGISTERED_CLASS(su3one, tensor)
76
77         // non-virtual functions in this class
78 protected:
79         void do_print(const print_context & c, unsigned level) const;
80         void do_print_latex(const print_latex & c, unsigned level) const;
81 };
82
83 /** This class represents an su(3) generator. */
84 class su3t : public tensor
85 {
86         GINAC_DECLARE_REGISTERED_CLASS(su3t, tensor)
87
88         // functions overriding virtual functions from base classes
89 public:
90         bool contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const;
91
92         // non-virtual functions in this class
93 protected:
94         void do_print(const print_context & c, unsigned level) const;
95         void do_print_latex(const print_latex & c, unsigned level) const;
96 };
97
98 /** This class represents the tensor of antisymmetric su(3) structure
99  *  constants. */
100 class su3f : public tensor
101 {
102         GINAC_DECLARE_REGISTERED_CLASS(su3f, tensor)
103
104         // functions overriding virtual functions from base classes
105 public:
106         ex eval_indexed(const basic & i) const;
107         bool contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const;
108
109         // non-virtual functions in this class
110 protected:
111         unsigned return_type() const { return return_types::commutative; }
112         void do_print(const print_context & c, unsigned level) const;
113         void do_print_latex(const print_latex & c, unsigned level) const;
114 };
115
116 /** This class represents the tensor of symmetric su(3) structure constants. */
117 class su3d : public tensor
118 {
119         GINAC_DECLARE_REGISTERED_CLASS(su3d, tensor)
120
121         // functions overriding virtual functions from base classes
122 public:
123         ex eval_indexed(const basic & i) const;
124         bool contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const;
125
126         // non-virtual functions in this class
127 protected:
128         unsigned return_type() const { return return_types::commutative; }
129         void do_print(const print_context & c, unsigned level) const;
130         void do_print_latex(const print_latex & c, unsigned level) const;
131 };
132
133
134 // global functions
135
136 /** Create the su(3) unity element. This is an indexed object, although it
137  *  has no indices.
138  *
139  *  @param rl Representation label
140  *  @return newly constructed unity element */
141 ex color_ONE(unsigned char rl = 0);
142
143 /** Create an su(3) generator.
144  *
145  *  @param a Index
146  *  @param rl Representation label
147  *  @return newly constructed unity generator */
148 ex color_T(const ex & a, unsigned char rl = 0);
149
150 /** Create an su(3) antisymmetric structure constant.
151  *
152  *  @param a First index
153  *  @param b Second index
154  *  @param c Third index
155  *  @return newly constructed structure constant */
156 ex color_f(const ex & a, const ex & b, const ex & c);
157
158 /** Create an su(3) symmetric structure constant.
159  *
160  *  @param a First index
161  *  @param b Second index
162  *  @param c Third index
163  *  @return newly constructed structure constant */
164 ex color_d(const ex & a, const ex & b, const ex & c);
165
166 /** This returns the linear combination d.a.b.c+I*f.a.b.c. */
167 ex color_h(const ex & a, const ex & b, const ex & c);
168
169 /** Calculate color traces over the specified set of representation labels.
170  *
171  *  @param e Expression to take the trace of
172  *  @param rls Set of representation labels */
173 ex color_trace(const ex & e, const std::set<unsigned char> & rls);
174
175 /** Calculate color traces over the specified list of representation labels.
176  *
177  *  @param e Expression to take the trace of
178  *  @param rll List of representation labels */
179 ex color_trace(const ex & e, const lst & rll);
180
181 /** Calculate the trace of an expression containing color objects with a
182  *  specified representation label.
183  *
184  *  @param e Expression to take the trace of
185  *  @param rl Representation label */
186 ex color_trace(const ex & e, unsigned char rl = 0);
187
188
189 } // namespace GiNaC
190
191 #endif // ndef __GINAC_COLOR_H__