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 /** Class of indices for color algebra (SU(3)) objects, to tell them apart
  36  *  from other index families like Lorentz indices. */
  37 class coloridx : public idx
  38 {
  39         GINAC_DECLARE_REGISTERED_CLASS(coloridx, idx)
  40
  41         friend class color;
  42
  43 // member functions
  44
  45         // default constructor, destructor, copy constructor assignment operator and helpers
  46 public:
  47         coloridx();
  48         ~coloridx();
  49         coloridx (const coloridx & other);
  50         const coloridx & operator=(const coloridx & other);
  51 protected:
  52         void copy(const coloridx & other);
  53         void destroy(bool call_parent);
  54
  55         // other constructors
  56 public:
  57         explicit coloridx(bool cov);
  58         explicit coloridx(const std::string & n, bool cov=false);
  59         explicit coloridx(const char * n, bool cov=false);
  60         explicit coloridx(unsigned v, bool cov=false);
  61
  62         // functions overriding virtual functions from bases classes
  63 public:
  64         basic * duplicate() const;
  65         void printraw(std::ostream & os) const;
  66         void printtree(std::ostream & os, unsigned indent) const;
  67         void print(std::ostream & os, unsigned upper_precedence=0) const;
  68         bool info(unsigned inf) const;
  69
  70         // new virtual functions which can be overridden by derived classes
  71         // none
  72
  73         // non-virtual functions in this class
  74         // none
  75
  76         // member variables
  77         // none
  78 };
  79
  80 // global constants
  81
  82 extern const coloridx some_coloridx;
  83 extern const std::type_info & typeid_coloridx;
  84
  85 // utility functions
  86 inline const coloridx &ex_to_coloridx(const ex &e)
  87 {
  88         return static_cast<const coloridx &>(*e.bp);
  89 }
  90
  91 #ifndef NO_NAMESPACE_GINAC
  92 } // namespace GiNaC
  93 #endif // ndef NO_NAMESPACE_GINAC
  94
  95 #endif // ndef __GINAC_COLORIDX_H__