fixed typos
[ginac.git] / ginac / clifford.h
index 3fa3627d0dd6b9d131c4d0700ba4e01127650026..667d7befd9d400749188f8af6f28bcecee1ce83e 100644 (file)
@@ -35,7 +35,7 @@ namespace GiNaC {
  *  algebra (the Dirac gamma matrices). These objects only carry Lorentz
  *  indices. Spinor indices are hidden. A representation label (an unsigned
  *  8-bit integer) is used to distinguish elements from different Clifford
- *  algebras (objects with different labels commute). */
+ *  algebras (objects with different labels commutate). */
 class clifford : public indexed
 {
        GINAC_DECLARE_REGISTERED_CLASS(clifford, indexed)
@@ -46,8 +46,8 @@ public:
        clifford(const ex & b, const ex & mu,  const ex & metr, unsigned char rl = 0);
 
        // internal constructors
-       clifford(unsigned char rl, const exvector & v, bool discardable = false,  const ex & metr = lorentz_g(varidx((new symbol)->setflag(status_flags::dynallocated), 4),varidx((new symbol)->setflag(status_flags::dynallocated), 4)));
-       clifford(unsigned char rl, std::auto_ptr<exvector> vp,  const ex & metr = lorentz_g(varidx((new symbol)->setflag(status_flags::dynallocated),4),varidx((new symbol)->setflag(status_flags::dynallocated),4)));
+       clifford(unsigned char rl, const ex & metr, const exvector & v, bool discardable = false);
+       clifford(unsigned char rl, const ex & metr, std::auto_ptr<exvector> vp);
 
        // functions overriding virtual functions from base classes
 protected:
@@ -60,10 +60,10 @@ protected:
 
        // non-virtual functions in this class
 public:
-       unsigned char get_representation_label() const {return representation_label;}
-       ex get_metric() const {return metric;}
-       ex get_metric(const ex & i, const ex & j) const;
-       bool same_metric(const ex & other) const;
+       unsigned char get_representation_label() const { return representation_label; }
+       ex get_metric() const { return metric; }
+       ex get_metric(const ex & i, const ex & j) const;
+       bool same_metric(const ex & other) const;
 
 protected:
        void do_print_dflt(const print_dflt & c, unsigned level) const;
@@ -72,7 +72,7 @@ protected:
        // member variables
 private:
        unsigned char representation_label; /**< Representation label to distinguish independent spin lines */
-       ex metric;
+       ex metric;
 };
 
 
@@ -93,13 +93,14 @@ class cliffordunit : public tensor
 {
        GINAC_DECLARE_REGISTERED_CLASS(cliffordunit, tensor)
 
-         // other constructors
+       // other constructors
 protected:
-        cliffordunit(unsigned ti) : inherited(ti) {}
+       cliffordunit(unsigned ti) : inherited(ti) {}
                                                                                                     
        // functions overriding virtual functions from base classes
 public:
        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;
@@ -123,7 +124,7 @@ protected:
 };
 
 
-/** This class represents the Dirac gamma5 object which anticommutes with
+/** This class represents the Dirac gamma5 object which anticommutates with
  *  all other gammas. */
 class diracgamma5 : public tensor
 {
@@ -188,7 +189,7 @@ ex dirac_ONE(unsigned char rl = 0);
 /** Create a Clifford unit object.
  *
  *  @param mu Index (must be of class varidx or a derived class)
- *  @param metr Metric (must be of class tensor or a derived class)
+ *  @param metr Metric (should be of class tensmetric or a derived class, or a symmetric matrix)
  *  @param rl Representation label
  *  @return newly constructed Clifford unit object */
 ex clifford_unit(const ex & mu, const ex & metr, unsigned char rl = 0);
@@ -241,32 +242,33 @@ ex dirac_trace(const ex & e, unsigned char rl = 0, const ex & trONE = 4);
  *  to check two expressions for equality. */
 ex canonicalize_clifford(const ex & e);
 
-/** Automorphism of the Clifford algebra, simply changes signs of all 
+/** Automorphism of the Clifford algebra, simply changes signs of all
  *  clifford units. */
-ex clifford_prime (const ex &e) ;
+ex clifford_prime(const ex & e);
 
-/** Main anti-automorphism of the Clifford algebra: make reversion 
- * and changes signs of all clifford units*/
-inline ex clifford_bar(const ex &e) { return clifford_prime(e.conjugate());};
+/** Main anti-automorphism of the Clifford algebra: makes reversion
+ *  and changes signs of all clifford units. */
+inline ex clifford_bar(const ex & e) { return clifford_prime(e.conjugate()); }
 
-/** Reversion of the Clifford algebra, coinsides with the conjugate() */
-inline ex clifford_star(const ex &e) {  return e.conjugate();};
+/** Reversion of the Clifford algebra, coincides with the conjugate(). */
+inline ex clifford_star(const ex & e) { return e.conjugate(); }
 
-ex delete_ONE (const ex &e);
+ex delete_ONE(const ex &e);
 
-/** Calculation of the norm in the Clifford algebra */
-ex clifford_norm(const ex &e) ; 
+/** Calculation of the norm in the Clifford algebra. */
+ex clifford_norm(const ex & e);
 
-/** Calculation of the inverse in the Clifford algebra */
-ex clifford_inverse(const ex &e) ; 
+/** Calculation of the inverse in the Clifford algebra. */
+ex clifford_inverse(const ex & e);
 
-/** List or vector conversion into the Clifford vector 
+/** List or vector conversion into the Clifford vector.
+ *
  *  @param v List or vector of coordinates
  *  @param mu Index (must be of class varidx or a derived class)
- *  @param metr Metric (must be of class tensor or a derived class) 
+ *  @param metr Metric (should be of class tensmetric or a derived class, or a symmetric matrix)
  *  @param rl Representation label
  *  @return Clifford vector with given components */
-ex lst_to_clifford(const ex &v, const ex &mu,  const ex &metr, unsigned char rl = 0) ;
+ex lst_to_clifford(const ex & v, const ex & mu,  const ex & metr, unsigned char rl = 0);
 
 } // namespace GiNaC