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         // other constructors
  44 public:
  45         explicit idx(bool cov);
  46         explicit idx(const std::string & n, bool cov=false);
  47         explicit idx(const char * n, bool cov=false);
  48         explicit idx(unsigned v, bool cov=false);
  49
  50         // functions overriding virtual functions from bases classes
  51 public:
  52         void printraw(std::ostream & os) const;
  53         void printtree(std::ostream & os, unsigned indent) const;
  54         void print(std::ostream & os, unsigned upper_precedence=0) const;
  55         bool info(unsigned inf) const;
  56 protected:
  57         bool is_equal_same_type(const basic & other) const;
  58         unsigned calchash(void) const;
  59         ex subs(const lst & ls, const lst & lr) const;
  60
  61         // new virtual functions which can be overridden by derived classes
  62 public:
  63         virtual bool is_co_contra_pair(const basic & other) const;
  64         virtual ex toggle_covariant(void) const;
  65
  66         // non-virtual functions in this class
  67 public:
  68         /** Check whether index is symbolic (not numeric). */
  69         bool is_symbolic(void) const {return symbolic;}
  70
  71         /** Get numeric value of index. Undefined for symbolic indices. */
  72         unsigned get_value(void) const {return value;}
  73
  74         /** Check whether index is covariant (not contravariant). */
  75         bool is_covariant(void) const {return covariant;}
  76
  77         void setname(const std::string & n) {name=n;}
  78         std::string getname(void) const {return name;}
  79
  80 private:
  81         std::string & autoname_prefix(void);
  82
  83         // member variables
  84 protected:
  85         unsigned serial;  /**< Unique serial number for comparing symbolic indices */
  86         bool symbolic;    /**< Is index symbolic? */
  87         std::string name; /**< Symbolic name (if symbolic == true) */
  88         unsigned value;   /**< Numeric value (if symbolic == false) */
  89         static unsigned next_serial;
  90         bool covariant;   /**< x_mu, default is contravariant: x~mu */
  91 };
  92
  93 // utility functions
  94 inline const idx &ex_to_idx(const ex &e)
  95 {
  96         return static_cast<const idx &>(*e.bp);
  97 }
  98
  99 // global functions
 100
 101 int canonicalize_indices(exvector & iv, bool antisymmetric=false);
 102 exvector idx_intersect(const exvector & iv1, const exvector & iv2);
 103 ex permute_free_index_to_front(const exvector & iv3, const exvector & iv2, int * sig);
 104 unsigned subs_index_in_exvector(exvector & v, const ex & is, const ex & ir);
 105 ex subs_indices(const ex & e, const exvector & idxv_contra, const exvector & idxv_co);
 106 unsigned count_index(const ex & e, const ex & i);
 107
 108 #ifndef NO_NAMESPACE_GINAC
 109 } // namespace GiNaC
 110 #endif // ndef NO_NAMESPACE_GINAC
 111
 112 #endif // ndef __GINAC_IDX_H__