- added documentation for the idx, coloridx and lorentzidx classes
[ginac.git] / ginac / lorentzidx.h
1 /** @file lorentzidx.h
2  *
3  *  Interface to GiNaC's lorentz indices. */
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_LORENTZIDX_H__
24 #define __GINAC_LORENTZIDX_H__
25
26 #include <string>
27 #include <vector>
28 #include "idx.h"
29
30 #ifndef NO_NAMESPACE_GINAC
31 namespace GiNaC {
32 #endif // ndef NO_NAMESPACE_GINAC
33
34 /** Class of indices for Lorentz tensors, to tell them apart from other index
35  *  families like color indices. The indices of this class also support the
36  *  case of P-O-decomposed D-dimensional spacetime, where the parallel space
37  *  is a Minkowski-like space with integral dimension P and the orthogonal
38  *  space is a Euclidean space with (possibly complex) dimension D-P. */
39 class lorentzidx : public idx
40 {
41         GINAC_DECLARE_REGISTERED_CLASS(lorentzidx, idx)
42
43         friend class simp_lor;
44         friend class scalar_products;
45
46 // member functions
47
48         // default constructor, destructor, copy constructor assignment operator and helpers
49 public:
50         lorentzidx();
51         ~lorentzidx();
52         lorentzidx (const lorentzidx & other);
53         const lorentzidx & operator=(const lorentzidx & other);
54 protected:
55         void copy(const lorentzidx & other);
56         void destroy(bool call_parent);
57
58         // other constructors
59 public:
60         explicit lorentzidx(bool cov, bool oonly=false, unsigned dimp=0);
61         explicit lorentzidx(const std::string & n, bool cov=false,
62                             bool oonly=false, unsigned dimp=0);
63         explicit lorentzidx(const char * n, bool cov=false,
64                             bool oonly=false, unsigned dimp=0);
65         explicit lorentzidx(unsigned v, bool cov=false);
66
67         // functions overriding virtual functions from bases classes
68 public:
69         basic * duplicate() const;
70         void printraw(std::ostream & os) const;
71         void printtree(std::ostream & os, unsigned indent) const;
72         void print(std::ostream & os, unsigned upper_precedence=0) const;
73         bool info(unsigned inf) const;
74
75         // new virtual functions which can be overridden by derived classes
76         // none
77
78         // non-virtual functions in this class
79 public:
80         /** Check whether index only lives in orthogonal space. */
81         bool is_orthogonal_only(void) const {return orthogonal_only;}
82
83         /** Return dimension of parallel space. */
84         unsigned get_dim_parallel_space(void) const {return dim_parallel_space;}
85
86         lorentzidx create_anonymous_representative(void) const; 
87
88         // member variables
89 protected:
90         bool orthogonal_only;        /**< Symbolic index only lives in orthogonal space? */
91         unsigned dim_parallel_space; /**< Dimension of parallel space */
92 };
93
94 // global constants
95
96 extern const lorentzidx some_lorentzidx;
97 extern const std::type_info & typeid_lorentzidx;
98
99 // utility functions
100 inline const lorentzidx &ex_to_lorentzidx(const ex &e)
101 {
102         return static_cast<const lorentzidx &>(*e.bp);
103 }
104
105 #ifndef NO_NAMESPACE_GINAC
106 } // namespace GiNaC
107 #endif // ndef NO_NAMESPACE_GINAC
108
109 #endif // ndef __GINAC_LORENTZIDX_H__