* New funny timing added: compute an antipode in Yukawa theory.
[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 namespace GiNaC {
31
32
33 /** Class of indices for Lorentz tensors, to tell them apart from other
34  *  index families like color indices. The indices of this class also
35  *  support the case of P-O-decomposed D-dimensional spacetime, where the
36  *  parallel space is a Minkowski space with integral dimension P and the
37  *  orthogonal space is a Euclidean space with (possibly complex) dimension
38  *  D-P. The dimension D of spacetime is represented by the global symbol
39  *  that is returned by the Dim() function. */
40 class lorentzidx : public idx
41 {
42         GINAC_DECLARE_REGISTERED_CLASS(lorentzidx, idx)
43
44         friend class simp_lor;
45         friend class scalar_products;
46
47 // member functions
48
49         // other constructors
50 public:
51         explicit lorentzidx(bool cov, bool oonly=false, unsigned dimp=0);
52         explicit lorentzidx(const std::string & n, bool cov=false,
53                             bool oonly=false, unsigned dimp=0);
54         explicit lorentzidx(const char * n, bool cov=false,
55                             bool oonly=false, unsigned dimp=0);
56         explicit lorentzidx(unsigned v, bool cov=false);
57
58         // functions overriding virtual functions from bases classes
59 public:
60         void printraw(std::ostream & os) const;
61         void printtree(std::ostream & os, unsigned indent) const;
62         void print(std::ostream & os, unsigned upper_precedence=0) const;
63         bool info(unsigned inf) const;
64
65         // new virtual functions which can be overridden by derived classes
66         // none
67
68         // non-virtual functions in this class
69 public:
70         /** Check whether index only lives in orthogonal space. */
71         bool is_orthogonal_only(void) const {return orthogonal_only;}
72
73         /** Return dimension of parallel space. */
74         unsigned get_dim_parallel_space(void) const {return dim_parallel_space;}
75
76         lorentzidx create_anonymous_representative(void) const; 
77
78         // member variables
79 protected:
80         bool orthogonal_only;        /**< Symbolic index only lives in orthogonal space? */
81         unsigned dim_parallel_space; /**< Dimension of parallel space */
82 };
83
84 // utility functions
85 inline const lorentzidx &ex_to_lorentzidx(const ex &e)
86 {
87         return static_cast<const lorentzidx &>(*e.bp);
88 }
89
90 ex Dim(void);
91
92 } // namespace GiNaC
93
94 #endif // ndef __GINAC_LORENTZIDX_H__