ginac/coloridx.h

   1 /** @file coloridx.h
   2  *
   3  *  Interface to GiNaC's color 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_COLORIDX_H__
  24 #define __GINAC_COLORIDX_H__
  25
  26 #include <string>
  27 #include <vector>
  28 #include "idx.h"
  29 #include "ex.h"
  30
  31 #ifndef NO_NAMESPACE_GINAC
  32 namespace GiNaC {
  33 #endif // ndef NO_NAMESPACE_GINAC
  34
  35
  36 /** Class of indices for color algebra objects, to tell them apart from
  37  *  other index families like Lorentz indices. The color indices are the
  38  *  indices of the SU(3) generators T_a, so they lie in the range of 0 to 7.
  39  *  Note that this kind of index is different from the indices carried by
  40  *  elements of a specific matrix representation of su(3). Such indices are
  41  *  always hidden in our implementation and we are not concerned with them. */
  42 class coloridx : public idx
  43 {
  44         GINAC_DECLARE_REGISTERED_CLASS(coloridx, idx)
  45
  46         friend class color;
  47
  48 // member functions
  49
  50         // default constructor, destructor, copy constructor assignment operator and helpers
  51 public:
  52         coloridx();
  53         ~coloridx();
  54         coloridx (const coloridx & other);
  55         const coloridx & operator=(const coloridx & other);
  56 protected:
  57         void copy(const coloridx & other);
  58         void destroy(bool call_parent);
  59
  60         // other constructors
  61 public:
  62         explicit coloridx(bool cov);
  63         explicit coloridx(const std::string & n, bool cov=false);
  64         explicit coloridx(const char * n, bool cov=false);
  65         explicit coloridx(unsigned v, bool cov=false);
  66
  67         // functions overriding virtual functions from bases classes
  68 public:
  69         basic * duplicate() const;
  70         void printraw(std::ostream & os) const;
  71         void printtree(std::ostream & os, unsigned indent) const;
  72         void print(std::ostream & os, unsigned upper_precedence=0) const;
  73         bool info(unsigned inf) const;
  74
  75         // new virtual functions which can be overridden by derived classes
  76         // none
  77
  78         // non-virtual functions in this class
  79         // none
  80
  81         // member variables
  82         // none
  83 };
  84
  85 // global constants
  86
  87 extern const coloridx some_coloridx;
  88 extern const std::type_info & typeid_coloridx;
  89
  90 // utility functions
  91 inline const coloridx &ex_to_coloridx(const ex &e)
  92 {
  93         return static_cast<const coloridx &>(*e.bp);
  94 }
  95
  96 #ifndef NO_NAMESPACE_GINAC
  97 } // namespace GiNaC
  98 #endif // ndef NO_NAMESPACE_GINAC
  99
 100 #endif // ndef __GINAC_COLORIDX_H__