]> www.ginac.de Git - ginac.git/blobdiff - ginac/clifford.h
Improved the comments explaining what the class ex does.
[ginac.git] / ginac / clifford.h
index 0f0ebfa42cdffd7c06b5abbb54a57223396ee47f..2d33631d0cad07930152550caf55515c8aae7fc9 100644 (file)
@@ -3,7 +3,7 @@
  *  Interface to GiNaC's clifford algebra (Dirac gamma) objects. */
 
 /*
- *  GiNaC Copyright (C) 1999-2005 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2006 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
@@ -17,7 +17,7 @@
  *
  *  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
+ *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
 
 #ifndef __GINAC_CLIFFORD_H__
@@ -41,43 +41,55 @@ namespace GiNaC {
 class clifford : public indexed
 {
        GINAC_DECLARE_REGISTERED_CLASS(clifford, indexed)
+public:
+       static const tinfo_static_t return_type_tinfo_static[256];
 
        // other constructors
 public:
-       clifford(const ex & b, unsigned char rl = 0);
-       clifford(const ex & b, const ex & mu,  const ex & metr, unsigned char rl = 0);
+       clifford(const ex & b, unsigned char rl = 0, bool anticommut = false);
+       clifford(const ex & b, const ex & mu,  const ex & metr, unsigned char rl = 0, bool anticommut = false, int comm_sign = -1);
 
        // internal constructors
-       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);
+       clifford(unsigned char rl, const ex & metr, bool anticommut, int comm_sign, const exvector & v, bool discardable = false);
+       clifford(unsigned char rl, const ex & metr, bool anticommut, int comm_sign, std::auto_ptr<exvector> vp);
 
        // functions overriding virtual functions from base classes
+public:
+       unsigned precedence() const { return 65; }
 protected:
        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_clifford + representation_label; }
+       tinfo_t return_type_tinfo() const { return clifford::return_type_tinfo_static+representation_label; }
 
        // 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;
+       virtual ex get_metric(const ex & i, const ex & j, bool symmetrised = false) const;
        bool same_metric(const ex & other) const;
+       bool is_anticommuting() const { return anticommuting; } //**< See the member variable anticommuting */
+       int get_commutator_sign() const { return commutator_sign; } //**< See the member variable commutator_sign */
+
+       inline size_t nops() const {return inherited::nops() + 1; }
+       ex op(size_t i) const;
+       ex & let_op(size_t i);
+       ex subs(const exmap & m, unsigned options = 0) const;
 
 protected:
        void do_print_dflt(const print_dflt & c, unsigned level) const;
        void do_print_latex(const print_latex & c, unsigned level) const;
 
        // member variables
-private:
+protected:
        unsigned char representation_label; /**< Representation label to distinguish independent spin lines */
-       ex metric;
+       ex metric; /**< Metric of the space, all constructors make it an indexed object */
+       bool anticommuting; /**< Simplifications for anticommuting units is much simpler and we need this info readily available */
+       int commutator_sign; /**< It is the sign in the definition e~i e~j +/- e~j e~i = B(i, j) + B(j, i)*/
 };
 
