ginac/coloridx.h

   1 /** @file coloridx.h
   2  *
   3  *  Interface to GiNaC's color indices. */
   4
   5 /*
   6  *  GiNaC Copyright (C) 1999-2000 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_GINAC_NAMESPACE
  32 namespace GiNaC {
  33 #endif // ndef NO_GINAC_NAMESPACE
  34
  35 class coloridx : public idx
  36 {
  37     GINAC_DECLARE_REGISTERED_CLASS(coloridx, idx)
  38
  39     friend class color;
  40
  41 // member functions
  42
  43     // default constructor, destructor, copy constructor assignment operator and helpers
  44 public:
  45     coloridx();
  46     ~coloridx();
  47     coloridx (const coloridx & other);
  48     const coloridx & operator=(const coloridx & other);
  49 protected:
  50     void copy(const coloridx & other);
  51     void destroy(bool call_parent);
  52
  53     // other constructors
  54 public:
  55     explicit coloridx(bool cov);
  56     explicit coloridx(const string & n, bool cov=false);
  57     explicit coloridx(const char * n, bool cov=false);
  58     explicit coloridx(unsigned 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     // none
  73
  74     // member variables
  75     // none
  76 };
  77
  78 // global constants
  79
  80 extern const coloridx some_coloridx;
  81 extern const type_info & typeid_coloridx;
  82
  83 // utility functions
  84 inline const coloridx &ex_to_coloridx(const ex &e)
  85 {
  86         return static_cast<const coloridx &>(*e.bp);
  87 }
  88
  89 #ifndef NO_GINAC_NAMESPACE
  90 } // namespace GiNaC
  91 #endif // ndef NO_GINAC_NAMESPACE
  92
  93 #endif // ndef __GINAC_COLORIDX_H__