- archiving implemented in lorentzidx
[ginac.git] / ginac / lorentzidx.h
1 /** @file lorentzidx.h
2  *
3  *  Interface to GiNaC's lorentz indices. */
4
5 /*
6  *  GiNaC Copyright (C) 1999-2000 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 <ginac/idx.h>
29
30 #ifndef NO_GINAC_NAMESPACE
31 namespace GiNaC {
32 #endif // ndef NO_GINAC_NAMESPACE
33
34 class lorentzidx : public idx
35 {
36     GINAC_DECLARE_REGISTERED_CLASS(lorentzidx, idx)
37
38     friend class simp_lor;
39     friend class scalar_products;
40
41 // member functions
42
43     // default constructor, destructor, copy constructor assignment operator and helpers
44 public:
45     lorentzidx();
46     ~lorentzidx();
47     lorentzidx (const lorentzidx & other);
48     const lorentzidx & operator=(const lorentzidx & other);
49 protected:
50     void copy(const lorentzidx & other);
51     void destroy(bool call_parent);
52
53     // other constructors
54 public:
55     explicit lorentzidx(bool cov, bool oonly=false, unsigned dimp=0);
56     explicit lorentzidx(const string & n, bool cov=false,
57                         bool oonly=false, unsigned dimp=0);
58     explicit lorentzidx(const char * n, bool cov=false,
59                         bool oonly=false, unsigned dimp=0);
60     explicit lorentzidx(unsigned v, bool cov=false);
61
62     // functions overriding virtual functions from bases classes
63 public:
64     basic * duplicate() const;
65     void printraw(ostream & os) const;
66     void printtree(ostream & os, unsigned indent) const;
67     void print(ostream & os, unsigned upper_precedence=0) const;
68     bool info(unsigned inf) const;
69
70     // new virtual functions which can be overridden by derived classes
71     // none
72
73     // non-virtual functions in this class
74 public:
75     bool is_orthogonal_only(void) const { return orthogonal_only; }
76     unsigned get_dim_parallel_space(void) const { return dim_parallel_space; }
77     lorentzidx create_anonymous_representative(void) const; 
78
79     // member variables
80 protected:
81     bool orthogonal_only;
82     unsigned dim_parallel_space;
83 };
84
85 // global constants
86
87 extern const lorentzidx some_lorentzidx;
88 extern const type_info & typeid_lorentzidx;
89
90 // utility functions
91 inline const lorentzidx &ex_to_lorentzidx(const ex &e)
92 {
93         return static_cast<const lorentzidx &>(*e.bp);
94 }
95
96 #ifndef NO_GINAC_NAMESPACE
97 } // namespace GiNaC
98 #endif // ndef NO_GINAC_NAMESPACE
99
100 #endif // ndef __GINAC_LORENTZIDX_H__