3 * Interface to GiNaC's indices. */
6 * GiNaC Copyright (C) 1999 Johannes Gutenberg University Mainz, Germany
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.
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.
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
23 #ifndef __GINAC_IDX_H__
24 #define __GINAC_IDX_H__
28 #include <ginac/basic.h>
33 class idx : public basic
37 // default constructor, destructor, copy constructor assignment operator and helpers
41 idx (idx const & other);
42 idx const & operator=(idx const & other);
44 void copy(idx const & other);
45 void destroy(bool call_parent);
49 explicit idx(bool cov);
50 explicit idx(string const & n, bool cov=false);
51 explicit idx(char const * n, bool cov=false);
52 explicit idx(unsigned const v, bool cov=false);
54 // functions overriding virtual functions from bases classes
56 basic * duplicate() const;
57 void printraw(ostream & os) const;
58 void printtree(ostream & os, unsigned indent) const;
59 void print(ostream & os, unsigned upper_precedence=0) const;
60 bool info(unsigned inf) const;
62 int compare_same_type(basic const & other) const;
63 bool is_equal_same_type(basic const & other) const;
64 unsigned calchash(void) const;
65 ex subs(lst const & ls, lst const & lr) const;
67 // new virtual functions which can be overridden by derived classes
69 virtual bool is_co_contra_pair(basic const & other) const;
70 virtual ex toggle_covariant(void) const;
72 // non-virtual functions in this class
74 bool is_symbolic(void) const;
75 unsigned get_value(void) const;
76 bool is_covariant(void) const;
77 void setname(string const & n) {name=n;}
78 string getname(void) const {return name;}
86 static unsigned next_serial;
87 bool covariant; // x_mu, default is contravariant: x^mu
92 extern const idx some_idx;
93 extern type_info const & typeid_idx;
96 inline const idx &ex_to_idx(const ex &e)
98 return static_cast<const idx &>(*e.bp);
103 typedef vector<ex> exvector;
105 int canonicalize_indices(exvector & iv, bool antisymmetric=false);
106 exvector idx_intersect(exvector const & iv1, exvector const & iv2);
107 ex permute_free_index_to_front(exvector const & iv3, exvector const & iv2,
108 bool antisymmetric, int * sig);
109 unsigned subs_index_in_exvector(exvector & v, ex const & is, ex const & ir);
110 ex subs_indices(ex const & e, exvector const & idxv_contra,
111 exvector const & idxv_co);
112 unsigned count_index(ex const & e, ex const & i);
116 #endif // ndef __GINAC_IDX_H__