- added documentation for the idx, coloridx and lorentzidx classes
[ginac.git] / ginac / idx.h
1 /** @file idx.h
2  *
3  *  Interface to GiNaC's indices. */
4
5 /*
6  *  GiNaC Copyright (C) 1999-2001 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 "basic.h"
29 #include "ex.h"
30
31 #ifndef NO_NAMESPACE_GINAC
32 namespace GiNaC {
33 #endif // ndef NO_NAMESPACE_GINAC
34
35
36 /** This class holds one index of an indexed object. Indices can be symbolic
37  *  (e.g. "mu", "i") or numeric (unsigned integer), and they can be contravariant
38  *  (the default) or covariant. */
39 class idx : public basic
40 {
41         GINAC_DECLARE_REGISTERED_CLASS(idx, basic)
42
43         // default constructor, destructor, copy constructor assignment operator and helpers
44 public:
45         idx();
46         ~idx();
47         idx (const idx & other);
48         const idx & operator=(const idx & other);
49 protected:
50         void copy(const idx & other);
51         void destroy(bool call_parent);
52
53         // other constructors
54 public:
55         explicit idx(bool cov);
56         explicit idx(const std::string & n, bool cov=false);
57         explicit idx(const char * n, bool cov=false);
58         explicit idx(unsigned v, bool cov=false); 
59
60         // functions overriding virtual functions from bases classes
61 public:
62         basic * duplicate() const;
63         void printraw(std::ostream & os) const;
64         void printtree(std::ostream & os, unsigned indent) const;
65         void print(std::ostream & os, unsigned upper_precedence=0) const;
66         bool info(unsigned inf) const;
67 protected:
68         int compare_same_type(const basic & other) const;
69         bool is_equal_same_type(const basic & other) const;
70         unsigned calchash(void) const;
71         ex subs(const lst & ls, const lst & lr) const;
72
73         // new virtual functions which can be overridden by derived classes
74 public:
75         virtual bool is_co_contra_pair(const basic & other) const;
76         virtual ex toggle_covariant(void) const;
77
78         // non-virtual functions in this class
79 public:
80         /** Check whether index is symbolic (not numeric). */
81         bool is_symbolic(void) const {return symbolic;}
82
83         /** Get numeric value of index. Undefined for symbolic indices. */
84         unsigned get_value(void) const {return value;}
85
86         /** Check whether index is covariant (not contravariant). */
87         bool is_covariant(void) const {return covariant;}
88
89         void setname(const std::string & n) {name=n;}
90         std::string getname(void) const {return name;}
91
92         // member variables
93 protected:
94         unsigned serial;
95         bool symbolic;    /**< Is index symbolic? */
96         std::string name; /**< Symbolic name (if symbolic == true) */
97         unsigned value;   /**< Numeric value (if symbolic == false) */
98         static unsigned next_serial;
99         bool covariant;   /**< x_mu, default is contravariant: x~mu */
100 };
101
102 // global constants
103
104 extern const idx some_idx;
105 extern const std::type_info & typeid_idx;
106
107 // utility functions
108 inline const idx &ex_to_idx(const ex &e)
109 {
110         return static_cast<const idx &>(*e.bp);
111 }
112
113 // global functions
114
115 int canonicalize_indices(exvector & iv, bool antisymmetric=false);
116 exvector idx_intersect(const exvector & iv1, const exvector & iv2);
117 ex permute_free_index_to_front(const exvector & iv3, const exvector & iv2, int * sig);
118 unsigned subs_index_in_exvector(exvector & v, const ex & is, const ex & ir);
119 ex subs_indices(const ex & e, const exvector & idxv_contra, const exvector & idxv_co);
120 unsigned count_index(const ex & e, const ex & i);
121
122 #ifndef NO_NAMESPACE_GINAC
123 } // namespace GiNaC
124 #endif // ndef NO_NAMESPACE_GINAC
125
126 #endif // ndef __GINAC_IDX_H__