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