-
 /** This class represents the Clifford algebra unity element. */
 class diracone : public tensor
 {
@@ -97,7 +109,7 @@ class cliffordunit : public tensor
 
        // other constructors
 protected:
-       cliffordunit(unsigned ti) : inherited(ti) {}
+       cliffordunit(tinfo_t ti) : inherited(ti) {}
                                                                                                     
        // functions overriding virtual functions from base classes
 public:
@@ -176,11 +188,11 @@ protected:
 
 // global functions
 
-/** Specialization of is_exactly_a<clifford>(obj) for clifford objects. */
-template<> inline bool is_exactly_a<clifford>(const basic & obj)
-{
-       return obj.tinfo()==TINFO_clifford;
-}
+/** Check whether a given tinfo key (as returned by return_type_tinfo()
+  * is that of a clifford object (with an arbitrary representation label).
+  *
+  * @param ti tinfo key */
+bool is_clifford_tinfo(tinfo_t ti);
 
 /** Create a Clifford unity object.
  *
@@ -191,10 +203,10 @@ 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 (should be of class tensmetric or a derived class, or a symmetric matrix)
+ *  @param metr Metric (should be indexed, tensmetric or a derived class, or a matrix)
  *  @param rl Representation label
  *  @return newly constructed Clifford unit object */
-ex clifford_unit(const ex & mu, const ex & metr, unsigned char rl = 0);
+ex clifford_unit(const ex & mu, const ex & metr, unsigned char rl = 0, bool anticommuting = false);
 
 /** Create a Dirac gamma object.
  *
@@ -275,8 +287,21 @@ inline ex clifford_bar(const ex & e) { return clifford_prime(e.conjugate()); }
 /** Reversion of the Clifford algebra, coincides with the conjugate(). */
 inline ex clifford_star(const ex & e) { return e.conjugate(); }
 
-/** Replaces all dirac_ONE's in e with 1 (effectively removing them). */
-ex remove_dirac_ONE(const ex & e);
+/** Replaces dirac_ONE's (with a representation_label no less than rl) in e with 1.
+ *  For the default value rl = 0 remove all of them. Aborts if e contains any 
+ *  clifford_unit with representation_label to be removed.
+ *
+ *  @param e Expression to be processed
+ *  @param rl Value of representation label 
+ *  @param options Defines some internal use */
+ex remove_dirac_ONE(const ex & e, unsigned char rl = 0, unsigned options = 0);
+
+/** Returns the maximal representation label of a clifford object 
+ *  if e contains at least one, otherwise returns -1 
+ *
+ *  @param e Expression to be processed
+ *  @ignore_ONE defines if clifford_ONE should be ignored in the search*/
+char clifford_max_label(const ex & e, bool ignore_ONE = false);
 
 /** Calculation of the norm in the Clifford algebra. */
 ex clifford_norm(const ex & e);
@@ -288,10 +313,12 @@ ex clifford_inverse(const ex & e);
  *
  *  @param v List or vector of coordinates
  *  @param mu Index (must be of class varidx or a derived class)
- *  @param metr Metric (should be of class tensmetric or a derived class, or a symmetric matrix)
+ *  @param metr Metric (should be indexed, tensmetric or a derived class, or a matrix)
  *  @param rl Representation label
+ *  @param e Clifford unit object
  *  @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, bool anticommuting = false);
+ex lst_to_clifford(const ex & v, const ex & e);
 
 /** An inverse function to lst_to_clifford(). For given Clifford vector extracts
  *  its components with respect to given Clifford unit. Obtained components may 
@@ -301,7 +328,8 @@ ex lst_to_clifford(const ex & v, const ex & mu,  const ex & metr, unsigned char
  *  
  *  @param e Clifford expression to be decomposed into components
  *  @param c Clifford unit defining the metric for splitting (should have numeric dimension of indices)
- *  @param algebraic Use algebraic or symbolic algorithm for extractions */
+ *  @param algebraic Use algebraic or symbolic algorithm for extractions 
+ *  @return List of components of a Clifford vector*/
 lst clifford_to_lst(const ex & e, const ex & c, bool algebraic=true);
 
 /** Calculations of Moebius transformations (conformal map) defined by a 2x2 Clifford matrix
@@ -315,18 +343,22 @@ lst clifford_to_lst(const ex & e, const ex & c, bool algebraic=true);
  *  @param c (2,1) entry of the defining matrix
  *  @param d (2,2) entry of the defining matrix
  *  @param v Vector to be transformed
- *  @param G Metric of the surrounding space
- *  @param rl Representation label */
-ex clifford_moebius_map(const ex & a, const ex & b, const ex & c, const ex & d, const ex & v, const ex & G, unsigned char rl = 0);
+ *  @param G Metric of the surrounding space, may be a Clifford unit then the next parameter is ignored
+ *  @param rl Representation label 
+ *  @param anticommuting indicates if Clifford units anticommutes
+ *  @return List of components of the transformed vector*/
+ex clifford_moebius_map(const ex & a, const ex & b, const ex & c, const ex & d, const ex & v, const ex & G, unsigned char rl = 0, bool anticommuting = false);
 
 /** The second form of Moebius transformations defined by a 2x2 Clifford matrix M
  *  This function takes the transformation matrix M as a single entity.
  * 
  *  @param M the defining matrix
  *  @param v Vector to be transformed
- *  @param G Metric of the surrounding space
- *  @param rl Representation label */
-ex clifford_moebius_map(const ex & M, const ex & v, const ex & G, unsigned char rl = 0);
+ *  @param G Metric of the surrounding space, may be a Clifford unit then the next parameter is ignored
+ *  @param rl Representation label 
+ *  @param anticommuting indicates if Clifford units anticommutes
+ *  @return List of components of the transformed vector*/
+ex clifford_moebius_map(const ex & M, const ex & v, const ex & G, unsigned char rl = 0, bool anticommuting = false);
 
 } // namespace GiNaC