ginac/indexed.h

   1 /** @file indexed.h
   2  *
   3  *  Interface to GiNaC's indexed expressions. */
   4
   5 /*
   6  *  GiNaC Copyright (C) 1999-2008 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_INDEXED_H__
  24 #define __GINAC_INDEXED_H__
  25
  26 #include <map>
  27
  28 #include "exprseq.h"
  29 #include "wildcard.h"
  30
  31 namespace GiNaC {
  32
  33
  34 class scalar_products;
  35 class symmetry;
  36
  37 /** This class holds an indexed expression. It consists of a 'base' expression
  38  *  (the expression being indexed) which can be accessed as op(0), and n (n >= 0)
  39  *  indices (all of class idx), accessible as op(1)..op(n). */
  40 class indexed : public exprseq
  41 {
  42         GINAC_DECLARE_REGISTERED_CLASS(indexed, exprseq)
  43
  44         friend ex simplify_indexed(const ex & e, exvector & free_indices, exvector & dummy_indices, const scalar_products & sp);
  45         friend ex simplify_indexed_product(const ex & e, exvector & free_indices, exvector & dummy_indices, const scalar_products & sp);
  46         friend bool reposition_dummy_indices(ex & e, exvector & variant_dummy_indices, exvector & moved_indices);
  47
  48         // other constructors
  49 public:
  50         /** Construct indexed object with no index.
  51          *
  52          *  @param b Base expression
  53          *  @return newly constructed indexed object */
  54         indexed(const ex & b);
  55
  56         /** Construct indexed object with one index. The index must be of class idx.
  57          *
  58          *  @param b Base expression
  59          *  @param i1 The index
  60          *  @return newly constructed indexed object */
  61         indexed(const ex & b, const ex & i1);
  62
  63         /** Construct indexed object with two indices. The indices must be of class idx.
  64          *
  65          *  @param b Base expression
  66          *  @param i1 First index
  67          *  @param i2 Second index
  68          *  @return newly constructed indexed object */
  69         indexed(const ex & b, const ex & i1, const ex & i2);
  70
  71         /** Construct indexed object with three indices. The indices must be of class idx.
  72          *
  73          *  @param b Base expression
  74          *  @param i1 First index
  75          *  @param i2 Second index
  76          *  @param i3 Third index
  77          *  @return newly constructed indexed object */
  78         indexed(const ex & b, const ex & i1, const ex & i2, const ex & i3);
  79
  80         /** Construct indexed object with four indices. The indices must be of class idx.
  81          *
  82          *  @param b Base expression
  83          *  @param i1 First index
  84          *  @param i2 Second index
  85          *  @param i3 Third index
  86          *  @param i4 Fourth index
  87          *  @return newly constructed indexed object */
  88         indexed(const ex & b, const ex & i1, const ex & i2, const ex & i3, const ex & i4);
  89
  90         /** Construct indexed object with two indices and a specified symmetry. The
  91          *  indices must be of class idx.
  92          *
  93          *  @param b Base expression
  94          *  @param symm Symmetry of indices
  95          *  @param i1 First index
  96          *  @param i2 Second index
  97          *  @return newly constructed indexed object */
  98         indexed(const ex & b, const symmetry & symm, const ex & i1, const ex & i2);
  99
 100         /** Construct indexed object with three indices and a specified symmetry.
 101          *  The indices must be of class idx.
 102          *
 103          *  @param b Base expression
 104          *  @param symm Symmetry of indices
 105          *  @param i1 First index
 106          *  @param i2 Second index
 107          *  @param i3 Third index
 108          *  @return newly constructed indexed object */
 109         indexed(const ex & b, const symmetry & symm, const ex & i1, const ex & i2, const ex & i3);
 110
 111         /** Construct indexed object with four indices and a specified symmetry. The
 112          *  indices must be of class idx.
 113          *
 114          *  @param b Base expression
 115          *  @param symm Symmetry of indices
 116          *  @param i1 First index
 117          *  @param i2 Second index
 118          *  @param i3 Third index
 119          *  @param i4 Fourth index
 120          *  @return newly constructed indexed object */
 121         indexed(const ex & b, const symmetry & symm, const ex & i1, const ex & i2, const ex & i3, const ex & i4);
 122
 123         /** Construct indexed object with a specified vector of indices. The indices
 124          *  must be of class idx.
 125          *
 126          *  @param b Base expression
 127          *  @param iv Vector of indices
 128          *  @return newly constructed indexed object */
 129         indexed(const ex & b, const exvector & iv);
 130
 131         /** Construct indexed object with a specified vector of indices and
 132          *  symmetry. The indices must be of class idx.
 133          *
 134          *  @param b Base expression
 135          *  @param symm Symmetry of indices
 136          *  @param iv Vector of indices
 137          *  @return newly constructed indexed object */
 138         indexed(const ex & b, const symmetry & symm, const exvector & iv);
 139
 140         // internal constructors
 141         indexed(const symmetry & symm, const exprseq & es);
 142         indexed(const symmetry & symm, const exvector & v, bool discardable = false);
 143         indexed(const symmetry & symm, std::auto_ptr<exvector> vp);
 144
 145         // functions overriding virtual functions from base classes
 146 public:
 147         unsigned precedence() const {return 55;}
 148         bool info(unsigned inf) const;
 149         ex eval(int level = 0) const;
 150         ex real_part() const;
 151         ex imag_part() const;
 152         exvector get_free_indices() const;
 153
 154         /** Save (a.k.a. serialize) indexed object into archive. */
 155         void archive(archive_node& n) const;
 156         /** Read (a.k.a. deserialize) indexed object from archive. */
 157         void read_archive(const archive_node& n, lst& syms);
 158 protected:
 159         ex derivative(const symbol & s) const;
 160         ex thiscontainer(const exvector & v) const;
 161         ex thiscontainer(std::auto_ptr<exvector> vp) const;
 162         unsigned return_type() const;
 163         return_type_t return_type_tinfo() const { return op(0).return_type_tinfo(); }
 164         ex expand(unsigned options = 0) const;
 165
 166         // new virtual functions which can be overridden by derived classes
 167         // none
 168
 169         // non-virtual functions in this class
 170 public:
 171         /** Check whether all index values have a certain property.
 172          *  @see class info_flags */
 173         bool all_index_values_are(unsigned inf) const;
 174
 175         /** Return a vector containing the object's indices. */
 176         exvector get_indices() const;
 177
 178         /** Return a vector containing the dummy indices of the object, if any. */
 179         exvector get_dummy_indices() const;
 180
 181         /** Return a vector containing the dummy indices in the contraction with
 182          *  another indexed object. This is symmetric: a.get_dummy_indices(b)
 183          *  == b.get_dummy_indices(a) */
 184         exvector get_dummy_indices(const indexed & other) const;
 185
 186         /** Check whether the object has an index that forms a dummy index pair
 187          *  with a given index. */
 188         bool has_dummy_index_for(const ex & i) const;
 189
 190         /** Return symmetry properties. */
 191         ex get_symmetry() const {return symtree;}
 192
 193 protected:
 194         void printindices(const print_context & c, unsigned level) const;
 195         void print_indexed(const print_context & c, const char *openbrace, const char *closebrace, unsigned level) const;
 196         void do_print(const print_context & c, unsigned level) const;
 197         void do_print_latex(const print_latex & c, unsigned level) const;
 198         void do_print_tree(const print_tree & c, unsigned level) const;
 199         void validate() const;
 200
 201         // member variables
 202 protected:
 203         ex symtree; /**< Index symmetry (tree of symmetry objects) */
 204 };
 205 GINAC_DECLARE_UNARCHIVER(indexed);
 206
 207
 208 class spmapkey {
 209 public:
 210         spmapkey() : dim(wild()) {}
 211         spmapkey(const ex & v1, const ex & v2, const ex & dim = wild());
 212
 213         bool operator==(const spmapkey &other) const;
 214         bool operator<(const spmapkey &other) const;
 215
 216         void debugprint() const;
 217
 218 protected:
 219         ex v1, v2, dim;
 220 };
 221
 222 typedef std::map<spmapkey, ex> spmap;
 223
 224 /** Helper class for storing information about known scalar products which
 225  *  are to be automatically replaced by simplify_indexed().
 226  *
 227  *  @see simplify_indexed */
 228 class scalar_products {
 229 public:
 230         /** Register scalar product pair and its value. */
 231         void add(const ex & v1, const ex & v2, const ex & sp);
 232
 233         /** Register scalar product pair and its value for a specific space dimension. */
 234         void add(const ex & v1, const ex & v2, const ex & dim, const ex & sp);
 235
 236         /** Register list of vectors. This adds all possible pairs of products
 237          *  a.i * b.i with the value a*b (note that this is not a scalar vector
 238          *  product but an ordinary product of scalars). */
 239         void add_vectors(const lst & l, const ex & dim = wild());
 240
 241         /** Clear all registered scalar products. */
 242         void clear();
 243
 244         bool is_defined(const ex & v1, const ex & v2, const ex & dim) const;
 245         ex evaluate(const ex & v1, const ex & v2, const ex & dim) const;
 246         void debugprint() const;
 247
 248 protected:
 249         spmap spm; /*< Map from defined scalar product pairs to their values */
 250 };
 251
 252
 253 // utility functions
 254
 255 /** Returns all dummy indices from the expression */
 256 exvector get_all_dummy_indices(const ex & e);
 257
 258 /** More reliable version of the form. The former assumes that e is an
 259   * expanded epxression. */
 260 exvector get_all_dummy_indices_safely(const ex & e);
 261
 262 /** Returns b with all dummy indices, which are listed in va, renamed
 263  *  if modify_va is set to TRUE all dummy indices of b will be appended to va */
 264 ex rename_dummy_indices_uniquely(exvector & va, const ex & b, bool modify_va = false);
 265
 266 /** Returns b with all dummy indices, which are common with a, renamed */
 267 ex rename_dummy_indices_uniquely(const ex & a, const ex & b);
 268
 269 /** Same as above, where va and vb contain the indices of a and b and are sorted */
 270 ex rename_dummy_indices_uniquely(const exvector & va, const exvector & vb, const ex & b);
 271
 272 /** Similar to above, where va and vb are the same and the return value is a list of two lists
 273  *  for substitution in b */
 274 lst rename_dummy_indices_uniquely(const exvector & va, const exvector & vb);
 275
 276 /** This function returns the given expression with expanded sums
 277  *  for all dummy index summations, where the dimensionality of
 278  *  the dummy index is a nonnegative integer.
 279  *  Optionally all indices with a variance will be substituted by
 280  *  indices with the corresponding numeric values without variance.
 281  *
 282  *  @param e the given expression
 283  *  @param subs_idx indicates if variance of dummy indixes should be neglected
 284  */
 285 ex expand_dummy_sum(const ex & e, bool subs_idx = false);
 286
 287 } // namespace GiNaC
 288
 289 #endif // ndef __GINAC_INDEXED_H__