* New funny timing added: compute an antipode in Yukawa theory.

[ginac.git] / ginac / coloridx.h

diff --git a/ginac/coloridx.h b/ginac/coloridx.h
index 92e6b1ff3dfcae4d5703d20aad6c3d91d0564a9d..ab78abb35fb2ca54664ceedce62eb942f98a1097 100644 (file)
--- a/ginac/coloridx.h
+++ b/ginac/coloridx.h
@@ -2,62 +2,77 @@
  *
  *  Interface to GiNaC's color indices. */
 
-#ifndef _COLORIDX_H_
-#define _COLORIDX_H_
+/*
+ *  GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
+ *
+ *  This program is free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation; either version 2 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+
+#ifndef __GINAC_COLORIDX_H__
+#define __GINAC_COLORIDX_H__
 
 #include <string>
 #include <vector>
-
 #include "idx.h"
+#include "ex.h"
+
+namespace GiNaC {
 
+
+/** Class of indices for color algebra objects, to tell them apart from
+ *  other index families like Lorentz indices. The color indices are the
+ *  indices of the SU(3) generators T_a, so they lie in the range of 0 to 7. 
+ *  Note that this kind of index is different from the indices carried by
+ *  elements of a specific matrix representation of su(3). Such indices are
+ *  always hidden in our implementation and we are not concerned with them. */
 class coloridx : public idx
 {
-    friend class color;
+       GINAC_DECLARE_REGISTERED_CLASS(coloridx, idx)
 
-// member functions
+       friend class color;
 
-    // default constructor, destructor, copy constructor assignment operator and helpers
-public:
-    coloridx();
-    ~coloridx();
-    coloridx (coloridx const & other);
-    coloridx const & operator=(coloridx const & other);
-protected:
-    void copy(coloridx const & other);
-    void destroy(bool call_parent);
-
-    // other constructors
+       // other constructors
 public:
-    explicit coloridx(bool cov);
-    explicit coloridx(string const & n, bool cov=false);
-    explicit coloridx(char const * n, bool cov=false);
-    explicit coloridx(unsigned const v, bool cov=false); 
+       explicit coloridx(bool cov);
+       explicit coloridx(const std::string & n, bool cov=false);
+       explicit coloridx(const char * n, bool cov=false);
+       explicit coloridx(unsigned v, bool cov=false); 
 
-    // functions overriding virtual functions from bases classes
+       // functions overriding virtual functions from bases classes
 public:
-    basic * duplicate() const;
-    void printraw(ostream & os) const;
-    void printtree(ostream & os, unsigned indent) const;
-    void print(ostream & os, unsigned upper_precedence=0) const;
-    bool info(unsigned inf) const;
+       void printraw(std::ostream & os) const;
+       void printtree(std::ostream & os, unsigned indent) const;
+       void print(std::ostream & os, unsigned upper_precedence=0) const;
+       bool info(unsigned inf) const;
 
-    // new virtual functions which can be overridden by derived classes
-    // none
+       // new virtual functions which can be overridden by derived classes
+       // none
 
-    // non-virtual functions in this class
-    // none
+       // non-virtual functions in this class
+       // none
 
-    // member variables
-    // none
+       // member variables
+       // none
 };
 
-// global constants
-
-extern const coloridx some_coloridx;
-extern type_info const & typeid_coloridx;
-
-// macros
+// utility functions
+inline const coloridx &ex_to_coloridx(const ex &e)
+{
+       return static_cast<const coloridx &>(*e.bp);
+}
 
-#define ex_to_coloridx(X) (static_cast<coloridx const &>(*(X).bp))
+} // namespace GiNaC
 
-#endif // ndef _COLORIDX_H_
+#endif // ndef __GINAC_COLORIDX_H__