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

[ginac.git] / ginac / color.h

diff --git a/ginac/color.h b/ginac/color.h
index 46ac986c381e493b88adfd81a0be47dfc959428d..4d4169a7ab119c597f4fdd6bf7880b5181a0a022 100644 (file)
--- a/ginac/color.h
+++ b/ginac/color.h
@@ -28,9 +28,7 @@
 #include "indexed.h"
 #include "ex.h"
 
-#ifndef NO_NAMESPACE_GINAC
 namespace GiNaC {
-#endif // ndef NO_NAMESPACE_GINAC
 
 const unsigned MAX_REPRESENTATION_LABELS = 4;
 const unsigned COLOR_EIGHT = 8; // N*N-1
@@ -44,7 +42,15 @@ typedef std::vector<exvector,malloc_alloc> exvectorvector;
 typedef std::vector<exvector> exvectorvector;
 #endif
 
-/** Base class for color object */
+
+/** This class holds an object carrying color indices (of class coloridx). 
+ *  It can represent the generators T_a and structure constants f_abc/d_abc
+ *  of SU(3), the unity element ONE of the Lie algebra of SU(3), or the
+ *  unity matrix delta8. Together, these objects are used to implement the
+ *  Lie algebra su(3), as required for calculations in quantum
+ *  chromodynamics. A representation label (an unsigned integer) is used to
+ *  distinguish elements from different Lie algebras (only objects with the
+ *  same representation label "interact" with each other). */
 class color : public indexed
 {
        GINAC_DECLARE_REGISTERED_CLASS(color, indexed)
@@ -71,31 +77,21 @@ class color : public indexed
        friend ex simplify_pure_color_string(const ex & e);
        friend ex simplify_color(const ex & e);
 
-       
 // types
 
 public:
+       /** Type of object */
        typedef enum {
-               invalid,        // not properly constructed by one of the friend functions
-               color_T,
-               color_f,
-               color_d,
-               color_delta8,
-               color_ONE
+               invalid,      /**< not properly constructed */
+               color_T,      /**< one of the generators T_a of SU(3) (these are non-commutative) */
+               color_f,      /**< one of the antisymmetric structure constants f_abc of SU(3) */
+               color_d,      /**< one of the symmetric structure constants d_abc of SU(3) */
+               color_delta8, /**< the unity matrix */
+               color_ONE     /**< the unity element of su(3) */
        } color_types;
        
 // member functions
 
-       // default constructor, destructor, copy constructor assignment operator and helpers
-public:
-       color();
-       ~color();
-       color(const color & other);
-       const color & operator=(const color & other);
-protected:
-       void copy(const color & other); 
-       void destroy(bool call_parent);
-
        // other constructors
 protected:
        color(color_types const t, unsigned rl=0);
@@ -108,15 +104,12 @@ protected:
        
        // functions overriding virtual functions from base classes
 public:
-       basic * duplicate() 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;
-       void printcsrc(std::ostream & os, unsigned type, unsigned upper_precedence=0) const;
        bool info(unsigned inf) const;
        ex eval(int level=0) const;
 protected:
-       int compare_same_type(const basic & other) const;
        bool is_equal_same_type(const basic & other) const;
        ex simplify_ncmul(const exvector & v) const;
        ex thisexprseq(const exvector & v) const;
@@ -132,15 +125,10 @@ protected:
 // member variables
 
 protected:
-       color_types type;
-       unsigned representation_label; // to distiguish independent color matrices coming from separated fermion lines
+       color_types type; /**< Type of object (generator, structure constant etc.) */
+       unsigned representation_label; /**< Representation label to distiguish independent color matrices coming from separated fermion lines */
 };
 
-// global constants
-
-extern const color some_color;
-extern const std::type_info & typeid_color;
-
 // global functions
 inline const color &ex_to_color(const ex &e)
 {
@@ -173,10 +161,6 @@ ex simplify_color(const ex & e);
 
 ex brute_force_sum_color_indices(const ex & e);
 
-void append_exvector_to_exvector(exvector & dest, const exvector & source);
-
-#ifndef NO_NAMESPACE_GINAC
 } // namespace GiNaC
-#endif // ndef NO_NAMESPACE_GINAC
 
 #endif // ndef __GINAC_COLOR_H__