GINAC_DECLARE_REGISTERED_CLASS declares duplicate() and compare_same_type(),
[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         // other constructors
46 public:
47         clifford(const std::string & n, const ex & mu);
48         clifford(const std::string & n, const exvector & iv);
49         clifford(const std::string & n, exvector * ivp);
50
51         // functions overriding virtual functions from base classes
52 public:
53         void printraw(std::ostream & os) const;
54         void printtree(std::ostream & os, unsigned indent) const;
55         void print(std::ostream & os, unsigned upper_precedence=0) const;
56         bool info(unsigned inf) const;
57         // ex eval(int level=0) const;
58 protected:
59         bool is_equal_same_type(const basic & other) const;
60         ex simplify_ncmul(const exvector & v) const;
61         ex thisexprseq(const exvector & v) const;
62         ex thisexprseq(exvector * vp) const;
63
64         // new virtual functions which can be overridden by derived classes
65         // none
66         
67         // non-virtual functions in this class
68         // none
69
70         // member variables
71         // none
72 };
73
74 // global functions
75 inline const clifford &ex_to_clifford(const ex &e)
76 {
77         return static_cast<const clifford &>(*e.bp);
78 }
79
80 clifford clifford_gamma(const ex & mu);
81
82 #ifndef NO_NAMESPACE_GINAC
83 } // namespace GiNaC
84 #endif // ndef NO_NAMESPACE_GINAC
85
86 #endif // ndef __GINAC_CLIFFORD_H__