67c9344e6b9a580b09014e7e12b01e3f82406c81
[ginac.git] / ginac / idx.h
1 /** @file idx.h
2  *
3  *  Interface to GiNaC's 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_IDX_H__
24 #define __GINAC_IDX_H__
25
26 #include <string>
27 //#include <vector>
28 #include <ginac/basic.h>
29 #include <ginac/ex.h>
30
31 #ifndef NO_GINAC_NAMESPACE
32 namespace GiNaC {
33 #endif // ndef NO_GINAC_NAMESPACE
34
35 class idx : public basic
36 {
37 // member functions
38
39     // default constructor, destructor, copy constructor assignment operator and helpers
40 public:
41     idx();
42     ~idx();
43     idx (const idx & other);
44     const idx & operator=(const idx & other);
45 protected:
46     void copy(const idx & other);
47     void destroy(bool call_parent);
48
49     // other constructors
50 public:
51     explicit idx(bool cov);
52     explicit idx(const string & n, bool cov=false);
53     explicit idx(const char * n, bool cov=false);
54     explicit idx(unsigned 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 protected:
64     int compare_same_type(const basic & other) const;
65     bool is_equal_same_type(const basic & other) const;
66     unsigned calchash(void) const;
67     ex subs(const lst & ls, const lst & lr) const;
68
69     // new virtual functions which can be overridden by derived classes
70 public:
71     virtual bool is_co_contra_pair(const basic & other) const;
72     virtual ex toggle_covariant(void) const;
73
74     // non-virtual functions in this class
75 public:
76     bool is_symbolic(void) const;
77     unsigned get_value(void) const;
78     bool is_covariant(void) const;
79     void setname(const string & n) {name=n;}
80     string getname(void) const {return name;}
81
82     // member variables
83 protected:
84     unsigned serial;
85     bool symbolic;
86     string name;
87     unsigned value;
88     static unsigned next_serial;
89     bool covariant; // x_mu, default is contravariant: x^mu
90 };
91
92 // global constants
93
94 extern const idx some_idx;
95 extern const type_info & typeid_idx;
96
97 // utility functions
98 inline const idx &ex_to_idx(const ex &e)
99 {
100         return static_cast<const idx &>(*e.bp);
101 }
102
103 // global functions
104
105 // typedef vector<ex> exvector;
106
107 int canonicalize_indices(exvector & iv, bool antisymmetric=false);
108 exvector idx_intersect(const exvector & iv1, const exvector & iv2);
109 ex permute_free_index_to_front(const exvector & iv3, const exvector & iv2,
110                                bool antisymmetric, int * sig);
111 unsigned subs_index_in_exvector(exvector & v, const ex & is, const ex & ir);
112 ex subs_indices(const ex & e, const exvector & idxv_contra,
113                 const exvector & idxv_co);
114 unsigned count_index(const ex & e, const ex & i);
115
116 #ifndef NO_GINAC_NAMESPACE
117 } // namespace GiNaC
118 #endif // ndef NO_GINAC_NAMESPACE
119
120 #endif // ndef __GINAC_IDX_H__