ginac/idx.h

   1 /** @file idx.h
   2  *
   3  *  Interface to GiNaC's indices. */
   4
   5 /*
   6  *  GiNaC Copyright (C) 1999-2003 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 "ex.h"
  27 #include "numeric.h"
  28
  29 namespace GiNaC {
  30
  31
  32 /** This class holds one index of an indexed object. Indices can
  33  *  theoretically consist of any symbolic expression but they are usually
  34  *  only just a symbol (e.g. "mu", "i") or numeric (integer). Indices belong
  35  *  to a space with a certain numeric or symbolic dimension. */
  36 class idx : public basic
  37 {
  38         GINAC_DECLARE_REGISTERED_CLASS(idx, basic)
  39
  40         // other constructors
  41 public:
  42         /** Construct index with given value and dimension.
  43          *
  44          *  @param v Value of index (numeric or symbolic)
  45          *  @param dim Dimension of index space (numeric or symbolic)
  46          *  @return newly constructed index */
  47         explicit idx(const ex & v, const ex & dim);
  48
  49         // functions overriding virtual functions from base classes
  50 public:
  51         void print(const print_context & c, unsigned level = 0) const;
  52         bool info(unsigned inf) const;
  53         size_t nops() const;
  54         ex op(size_t i) const;
  55         ex map(map_function & f) const;
  56         ex evalf(int level = 0) const;
  57         ex subs(const exmap & m, unsigned options = 0) const;
  58
  59 protected:
  60         ex derivative(const symbol & s) const;
  61         bool match_same_type(const basic & other) const;
  62         unsigned calchash() const;
  63
  64         // new virtual functions in this class
  65 public:
  66         /** Check whether the index forms a dummy index pair with another index
  67          *  of the same type. */
  68         virtual bool is_dummy_pair_same_type(const basic & other) const;
  69
  70         // non-virtual functions in this class
  71 public:
  72         /** Get value of index. */
  73         ex get_value() const {return value;}
  74
  75         /** Check whether the index is numeric. */
  76         bool is_numeric() const {return is_exactly_a<numeric>(value);}
  77
  78         /** Check whether the index is symbolic. */
  79         bool is_symbolic() const {return !is_exactly_a<numeric>(value);}
  80
  81         /** Get dimension of index space. */
  82         ex get_dim() const {return dim;}
  83
  84         /** Check whether the dimension is numeric. */
  85         bool is_dim_numeric() const {return is_exactly_a<numeric>(dim);}
  86
  87         /** Check whether the dimension is symbolic. */
  88         bool is_dim_symbolic() const {return !is_exactly_a<numeric>(dim);}
  89
  90         /** Make a new index with the same value but a different dimension. */
  91         ex replace_dim(const ex & new_dim) const;
  92
  93         /** Return the minimum of the dimensions of this and another index.
  94          *  If this is undecidable, throw an exception. */
  95         ex minimal_dim(const idx & other) const;
  96
  97 protected:
  98         ex value; /**< Expression that constitutes the index (numeric or symbolic name) */
  99         ex dim;   /**< Dimension of space (can be symbolic or numeric) */
 100 };
 101
 102
 103 /** This class holds an index with a variance (co- or contravariant). There
 104  *  is an associated metric tensor that can be used to raise/lower indices. */
 105 class varidx : public idx
 106 {
 107         GINAC_DECLARE_REGISTERED_CLASS(varidx, idx)
 108
 109         // other constructors
 110 public:
 111         /** Construct index with given value, dimension and variance.
 112          *
 113          *  @param v Value of index (numeric or symbolic)
 114          *  @param dim Dimension of index space (numeric or symbolic)
 115          *  @param covariant Make covariant index (default is contravariant)
 116          *  @return newly constructed index */
 117         varidx(const ex & v, const ex & dim, bool covariant = false);
 118
 119         // functions overriding virtual functions from base classes
 120 public:
 121         void print(const print_context & c, unsigned level = 0) const;
 122         bool is_dummy_pair_same_type(const basic & other) const;
 123
 124 protected:
 125         bool match_same_type(const basic & other) const;
 126
 127         // non-virtual functions in this class
 128 public:
 129         /** Check whether the index is covariant. */
 130         bool is_covariant() const {return covariant;}
 131
 132         /** Check whether the index is contravariant (not covariant). */
 133         bool is_contravariant() const {return !covariant;}
 134
 135         /** Make a new index with the same value but the opposite variance. */
 136         ex toggle_variance() const;
 137
 138         // member variables
 139 protected:
 140         bool covariant; /**< x.mu, default is contravariant: x~mu */
 141 };
 142
 143
 144 /** This class holds a spinor index that can be dotted or undotted and that
 145  *  also has a variance. This is used in the Weyl-van-der-Waerden formalism
 146  *  where the dot indicates complex conjugation. There is an associated
 147  *  (asymmetric) metric tensor that can be used to raise/lower spinor
 148  *  indices. */
 149 class spinidx : public varidx
 150 {
 151         GINAC_DECLARE_REGISTERED_CLASS(spinidx, varidx)
 152
 153         // other constructors
 154 public:
 155         /** Construct index with given value, dimension, variance and dot.
 156          *
 157          *  @param v Value of index (numeric or symbolic)
 158          *  @param dim Dimension of index space (numeric or symbolic)
 159          *  @param covariant Make covariant index (default is contravariant)
 160          *  @param dotted Make covariant dotted (default is undotted)
 161          *  @return newly constructed index */
 162         spinidx(const ex & v, const ex & dim = 2, bool covariant = false, bool dotted = false);
 163
 164         // functions overriding virtual functions from base classes
 165 public:
 166         void print(const print_context & c, unsigned level = 0) const;
 167         bool is_dummy_pair_same_type(const basic & other) const;
 168
 169 protected:
 170         bool match_same_type(const basic & other) const;
 171
 172         // non-virtual functions in this class
 173 public:
 174         /** Check whether the index is dotted. */
 175         bool is_dotted() const {return dotted;}
 176
 177         /** Check whether the index is not dotted. */
 178         bool is_undotted() const {return !dotted;}
 179
 180         /** Make a new index with the same value and variance but the opposite
 181          *  dottedness. */
 182         ex toggle_dot() const;
 183
 184         /** Make a new index with the same value but opposite variance and
 185          *  dottedness. */
 186         ex toggle_variance_dot() const;
 187
 188         // member variables
 189 protected:
 190         bool dotted;
 191 };
 192
 193
 194 // utility functions
 195
 196 /** Specialization of is_exactly_a<idx>(obj) for idx objects. */
 197 template<> inline bool is_exactly_a<idx>(const basic & obj)
 198 {
 199         return obj.tinfo()==TINFO_idx;
 200 }
 201
 202 /** Specialization of is_exactly_a<varidx>(obj) for varidx objects. */
 203 template<> inline bool is_exactly_a<varidx>(const basic & obj)
 204 {
 205         return obj.tinfo()==TINFO_varidx;
 206 }
 207
 208 /** Specialization of is_exactly_a<spinidx>(obj) for spinidx objects. */
 209 template<> inline bool is_exactly_a<spinidx>(const basic & obj)
 210 {
 211         return obj.tinfo()==TINFO_spinidx;
 212 }
 213
 214 /** Check whether two indices form a dummy pair. */
 215 bool is_dummy_pair(const idx & i1, const idx & i2);
 216
 217 /** Check whether two expressions form a dummy index pair. */
 218 bool is_dummy_pair(const ex & e1, const ex & e2);
 219
 220 /** Given a vector of indices, split them into two vectors, one containing
 221  *  the free indices, the other containing the dummy indices (numeric
 222  *  indices are neither free nor dummy ones).
 223  *
 224  *  @param it Pointer to start of index vector
 225  *  @param itend Pointer to end of index vector
 226  *  @param out_free Vector of free indices (returned, sorted)
 227  *  @param out_dummy Vector of dummy indices (returned, sorted) */
 228 void find_free_and_dummy(exvector::const_iterator it, exvector::const_iterator itend, exvector & out_free, exvector & out_dummy);
 229
 230 /** Given a vector of indices, split them into two vectors, one containing
 231  *  the free indices, the other containing the dummy indices (numeric
 232  *  indices are neither free nor dummy ones).
 233  *
 234  *  @param v Index vector
 235  *  @param out_free Vector of free indices (returned, sorted)
 236  *  @param out_dummy Vector of dummy indices (returned, sorted) */
 237 inline void find_free_and_dummy(const exvector & v, exvector & out_free, exvector & out_dummy)
 238 {
 239         find_free_and_dummy(v.begin(), v.end(), out_free, out_dummy);
 240 }
 241
 242 /** Given a vector of indices, find the dummy indices.
 243  *
 244  *  @param v Index vector
 245  *  @param out_dummy Vector of dummy indices (returned, sorted) */
 246 inline void find_dummy_indices(const exvector & v, exvector & out_dummy)
 247 {
 248         exvector free_indices;
 249         find_free_and_dummy(v.begin(), v.end(), free_indices, out_dummy);
 250 }
 251
 252 /** Count the number of dummy index pairs in an index vector. */
 253 inline size_t count_dummy_indices(const exvector & v)
 254 {
 255         exvector free_indices, dummy_indices;
 256         find_free_and_dummy(v.begin(), v.end(), free_indices, dummy_indices);
 257         return dummy_indices.size();
 258 }
 259
 260 /** Count the number of dummy index pairs in an index vector. */
 261 inline size_t count_free_indices(const exvector & v)
 262 {
 263         exvector free_indices, dummy_indices;
 264         find_free_and_dummy(v.begin(), v.end(), free_indices, dummy_indices);
 265         return free_indices.size();
 266 }
 267
 268 /** Return the minimum of two index dimensions. If this is undecidable,
 269  *  throw an exception. Numeric dimensions are always considered "smaller"
 270  *  than symbolic dimensions. */
 271 ex minimal_dim(const ex & dim1, const ex & dim2);
 272
 273 } // namespace GiNaC
 274
 275 #endif // ndef __GINAC_IDX_H__