ginac/idx.h

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