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 namespace GiNaC {
  31
  32 class lorentzidx : public idx
  33 {
  34     friend class simp_lor;
  35     friend class scalar_products;
  36
  37 // member functions
  38
  39     // default constructor, destructor, copy constructor assignment operator and helpers
  40 public:
  41     lorentzidx();
  42     ~lorentzidx();
  43     lorentzidx (lorentzidx const & other);
  44     lorentzidx const & operator=(lorentzidx const & other);
  45 protected:
  46     void copy(lorentzidx const & other);
  47     void destroy(bool call_parent);
  48
  49     // other constructors
  50 public:
  51     explicit lorentzidx(bool cov, bool oonly=false, unsigned dimp=0);
  52     explicit lorentzidx(string const & n, bool cov=false,
  53                         bool oonly=false, unsigned dimp=0);
  54     explicit lorentzidx(char const * n, bool cov=false,
  55                         bool oonly=false, unsigned dimp=0);
  56     explicit lorentzidx(unsigned const 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
  66     // new virtual functions which can be overridden by derived classes
  67     // none
  68
  69     // non-virtual functions in this class
  70 public:
  71     bool is_orthogonal_only(void) const { return orthogonal_only; }
  72     unsigned get_dim_parallel_space(void) const { return dim_parallel_space; }
  73     lorentzidx create_anonymous_representative(void) const;
  74
  75     // member variables
  76 protected:
  77     bool orthogonal_only;
  78     unsigned dim_parallel_space;
  79 };
  80
  81 // global constants
  82
  83 extern const lorentzidx some_lorentzidx;
  84 extern type_info const & typeid_lorentzidx;
  85
  86 // utility functions
  87 inline const lorentzidx &ex_to_lorentzidx(const ex &e)
  88 {
  89         return static_cast<const lorentzidx &>(*e.bp);
  90 }
  91
  92 } // namespace GiNaC
  93
  94 #endif // ndef __GINAC_LORENTZIDX_H__