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 namespace GiNaC {
  32
  33
  34 /** Class of indices for color algebra objects, to tell them apart from
  35  *  other index families like Lorentz indices. The color indices are the
  36  *  indices of the SU(3) generators T_a, so they lie in the range of 0 to 7.
  37  *  Note that this kind of index is different from the indices carried by
  38  *  elements of a specific matrix representation of su(3). Such indices are
  39  *  always hidden in our implementation and we are not concerned with them. */
  40 class coloridx : public idx
  41 {
  42         GINAC_DECLARE_REGISTERED_CLASS(coloridx, idx)
  43
  44         friend class color;
  45
  46         // other constructors
  47 public:
  48         explicit coloridx(bool cov);
  49         explicit coloridx(const std::string & n, bool cov=false);
  50         explicit coloridx(const char * n, bool cov=false);
  51         explicit coloridx(unsigned v, bool cov=false);
  52
  53         // functions overriding virtual functions from bases classes
  54 public:
  55         void printraw(std::ostream & os) const;
  56         void printtree(std::ostream & os, unsigned indent) const;
  57         void print(std::ostream & os, unsigned upper_precedence=0) const;
  58         bool info(unsigned inf) const;
  59
  60         // new virtual functions which can be overridden by derived classes
  61         // none
  62
  63         // non-virtual functions in this class
  64         // none
  65
  66         // member variables
  67         // none
  68 };
  69
  70 // utility functions
  71 inline const coloridx &ex_to_coloridx(const ex &e)
  72 {
  73         return static_cast<const coloridx &>(*e.bp);
  74 }
  75
  76 } // namespace GiNaC
  77
  78 #endif // ndef __GINAC_COLORIDX_H__