ginac/lorentzidx.h

   1 /** @file lorentzidx.h
   2  *
   3  *  Interface to GiNaC's Lorentz 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_LORENTZIDX_H__
  24 #define __GINAC_LORENTZIDX_H__
  25
  26 #include <string>
  27 #include <vector>
  28 #include "idx.h"
  29
  30 #ifndef NO_NAMESPACE_GINAC
  31 namespace GiNaC {
  32 #endif // ndef NO_NAMESPACE_GINAC
  33
  34
  35 /** Class of indices for Lorentz tensors, to tell them apart from other
  36  *  index families like color indices. The indices of this class also
  37  *  support the case of P-O-decomposed D-dimensional spacetime, where the
  38  *  parallel space is a Minkowski space with integral dimension P and the
  39  *  orthogonal space is a Euclidean space with (possibly complex) dimension
  40  *  D-P. The dimension D of spacetime is represented by the global symbol
  41  *  that is returned by the Dim() function. */
  42 class lorentzidx : public idx
  43 {
  44         GINAC_DECLARE_REGISTERED_CLASS(lorentzidx, idx)
  45
  46         friend class simp_lor;
  47         friend class scalar_products;
  48
  49 // member functions
  50
  51         // default constructor, destructor, copy constructor assignment operator and helpers
  52 public:
  53         lorentzidx();
  54         ~lorentzidx();
  55         lorentzidx (const lorentzidx & other);
  56         const lorentzidx & operator=(const lorentzidx & other);
  57 protected:
  58         void copy(const lorentzidx & other);
  59         void destroy(bool call_parent);
  60
  61         // other constructors
  62 public:
  63         explicit lorentzidx(bool cov, bool oonly=false, unsigned dimp=0);
  64         explicit lorentzidx(const std::string & n, bool cov=false,
  65                             bool oonly=false, unsigned dimp=0);
  66         explicit lorentzidx(const char * n, bool cov=false,
  67                             bool oonly=false, unsigned dimp=0);
  68         explicit lorentzidx(unsigned v, bool cov=false);
  69
  70         // functions overriding virtual functions from bases classes
  71 public:
  72         basic * duplicate() const;
  73         void printraw(std::ostream & os) const;
  74         void printtree(std::ostream & os, unsigned indent) const;
  75         void print(std::ostream & os, unsigned upper_precedence=0) const;
  76         bool info(unsigned inf) const;
  77
  78         // new virtual functions which can be overridden by derived classes
  79         // none
  80
  81         // non-virtual functions in this class
  82 public:
  83         /** Check whether index only lives in orthogonal space. */
  84         bool is_orthogonal_only(void) const {return orthogonal_only;}
  85
  86         /** Return dimension of parallel space. */
  87         unsigned get_dim_parallel_space(void) const {return dim_parallel_space;}
  88
  89         lorentzidx create_anonymous_representative(void) const;
  90
  91         // member variables
  92 protected:
  93         bool orthogonal_only;        /**< Symbolic index only lives in orthogonal space? */
  94         unsigned dim_parallel_space; /**< Dimension of parallel space */
  95 };
  96
  97 // global constants
  98
  99 extern const lorentzidx some_lorentzidx;
 100 extern const std::type_info & typeid_lorentzidx;
 101
 102 // utility functions
 103 inline const lorentzidx &ex_to_lorentzidx(const ex &e)
 104 {
 105         return static_cast<const lorentzidx &>(*e.bp);
 106 }
 107
 108 ex Dim(void);
 109
 110 #ifndef NO_NAMESPACE_GINAC
 111 } // namespace GiNaC
 112 #endif // ndef NO_NAMESPACE_GINAC
 113
 114 #endif // ndef __GINAC_LORENTZIDX_H__