03b9d8d3ebd6164ea6664cc9d1aab2c3d488248f
[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-2001 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21  */
22
23 #ifndef __GINAC_COLOR_H__
24 #define __GINAC_COLOR_H__
25
26 #include "indexed.h"
27 #include "tensor.h"
28
29 namespace GiNaC {
30
31
32 /** This class holds a generator T_a or the unity element of the Lie algebra
33  *  of SU(3), as used for calculations in quantum chromodynamics. A
34  *  representation label (an unsigned 8-bit integer) is used to distinguish
35  *  elements from different Lie algebras (objects with different labels
36  *  commute). These objects implement an abstract representation of the
37  *  group, not a specific matrix representation. The indices used for color
38  *  objects should not have a variance. */
39 class color : public indexed
40 {
41         GINAC_DECLARE_REGISTERED_CLASS(color, indexed)
42
43         // other constructors
44 public:
45         color(const ex & b, unsigned char rl = 0);
46         color(const ex & b, const ex & i1, unsigned char rl = 0);
47
48         // internal constructors
49         color(unsigned char rl, const exvector & v, bool discardable = false);
50         color(unsigned char rl, exvector * vp); // vp will be deleted
51
52         // functions overriding virtual functions from base classes
53 protected:
54         bool match_same_type(const basic & other) const;
55         ex simplify_ncmul(const exvector & v) const;
56         ex thisexprseq(const exvector & v) const;
57         ex thisexprseq(exvector * vp) const;
58         unsigned return_type(void) const { return return_types::noncommutative; }
59         unsigned return_type_tinfo(void) const { return TINFO_color + representation_label; }
60
61         // non-virtual functions in this class
62 public:
63         unsigned char get_representation_label(void) const {return representation_label;}
64
65         // member variables
66 private:
67         unsigned char representation_label; /**< Representation label to distinguish independent color matrices coming from separated fermion lines */
68 };
69
70
71 /** This class represents the su(3) unity element. */
72 class su3one : public tensor
73 {
74         GINAC_DECLARE_REGISTERED_CLASS(su3one, tensor)
75
76         // functions overriding virtual functions from base classes
77 public:
78         void print(const print_context & c, unsigned level = 0) const;
79 };
80
81 /** This class represents an su(3) generator. */
82 class su3t : public tensor
83 {
84         GINAC_DECLARE_REGISTERED_CLASS(su3t, tensor)
85
86         // functions overriding virtual functions from base classes
87 public:
88         void print(const print_context & c, unsigned level = 0) const;
89         bool contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const;
90 };
91
92 /** This class represents the tensor of antisymmetric su(3) structure
93  *  constants. */
94 class su3f : public tensor
95 {
96         GINAC_DECLARE_REGISTERED_CLASS(su3f, tensor)
97
98         // functions overriding virtual functions from base classes
99 public:
100         void print(const print_context & c, unsigned level = 0) const;
101         ex eval_indexed(const basic & i) const;
102         bool contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const;
103 };
104
105 /** This class represents the tensor of symmetric su(3) structure constants. */
106 class su3d : public tensor
107 {
108         GINAC_DECLARE_REGISTERED_CLASS(su3d, tensor)
109
110         // functions overriding virtual functions from base classes
111 public:
112         void print(const print_context & c, unsigned level = 0) const;
113         ex eval_indexed(const basic & i) const;
114         bool contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const;
115 };
116
117
118 // global functions
119
120 /** Return the color object handled by an ex.  Deprecated: use ex_to<color>().
121  *  This is unsafe: you need to check the type first. */
122 inline const color &ex_to_color(const ex &e)
123 {
124         return static_cast<const color &>(*e.bp);
125 }
126
127 /** Specialization of is_exactly_a<color>(obj) for color objects. */
128 template<> inline bool is_exactly_a<color>(const basic & obj)
129 {
130         return obj.tinfo()==TINFO_color;
131 }
132
133 /** Create the su(3) unity element. This is an indexed object, although it
134  *  has no indices.
135  *
136  *  @param rl Representation label
137  *  @return newly constructed unity element */
138 ex color_ONE(unsigned char rl = 0);
139
140 /** Create an su(3) generator.
141  *
142  *  @param a Index
143  *  @param rl Representation label
144  *  @return newly constructed unity generator */
145 ex color_T(const ex & a, unsigned char rl = 0);
146
147 /** Create an su(3) antisymmetric structure constant.
148  *
149  *  @param a First index
150  *  @param b Second index
151  *  @param c Third index
152  *  @return newly constructed structure constant */
153 ex color_f(const ex & a, const ex & b, const ex & c);
154
155 /** Create an su(3) symmetric structure constant.
156  *
157  *  @param a First index
158  *  @param b Second index
159  *  @param c Third index
160  *  @return newly constructed structure constant */
161 ex color_d(const ex & a, const ex & b, const ex & c);
162
163 /** This returns the linear combination d.a.b.c+I*f.a.b.c. */
164 ex color_h(const ex & a, const ex & b, const ex & c);
165
166 /** Calculate the trace of an expression containing color objects with a
167  *  specified representation label.
168  *
169  *  @param e Expression to take the trace of
170  *  @param rl Representation label */
171 ex color_trace(const ex & e, unsigned char rl = 0);
172
173
174 } // namespace GiNaC
175
176 #endif // ndef __GINAC_COLOR_H__