ginac/lorentzidx.h

   1 /** @file lorentzidx.h
   2  *
   3  *  Interface to GiNaC's lorentz indices. */
   4
   5 /*
   6  *  GiNaC Copyright (C) 1999 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 <ginac/idx.h>
  29
  30 #ifndef NO_GINAC_NAMESPACE
  31 namespace GiNaC {
  32 #endif // ndef NO_GINAC_NAMESPACE
  33
  34 class lorentzidx : public idx
  35 {
  36     friend class simp_lor;
  37     friend class scalar_products;
  38
  39 // member functions
  40
  41     // default constructor, destructor, copy constructor assignment operator and helpers
  42 public:
  43     lorentzidx();
  44     ~lorentzidx();
  45     lorentzidx (lorentzidx const & other);
  46     lorentzidx const & operator=(lorentzidx const & other);
  47 protected:
  48     void copy(lorentzidx const & other);
  49     void destroy(bool call_parent);
  50
  51     // other constructors
  52 public:
  53     explicit lorentzidx(bool cov, bool oonly=false, unsigned dimp=0);
  54     explicit lorentzidx(string const & n, bool cov=false,
  55                         bool oonly=false, unsigned dimp=0);
  56     explicit lorentzidx(char const * n, bool cov=false,
  57                         bool oonly=false, unsigned dimp=0);
  58     explicit lorentzidx(unsigned const v, bool cov=false);
  59
  60     // functions overriding virtual functions from bases classes
  61 public:
  62     basic * duplicate() const;
  63     void printraw(ostream & os) const;
  64     void printtree(ostream & os, unsigned indent) const;
  65     void print(ostream & os, unsigned upper_precedence=0) const;
  66     bool info(unsigned inf) const;
  67
  68     // new virtual functions which can be overridden by derived classes
  69     // none
  70
  71     // non-virtual functions in this class
  72 public:
  73     bool is_orthogonal_only(void) const { return orthogonal_only; }
  74     unsigned get_dim_parallel_space(void) const { return dim_parallel_space; }
  75     lorentzidx create_anonymous_representative(void) const;
  76
  77     // member variables
  78 protected:
  79     bool orthogonal_only;
  80     unsigned dim_parallel_space;
  81 };
  82
  83 // global constants
  84
  85 extern const lorentzidx some_lorentzidx;
  86 extern type_info const & typeid_lorentzidx;
  87
  88 // utility functions
  89 inline const lorentzidx &ex_to_lorentzidx(const ex &e)
  90 {
  91         return static_cast<const lorentzidx &>(*e.bp);
  92 }
  93
  94 #ifndef NO_GINAC_NAMESPACE
  95 } // namespace GiNaC
  96 #endif // ndef NO_GINAC_NAMESPACE
  97
  98 #endif // ndef __GINAC_LORENTZIDX_H__