ginac/idx.h

   1 /** @file idx.h
   2  *
   3  *  Interface to GiNaC's indices. */
   4
   5 /*
   6  *  GiNaC Copyright (C) 1999-2000 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 class idx : public basic
  36 {
  37     GINAC_DECLARE_REGISTERED_CLASS(idx, basic)
  38
  39 // member functions
  40
  41     // default constructor, destructor, copy constructor assignment operator and helpers
  42 public:
  43     idx();
  44     ~idx();
  45     idx (const idx & other);
  46     const idx & operator=(const idx & other);
  47 protected:
  48     void copy(const idx & other);
  49     void destroy(bool call_parent);
  50
  51     // other constructors
  52 public:
  53     explicit idx(bool cov);
  54     explicit idx(const string & n, bool cov=false);
  55     explicit idx(const char * n, bool cov=false);
  56     explicit idx(unsigned v, bool cov=false);
  57
  58     // functions overriding virtual functions from bases classes
  59 public:
  60     basic * duplicate() const;
  61     void printraw(ostream & os) const;
  62     void printtree(ostream & os, unsigned indent) const;
  63     void print(ostream & os, unsigned upper_precedence=0) const;
  64     bool info(unsigned inf) const;
  65 protected:
  66     int compare_same_type(const basic & other) const;
  67     bool is_equal_same_type(const basic & other) const;
  68     unsigned calchash(void) const;
  69     ex subs(const lst & ls, const lst & lr) const;
  70
  71     // new virtual functions which can be overridden by derived classes
  72 public:
  73     virtual bool is_co_contra_pair(const basic & other) const;
  74     virtual ex toggle_covariant(void) const;
  75
  76     // non-virtual functions in this class
  77 public:
  78     bool is_symbolic(void) const;
  79     unsigned get_value(void) const;
  80     bool is_covariant(void) const;
  81     void setname(const string & n) {name=n;}
  82     string getname(void) const {return name;}
  83
  84     // member variables
  85 protected:
  86     unsigned serial;
  87     bool symbolic;
  88     string name;
  89     unsigned value;
  90     static unsigned next_serial;
  91     bool covariant; // x_mu, default is contravariant: x^mu
  92 };
  93
  94 // global constants
  95
  96 extern const idx some_idx;
  97 extern const type_info & typeid_idx;
  98
  99 // utility functions
 100 inline const idx &ex_to_idx(const ex &e)
 101 {
 102         return static_cast<const idx &>(*e.bp);
 103 }
 104
 105 // global functions
 106
 107 // typedef vector<ex> exvector;
 108
 109 int canonicalize_indices(exvector & iv, bool antisymmetric=false);
 110 exvector idx_intersect(const exvector & iv1, const exvector & iv2);
 111 ex permute_free_index_to_front(const exvector & iv3, const exvector & iv2,
 112                                bool antisymmetric, int * sig);
 113 unsigned subs_index_in_exvector(exvector & v, const ex & is, const ex & ir);
 114 ex subs_indices(const ex & e, const exvector & idxv_contra,
 115                 const exvector & idxv_co);
 116 unsigned count_index(const ex & e, const ex & i);
 117
 118 #ifndef NO_NAMESPACE_GINAC
 119 } // namespace GiNaC
 120 #endif // ndef NO_NAMESPACE_GINAC
 121
 122 #endif // ndef __GINAC_IDX_H__