merging 1.2 branch into main trunk
[ginac.git] / ginac / clifford.h
1 /** @file clifford.h
2  *
3  *  Interface to GiNaC's clifford algebra (Dirac gamma) 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_CLIFFORD_H__
24 #define __GINAC_CLIFFORD_H__
25
26 #include "indexed.h"
27 #include "tensor.h"
28
29 namespace GiNaC {
30
31
32 /** This class holds an object representing an element of the Clifford
33  *  algebra (the Dirac gamma matrices). These objects only carry Lorentz
34  *  indices. Spinor indices are hidden. A representation label (an unsigned
35  *  8-bit integer) is used to distinguish elements from different Clifford
36  *  algebras (objects with different labels commute). */
37 class clifford : public indexed
38 {
39         GINAC_DECLARE_REGISTERED_CLASS(clifford, indexed)
40
41         // other constructors
42 public:
43         clifford(const ex & b, unsigned char rl = 0);
44         clifford(const ex & b, const ex & mu, unsigned char rl = 0);
45
46         // internal constructors
47         clifford(unsigned char rl, const exvector & v, bool discardable = false);
48         clifford(unsigned char rl, exvector * vp); // vp will be deleted
49
50         // functions overriding virtual functions from base classes
51 public:
52         void print(const print_context & c, unsigned level = 0) const;
53
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(exvector * vp) const;
59         unsigned return_type() const { return return_types::noncommutative; }
60         unsigned return_type_tinfo() const { return TINFO_clifford + representation_label; }
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 spin lines */
69 };
70
71
72 /** This class represents the Clifford algebra unity element. */
73 class diracone : public tensor
74 {
75         GINAC_DECLARE_REGISTERED_CLASS(diracone, tensor)
76
77         // functions overriding virtual functions from base classes
78 public:
79         void print(const print_context & c, unsigned level = 0) const;
80 };
81
82
83 /** This class represents the Dirac gamma Lorentz vector. */
84 class diracgamma : public tensor
85 {
86         GINAC_DECLARE_REGISTERED_CLASS(diracgamma, tensor)
87
88         // functions overriding virtual functions from base classes
89 public:
90         void print(const print_context & c, unsigned level = 0) const;
91         bool contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const;
92 };
93
94
95 /** This class represents the Dirac gamma5 object which anticommutes with
96  *  all other gammas. */
97 class diracgamma5 : public tensor
98 {
99         GINAC_DECLARE_REGISTERED_CLASS(diracgamma5, tensor)
100
101         // functions overriding virtual functions from base classes
102 public:
103         void print(const print_context & c, unsigned level = 0) const;
104 };
105
106
107 /** This class represents the Dirac gammaL object which behaves like
108  *  1/2 (1-gamma5). */
109 class diracgammaL : public tensor
110 {
111         GINAC_DECLARE_REGISTERED_CLASS(diracgammaL, tensor)
112
113         // functions overriding virtual functions from base classes
114 public:
115         void print(const print_context & c, unsigned level = 0) const;
116 };
117
118
119 /** This class represents the Dirac gammaL object which behaves like
120  *  1/2 (1+gamma5). */
121 class diracgammaR : public tensor
122 {
123         GINAC_DECLARE_REGISTERED_CLASS(diracgammaR, tensor)
124
125         // functions overriding virtual functions from base classes
126 public:
127         void print(const print_context & c, unsigned level = 0) const;
128 };
129
130
131 // global functions
132
133 /** Specialization of is_exactly_a<clifford>(obj) for clifford objects. */
134 template<> inline bool is_exactly_a<clifford>(const basic & obj)
135 {
136         return obj.tinfo()==TINFO_clifford;
137 }
138
139 /** Create a Clifford unity object.
140  *
141  *  @param rl Representation label
142  *  @return newly constructed object */
143 ex dirac_ONE(unsigned char rl = 0);
144
145 /** Create a Dirac gamma object.
146  *
147  *  @param mu Index (must be of class varidx or a derived class)
148  *  @param rl Representation label
149  *  @return newly constructed gamma object */
150 ex dirac_gamma(const ex & mu, unsigned char rl = 0);
151
152 /** Create a Dirac gamma5 object.
153  *
154  *  @param rl Representation label
155  *  @return newly constructed object */
156 ex dirac_gamma5(unsigned char rl = 0);
157
158 /** Create a Dirac gammaL object.
159  *
160  *  @param rl Representation label
161  *  @return newly constructed object */
162 ex dirac_gammaL(unsigned char rl = 0);
163
164 /** Create a Dirac gammaR object.
165  *
166  *  @param rl Representation label
167  *  @return newly constructed object */
168 ex dirac_gammaR(unsigned char rl = 0);
169
170 /** Create a term of the form e_mu * gamma~mu with a unique index mu.
171  *
172  *  @param dim Dimension of index
173  *  @param rl Representation label */
174 ex dirac_slash(const ex & e, const ex & dim, unsigned char rl = 0);
175
176 /** Calculate the trace of an expression containing gamma objects with
177  *  a specified representation label. The computed trace is a linear
178  *  functional that is equal to the usual trace only in D = 4 dimensions.
179  *  In particular, the functional is not always cyclic in D != 4 dimensions
180  *  when gamma5 is involved.
181  *
182  *  @param e Expression to take the trace of
183  *  @param rl Representation label
184  *  @param trONE Expression to be returned as the trace of the unit matrix */
185 ex dirac_trace(const ex & e, unsigned char rl = 0, const ex & trONE = 4);
186
187 /** Bring all products of clifford objects in an expression into a canonical
188  *  order. This is not necessarily the most simple form but it will allow
189  *  to check two expressions for equality. */
190 ex canonicalize_clifford(const ex & e);
191
192 } // namespace GiNaC
193
194 #endif // ndef __GINAC_CLIFFORD_H__