#ifndef around namespace GiNaC { }
[ginac.git] / ginac / simp_lor.h
1 /** @file simp_lor.h
2  *
3  *  Interface to GiNaC's simp_lor 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 _SIMP__GINAC_LOR_H__
24 #define _SIMP__GINAC_LOR_H__
25
26 #include <string>
27 #include <vector>
28 #include <utility>
29 #include <map>
30 #include <iostream>
31 #include <ginac/indexed.h>
32 #include <ginac/lorentzidx.h>
33
34 #ifndef NO_GINAC_NAMESPACE
35 namespace GiNaC {
36 #endif // ndef NO_GINAC_NAMESPACE
37
38 typedef pair<string,string> strstrpair;
39 typedef pair<strstrpair,lorentzidx> spmapkey;
40
41 class spmapkey_is_less
42 {
43 public:
44     bool operator()(spmapkey const & lh, spmapkey const & rh) const
45     {
46         /*
47         cerr << "spmapkey_is_less" << endl;
48         cerr << "lh=((" << lh.first.first
49              << "," << lh.first.second << "),";
50         lh.second.printraw(cerr);
51         cerr << ")" << endl;
52
53         cerr << "rh=((" << rh.first.first
54              << "," << rh.first.second << "),";
55         rh.second.printraw(cerr);
56         cerr << ")" << endl;
57         */
58         bool res=lh.first<rh.first ||
59             (!(rh.first<lh.first) && lh.second.compare(rh.second)<0 );
60         // cout << "result=" << res << endl;
61         return res;
62     }
63 };
64
65 typedef map<spmapkey,ex,spmapkey_is_less> spmap;
66
67 class simp_lor;
68
69 /** helper class for scalar products */
70 class scalar_products
71 {
72 public:
73     void reg(simp_lor const & v1, simp_lor const & v2, ex const & sp);
74     bool is_defined(simp_lor const & v1, simp_lor const & v2) const;
75     ex evaluate(simp_lor const & v1, simp_lor const & v2) const;
76     void debugprint(void) const;
77 protected:
78     static spmapkey make_key(simp_lor const & v1, simp_lor const & v2);
79 protected:
80     spmap spm;
81 };
82
83 /** Base class for simp_lor object */
84 class simp_lor : public indexed
85 {
86 // friends
87
88     friend class scalar_products;
89     friend simp_lor lor_g(ex const & mu, ex const & nu);
90     friend simp_lor lor_vec(string const & n, ex const & mu);
91     friend ex simplify_simp_lor_mul(ex const & m, scalar_products const & sp);
92     friend ex simplify_simp_lor(ex const & e, scalar_products const & sp);
93     
94 // types
95
96 public:
97     typedef enum { invalid, // not properly constructed by one of the friend functions
98                    simp_lor_g,
99                    simp_lor_vec
100     } simp_lor_types;
101     
102 // member functions
103
104     // default constructor, destructor, copy constructor assignment operator and helpers
105 public:
106     simp_lor();
107     ~simp_lor();
108     simp_lor(simp_lor const & other);
109     simp_lor const & operator=(simp_lor const & other);
110 protected:
111     void copy(simp_lor const & other); 
112     void destroy(bool call_parent);
113
114     // other constructors
115 protected:
116     simp_lor(simp_lor_types const t);
117     simp_lor(simp_lor_types const t, ex const & i1, ex const & i2);
118     simp_lor(simp_lor_types const t, string const & n, ex const & i1);
119     simp_lor(simp_lor_types const t, string const & n, exvector const & iv);
120     simp_lor(simp_lor_types const t, string const & n, exvector * ivp);
121     
122     // functions overriding virtual functions from base classes
123 public:
124     basic * duplicate() const;
125     void printraw(ostream & os) const;
126     void printtree(ostream & os, unsigned indent) const;
127     void print(ostream & os, unsigned upper_precedence=0) const;
128     void printcsrc(ostream & os, unsigned type, unsigned upper_precedence=0) const;
129     bool info(unsigned inf) const;
130     ex eval(int level=0) const;
131 protected:
132     int compare_same_type(basic const & other) const;
133     bool is_equal_same_type(basic const & other) const;
134     unsigned return_type(void) const;
135     unsigned return_type_tinfo(void) const;
136     ex thisexprseq(exvector const & v) const;
137     ex thisexprseq(exvector * vp) const;
138
139     // new virtual functions which can be overridden by derived classes
140     // none
141     
142     // non-virtual functions in this class
143 protected:
144     bool all_of_type_lorentzidx(void) const;
145     
146 // member variables
147
148 protected:
149     simp_lor_types type;
150     string name;
151 };
152
153 // global constants
154
155 extern const simp_lor some_simp_lor;
156 extern type_info const & typeid_simp_lor;
157
158 // utility functions
159 inline const simp_lor &ex_to_simp_lor(const ex &e)
160 {
161         return static_cast<const simp_lor &>(*e.bp);
162 }
163
164 inline simp_lor &ex_to_nonconst_simp_lor(const ex &e)
165 {
166         return static_cast<simp_lor &>(*e.bp);
167 }
168
169 simp_lor lor_g(ex const & mu, ex const & nu);
170 simp_lor lor_vec(string const & n, ex const & mu);
171 ex simplify_simp_lor_mul(ex const & m, scalar_products const & sp);
172 ex simplify_simp_lor(ex const & e, scalar_products const & sp);
173 ex Dim(void);
174
175 #ifndef NO_GINAC_NAMESPACE
176 } // namespace GiNaC
177 #endif // ndef NO_GINAC_NAMESPACE
178
179 #endif // ndef _SIMP__GINAC_LOR_H__