use new-style print methods
[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-2003 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         ex eval_ncmul(const exvector & v) const;
55         bool match_same_type(const basic & other) const;
56         ex thiscontainer(const exvector & v) const;
57         ex thiscontainer(exvector * vp) const;
58         unsigned return_type() const { return return_types::noncommutative; }
59         unsigned return_type_tinfo() const { return TINFO_color + representation_label; }
60
61         // non-virtual functions in this class
62 public:
63         unsigned char get_representation_label() 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         // non-virtual functions in this class
77 protected:
78         void do_print(const print_context & c, unsigned level) const;
79         void do_print_latex(const print_latex & c, unsigned level) const;
80 };
81
82 /** This class represents an su(3) generator. */
83 class su3t : public tensor
84 {
85         GINAC_DECLARE_REGISTERED_CLASS(su3t, tensor)
86
87         // functions overriding virtual functions from base classes
88 public:
89         bool contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const;
90
91         // non-virtual functions in this class
92 protected:
93         void do_print(const print_context & c, unsigned level) const;
94         void do_print_latex(const print_latex & c, unsigned level) const;
95 };
96
97 /** This class represents the tensor of antisymmetric su(3) structure
98  *  constants. */
99 class su3f : public tensor
100 {
101         GINAC_DECLARE_REGISTERED_CLASS(su3f, tensor)
102
103         // functions overriding virtual functions from base classes
104 public:
105         ex eval_indexed(const basic & i) const;
106         bool contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const;
107
108         // non-virtual functions in this class
109 protected:
110         void do_print(const print_context & c, unsigned level) const;
111         void do_print_latex(const print_latex & c, unsigned level) const;
112 };
113
114 /** This class represents the tensor of symmetric su(3) structure constants. */
115 class su3d : public tensor
116 {
117         GINAC_DECLARE_REGISTERED_CLASS(su3d, tensor)
118
119         // functions overriding virtual functions from base classes
120 public:
121         ex eval_indexed(const basic & i) const;
122         bool contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const;
123
124         // non-virtual functions in this class
125 protected:
126         void do_print(const print_context & c, unsigned level) const;
127         void do_print_latex(const print_latex & c, unsigned level) const;
128 };
129
130
131 // global functions
132
133 /** Specialization of is_exactly_a<color>(obj) for color objects. */
134 template<> inline bool is_exactly_a<color>(const basic & obj)
135 {
136         return obj.tinfo()==TINFO_color;
137 }
138
139 /** Create the su(3) unity element. This is an indexed object, although it
140  *  has no indices.
141  *
142  *  @param rl Representation label
143  *  @return newly constructed unity element */
144 ex color_ONE(unsigned char rl = 0);
145
146 /** Create an su(3) generator.
147  *
148  *  @param a Index
149  *  @param rl Representation label
150  *  @return newly constructed unity generator */
151 ex color_T(const ex & a, unsigned char rl = 0);
152
153 /** Create an su(3) antisymmetric structure constant.
154  *
155  *  @param a First index
156  *  @param b Second index
157  *  @param c Third index
158  *  @return newly constructed structure constant */
159 ex color_f(const ex & a, const ex & b, const ex & c);
160
161 /** Create an su(3) symmetric structure constant.
162  *
163  *  @param a First index
164  *  @param b Second index
165  *  @param c Third index
166  *  @return newly constructed structure constant */
167 ex color_d(const ex & a, const ex & b, const ex & c);
168
169 /** This returns the linear combination d.a.b.c+I*f.a.b.c. */
170 ex color_h(const ex & a, const ex & b, const ex & c);
171
172 /** Calculate the trace of an expression containing color objects with a
173  *  specified representation label.
174  *
175  *  @param e Expression to take the trace of
176  *  @param rl Representation label */
177 ex color_trace(const ex & e, unsigned char rl = 0);
178
179
180 } // namespace GiNaC
181
182 #endif // ndef __GINAC_COLOR_H__