fixed typos
[ginac.git] / ginac / color.h
index 04d7c5d9e88c106869d37c2e025c3b1fe5e7faa9..2086909e1304dd1c7a35ac9e53c658263150348c 100644 (file)
@@ -3,7 +3,7 @@
  *  Interface to GiNaC's color (SU(3) Lie algebra) objects. */
 
 /*
- *  GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2004 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
@@ -33,7 +33,7 @@ namespace GiNaC {
  *  of SU(3), as used for calculations in quantum chromodynamics. A
  *  representation label (an unsigned 8-bit integer) is used to distinguish
  *  elements from different Lie algebras (objects with different labels
- *  commute). These objects implement an abstract representation of the
+ *  commutate). These objects implement an abstract representation of the
  *  group, not a specific matrix representation. The indices used for color
  *  objects should not have a variance. */
 class color : public indexed
@@ -47,15 +47,20 @@ public:
 
        // internal constructors
        color(unsigned char rl, const exvector & v, bool discardable = false);
-       color(unsigned char rl, exvector * vp); // vp will be deleted
+       color(unsigned char rl, std::auto_ptr<exvector> vp);
 
        // functions overriding virtual functions from base classes
 protected:
-       ex simplify_ncmul(const exvector & v) const;
-       ex thisexprseq(const exvector & v) const;
-       ex thisexprseq(exvector * vp) const;
-       unsigned return_type(void) const { return return_types::noncommutative; }
-       unsigned return_type_tinfo(void) const { return TINFO_color + representation_label; }
+       ex eval_ncmul(const exvector & v) const;
+       bool match_same_type(const basic & other) const;
+       ex thiscontainer(const exvector & v) const;
+       ex thiscontainer(std::auto_ptr<exvector> vp) const;
+       unsigned return_type() const { return return_types::noncommutative; }
+       unsigned return_type_tinfo() const { return TINFO_color + representation_label; }
+
+       // non-virtual functions in this class
+public:
+       unsigned char get_representation_label() const {return representation_label;}
 
        // member variables
 private:
@@ -68,9 +73,10 @@ class su3one : public tensor
 {
        GINAC_DECLARE_REGISTERED_CLASS(su3one, tensor)
 
-       // functions overriding virtual functions from bases classes
-public:
-       void print(const print_context & c, unsigned level = 0) const;
+       // non-virtual functions in this class
+protected:
+       void do_print(const print_context & c, unsigned level) const;
+       void do_print_latex(const print_latex & c, unsigned level) const;
 };
 
 /** This class represents an su(3) generator. */
@@ -78,9 +84,14 @@ class su3t : public tensor
 {
        GINAC_DECLARE_REGISTERED_CLASS(su3t, tensor)
 
-       // functions overriding virtual functions from bases classes
+       // functions overriding virtual functions from base classes
 public:
-       void print(const print_context & c, unsigned level = 0) const;
+       bool contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const;
+
+       // non-virtual functions in this class
+protected:
+       void do_print(const print_context & c, unsigned level) const;
+       void do_print_latex(const print_latex & c, unsigned level) const;
 };
 
 /** This class represents the tensor of antisymmetric su(3) structure
@@ -89,11 +100,15 @@ class su3f : public tensor
 {
        GINAC_DECLARE_REGISTERED_CLASS(su3f, tensor)
 
-       // functions overriding virtual functions from bases classes
+       // functions overriding virtual functions from base classes
 public:
-       void print(const print_context & c, unsigned level = 0) const;
        ex eval_indexed(const basic & i) const;
        bool contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const;
+
+       // non-virtual functions in this class
+protected:
+       void do_print(const print_context & c, unsigned level) const;
+       void do_print_latex(const print_latex & c, unsigned level) const;
 };
 
 /** This class represents the tensor of symmetric su(3) structure constants. */
@@ -101,21 +116,26 @@ class su3d : public tensor
 {
        GINAC_DECLARE_REGISTERED_CLASS(su3d, tensor)
 
-       // functions overriding virtual functions from bases classes
+       // functions overriding virtual functions from base classes
 public:
-       void print(const print_context & c, unsigned level = 0) const;
        ex eval_indexed(const basic & i) const;
        bool contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const;
+
+       // non-virtual functions in this class
+protected:
+       void do_print(const print_context & c, unsigned level) const;
+       void do_print_latex(const print_latex & c, unsigned level) const;
 };
 
 
 // global functions
-inline const color &ex_to_color(const ex &e)
+
+/** Specialization of is_exactly_a<color>(obj) for color objects. */
+template<> inline bool is_exactly_a<color>(const basic & obj)
 {
-       return static_cast<const color &>(*e.bp);
+       return obj.tinfo()==TINFO_color;
 }
 
-
 /** Create the su(3) unity element. This is an indexed object, although it
  *  has no indices.
  *
@@ -149,6 +169,13 @@ ex color_d(const ex & a, const ex & b, const ex & c);
 /** This returns the linear combination d.a.b.c+I*f.a.b.c. */
 ex color_h(const ex & a, const ex & b, const ex & c);
 
+/** Calculate the trace of an expression containing color objects with a
+ *  specified representation label.
+ *
+ *  @param e Expression to take the trace of
+ *  @param rl Representation label */
+ex color_trace(const ex & e, unsigned char rl = 0);
+
 
 } // namespace GiNaC