- added documentation to the indexed, color, lortensor and clifford classes
[ginac.git] / ginac / clifford.h
1 /** @file clifford.h
2  *
3  *  Interface to GiNaC's clifford 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 <string>
27 #include "lortensor.h"
28
29 #ifndef NO_NAMESPACE_GINAC
30 namespace GiNaC {
31 #endif // ndef NO_NAMESPACE_GINAC
32
33
34 /** This class holds an object representing an element of the Clifford
35  *  algebra (the Dirac gamma matrices). These objects only carry Lorentz
36  *  indices. Spinor indices are always hidden in our implementation. */
37 class clifford : public lortensor
38 {
39         GINAC_DECLARE_REGISTERED_CLASS(clifford, lortensor)
40
41 // friends
42
43         friend clifford clifford_gamma(const ex & mu);
44
45 // member functions
46
47         // default constructor, destructor, copy constructor assignment operator and helpers
48 public:
49         clifford();
50         ~clifford();
51         clifford(const clifford & other);
52         const clifford & operator=(const clifford & other);
53 protected:
54         void copy(const clifford & other); 
55         void destroy(bool call_parent);
56
57         // other constructors
58 public:
59         clifford(const std::string & n, const ex & mu);
60
61         // functions overriding virtual functions from base classes
62 public:
63         basic * duplicate() const;
64         void printraw(std::ostream & os) const;
65         void printtree(std::ostream & os, unsigned indent) const;
66         void print(std::ostream & os, unsigned upper_precedence=0) const;
67         bool info(unsigned inf) const;
68         // ex eval(int level=0) const;
69 protected:
70         int compare_same_type(const basic & other) const;
71         bool is_equal_same_type(const basic & other) const;
72         ex simplify_ncmul(const exvector & v) const;
73         ex thisexprseq(const exvector & v) const;
74         ex thisexprseq(exvector * vp) const;
75
76         // new virtual functions which can be overridden by derived classes
77         // none
78         
79         // non-virtual functions in this class
80         // none
81
82         // member variables
83         // none
84 };
85
86 // global constants
87
88 extern const clifford some_clifford;
89 extern const std::type_info & typeid_clifford;
90
91 // global functions
92 inline const clifford &ex_to_clifford(const ex &e)
93 {
94         return static_cast<const clifford &>(*e.bp);
95 }
96
97 clifford clifford_gamma(const ex & mu);
98
99 #ifndef NO_NAMESPACE_GINAC
100 } // namespace GiNaC
101 #endif // ndef NO_NAMESPACE_GINAC
102
103 #endif // ndef __GINAC_CLIFFORD_H__