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

[ginac.git] / ginac / lorentzidx.h

diff --git a/ginac/lorentzidx.h b/ginac/lorentzidx.h
index 8f9bbf40a4fb5495ff1660de5028cec3d964fbe9..d4226e1bff313ec5fe40a698e1d128b019a417a5 100644 (file)
--- a/ginac/lorentzidx.h
+++ b/ginac/lorentzidx.h
@@ -1,8 +1,9 @@
 /** @file lorentzidx.h
  *
- *  Interface to GiNaC's lorentz indices.
- *
- *  GiNaC Copyright (C) 1999 Johannes Gutenberg University Mainz, Germany
+ *  Interface to GiNaC's Lorentz indices. */
+
+/*
+ *  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
@@ -24,63 +25,70 @@
 
 #include <string>
 #include <vector>
+#include "idx.h"
+
+namespace GiNaC {
 
+
+/** Class of indices for Lorentz tensors, to tell them apart from other
+ *  index families like color indices. The indices of this class also
+ *  support the case of P-O-decomposed D-dimensional spacetime, where the
+ *  parallel space is a Minkowski space with integral dimension P and the
+ *  orthogonal space is a Euclidean space with (possibly complex) dimension
+ *  D-P. The dimension D of spacetime is represented by the global symbol
+ *  that is returned by the Dim() function. */
 class lorentzidx : public idx
 {
-    friend class simp_lor;
-    friend class scalar_products;
+       GINAC_DECLARE_REGISTERED_CLASS(lorentzidx, idx)
+
+       friend class simp_lor;
+       friend class scalar_products;
 
 // member functions
 
-    // default constructor, destructor, copy constructor assignment operator and helpers
+       // other constructors
 public:
-    lorentzidx();
-    ~lorentzidx();
-    lorentzidx (lorentzidx const & other);
-    lorentzidx const & operator=(lorentzidx const & other);
-protected:
-    void copy(lorentzidx const & other);
-    void destroy(bool call_parent);
+       explicit lorentzidx(bool cov, bool oonly=false, unsigned dimp=0);
+       explicit lorentzidx(const std::string & n, bool cov=false,
+                           bool oonly=false, unsigned dimp=0);
+       explicit lorentzidx(const char * n, bool cov=false,
+                           bool oonly=false, unsigned dimp=0);
+       explicit lorentzidx(unsigned v, bool cov=false);
 
-    // other constructors
+       // functions overriding virtual functions from bases classes
 public:
-    explicit lorentzidx(bool cov, bool oonly=false, unsigned dimp=0);
-    explicit lorentzidx(string const & n, bool cov=false,
-                        bool oonly=false, unsigned dimp=0);
-    explicit lorentzidx(char const * n, bool cov=false,
-                        bool oonly=false, unsigned dimp=0);
-    explicit lorentzidx(unsigned const v, bool cov=false);
-
-    // 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
+       // non-virtual functions in this class
 public:
-    bool is_orthogonal_only(void) const { return orthogonal_only; }
-    unsigned get_dim_parallel_space(void) const { return dim_parallel_space; }
-    lorentzidx create_anonymous_representative(void) const; 
+       /** Check whether index only lives in orthogonal space. */
+       bool is_orthogonal_only(void) const {return orthogonal_only;}
+
+       /** Return dimension of parallel space. */
+       unsigned get_dim_parallel_space(void) const {return dim_parallel_space;}
+
+       lorentzidx create_anonymous_representative(void) const; 
 
-    // member variables
+       // member variables
 protected:
-    bool orthogonal_only;
-    unsigned dim_parallel_space;
+       bool orthogonal_only;        /**< Symbolic index only lives in orthogonal space? */
+       unsigned dim_parallel_space; /**< Dimension of parallel space */
 };
 
-// global constants
-
-extern const lorentzidx some_lorentzidx;
-extern type_info const & typeid_lorentzidx;
+// utility functions
+inline const lorentzidx &ex_to_lorentzidx(const ex &e)
+{
+       return static_cast<const lorentzidx &>(*e.bp);
+}
 
-// macros
+ex Dim(void);
 
-#define ex_to_lorentzidx(X) (static_cast<lorentzidx const &>(*(X).bp))
+} // namespace GiNaC
 
 #endif // ndef __GINAC_LORENTZIDX_H__