- dirac_trace() handles arbitrary expressions (even unexpanded), including
[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-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_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 protected:
52         ex simplify_ncmul(const exvector & v) const;
53         ex thisexprseq(const exvector & v) const;
54         ex thisexprseq(exvector * vp) const;
55         unsigned return_type(void) const { return return_types::noncommutative; }
56         unsigned return_type_tinfo(void) const { return TINFO_clifford + representation_label; }
57
58         // non-virtual functions in this class
59 public:
60         unsigned char get_representation_label(void) const {return representation_label;}
61
62         // member variables
63 private:
64         unsigned char representation_label; /**< Representation label to distinguish independent spin lines */
65 };
66
67
68 /** This class represents the Clifford algebra unity element. */
69 class diracone : public tensor
70 {
71         GINAC_DECLARE_REGISTERED_CLASS(diracone, tensor)
72
73         // functions overriding virtual functions from bases classes
74 public:
75         void print(const print_context & c, unsigned level = 0) const;
76 };
77
78
79 /** This class represents the Dirac gamma Lorentz vector. */
80 class diracgamma : public tensor
81 {
82         GINAC_DECLARE_REGISTERED_CLASS(diracgamma, tensor)
83
84         // functions overriding virtual functions from bases classes
85 public:
86         void print(const print_context & c, unsigned level = 0) const;
87         bool contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const;
88 };
89
90
91 /** This class represents the Dirac gamma5 object which anticommutes with
92  *  all other gammas. */
93 class diracgamma5 : public tensor
94 {
95         GINAC_DECLARE_REGISTERED_CLASS(diracgamma5, tensor)
96
97         // functions overriding virtual functions from bases classes
98 public:
99         void print(const print_context & c, unsigned level = 0) const;
100 };
101
102
103 // global functions
104 inline const clifford &ex_to_clifford(const ex &e)
105 {
106         return static_cast<const clifford &>(*e.bp);
107 }
108
109
110 /** Create a Clifford unity object.
111  *
112  *  @param rl Representation label
113  *  @return newly constructed object */
114 ex dirac_ONE(unsigned char rl = 0);
115
116 /** Create a Dirac gamma object.
117  *
118  *  @param mu Index (must be of class varidx or a derived class)
119  *  @param rl Representation label
120  *  @return newly constructed gamma object */
121 ex dirac_gamma(const ex & mu, unsigned char rl = 0);
122
123 /** Create a Dirac gamma5 object.
124  *
125  *  @param rl Representation label
126  *  @return newly constructed object */
127 ex dirac_gamma5(unsigned char rl = 0);
128
129 /** Create a term of the form e_mu * gamma~mu with a unique index mu.
130  *
131  *  @param dim Dimension of index
132  *  @param rl Representation label */
133 ex dirac_slash(const ex & e, const ex & dim, unsigned char rl = 0);
134
135 /** Calculate the trace of an expression containing gamma objects with
136  *  a specified representation label. The computed trace is a linear
137  *  functional that is equal to the usual trace only in D = 4 dimensions.
138  *  In particular, the functional is not always cyclic in D != 4 dimensions
139  *  when gamma5 is involved.
140  *
141  *  @param rl Representation label */
142 ex dirac_trace(const ex & e, unsigned char rl = 0);
143
144
145 } // namespace GiNaC
146
147 #endif // ndef __GINAC_CLIFFORD_H__