- minor updates.
[ginac.git] / ginac / lortensor.h
1 /** @file lortensor.h
2  *
3  *  Interface to GiNaCĀ“s lortensor objects. */
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_LORTENSOR_H__
24 #define __GINAC_LORTENSOR_H__
25
26 #include <string>
27 #include <vector>
28 #include "config.h"
29 #include <iostream>
30 #include <ginac/indexed.h>
31 #include <ginac/lorentzidx.h>
32
33 #ifndef NO_GINAC_NAMESPACE
34 namespace GiNaC {
35 #endif // ndef NO_GINAC_NAMESPACE
36
37 /** Base class for lortensor object */
38 class lortensor : public indexed
39 {
40     // friends
41     friend lortensor lortensor_g(ex const & mu, ex const & nu);
42     // friend lortensor lortensor_delta(ex const & mu, ex const & nu);
43     friend lortensor lortensor_epsilon(ex const & mu, ex const & nu,
44                                        ex const & rho, ex const & sigma);
45     friend lortensor lortensor_rankn(string const & n, exvector const & iv);
46     friend lortensor lortensor_rank1(string const & n, ex const & mu);
47     friend lortensor lortensor_rank2(string const & n, ex const & mu, ex const & nu);
48     friend ex simplify_lortensor_mul(ex const & m);
49     friend ex simplify_lortensor(ex const & e);
50     
51     // types
52
53 public:
54     typedef enum { invalid,
55                    lortensor_g,
56                    lortensor_rankn,
57                    lortensor_rank1,
58                    lortensor_rank2,
59                    // lortensor_delta,
60                    lortensor_epsilon
61     } lortensor_types;
62
63     // member functions
64
65     // default constructor, destructor, copy constructor assignment operator and helpers
66 public:
67     lortensor();
68     ~lortensor();
69     lortensor(lortensor const & other);
70     lortensor const & operator=(lortensor const & other);
71 protected:
72     void copy(lortensor const & other);
73     void destroy(bool call_parent);
74
75     // other constructors
76 protected:
77     lortensor(lortensor_types const lt, string const & n);
78     lortensor(lortensor_types const lt, string const & n, ex const & mu);
79     lortensor(lortensor_types const lt, string const & n, ex const & mu, ex const & nu);
80     lortensor(lortensor_types const lt, string const & n, ex const & mu, ex const & nu,
81               ex const & rho);
82     lortensor(lortensor_types const lt, string const & n, ex const & mu, ex const & nu, ex const & rho, ex const & sigma);
83     lortensor(lortensor_types const lt, string const & n, exvector const & iv);
84     lortensor(lortensor_types const lt, string const & n, unsigned s, exvector const & iv);
85     lortensor(lortensor_types const lt, string const & n, unsigned s, exvector * ivp);
86     
87     //functions overriding virtual functions from base classes
88 public:
89     basic * duplicate() const;
90     void printraw(ostream & os) const;
91     void printtree(ostream & os, unsigned indent) const;
92     void print(ostream & os, unsigned upper_precedence=0) const;
93     void printcsrc(ostream & os, unsigned type, unsigned upper_precedence=0) const;
94     bool info(unsigned inf) const;
95     ex eval(int level=0) const;
96 protected:
97     int compare_same_type(basic const & other) const;
98     bool is_equal_same_type(basic const & other) const;
99     unsigned return_type(void) const;
100     unsigned return_type_tinfo(void) const;
101     ex thisexprseq(exvector const & v) const;
102     ex thisexprseq(exvector * vp) const;
103
104     // new virtual functions which can be overridden by derived classes
105     // none
106
107     //non virtual functions in this class
108 public:
109     void setname(string const & n);
110     string getname(void) const {return name;}
111 protected:
112     bool all_of_type_lorentzidx(void) const;
113 private:
114     string & autoname_prefix(void);
115
116     //member variables
117
118 protected:
119     lortensor_types type;
120     string name;
121     unsigned serial;
122 private:
123     static unsigned next_serial;
124 };
125
126 // global constants
127
128     extern const lortensor some_lortensor;
129     extern type_info const & typeid_lortensor;
130
131 // utility functions
132     
133 inline const lortensor & ex_to_lortensor(const ex &e)
134 {
135         return static_cast<const lortensor &>(*e.bp);
136 }
137
138 inline lortensor &ex_to_nonconst_lortensor(const ex &e)
139 {
140         return static_cast<lortensor &>(*e.bp);
141 }
142
143 lortensor lortensor_g(ex const & mu, ex const & nu);
144 ex simplify_lortensor_mul(ex const & m);
145 ex simplify_lortensor(ex const & e);
146 ex Dim(void);    
147
148 #ifndef NO_GINAC_NAMESPACE
149 } // namespace GiNaC
150 #endif // ndef NO_GINAC_NAMESPACE
151
152 #endif // ndef __GINAC_LORTENSOR_H__