* 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 8ff27764728ac7dae1fe666876087fef2cce4753..d4226e1bff313ec5fe40a698e1d128b019a417a5 100644 (file)
--- a/ginac/lorentzidx.h
+++ b/ginac/lorentzidx.h
@@ -1,9 +1,9 @@
 /** @file lorentzidx.h
  *
- *  Interface to GiNaC's lorentz indices. */
+ *  Interface to GiNaC's Lorentz indices. */
 
 /*
- *  GiNaC Copyright (C) 1999-2000 Johannes Gutenberg University Mainz, Germany
+ *  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
@@ -27,65 +27,59 @@
 #include <vector>
 #include "idx.h"
 
-#ifndef NO_NAMESPACE_GINAC
 namespace GiNaC {
-#endif // ndef NO_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
 {
-    GINAC_DECLARE_REGISTERED_CLASS(lorentzidx, idx)
+       GINAC_DECLARE_REGISTERED_CLASS(lorentzidx, idx)
 
-    friend class simp_lor;
-    friend class scalar_products;
+       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 (const lorentzidx & other);
-    const lorentzidx & operator=(const lorentzidx & other);
-protected:
-    void copy(const lorentzidx & other);
-    void destroy(bool call_parent);
-
-    // other constructors
+       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);
+
+       // functions overriding virtual functions from bases classes
 public:
-    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);
-
-    // functions overriding virtual functions from bases 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;
-    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;}
 
-    // member variables
-protected:
-    bool orthogonal_only;
-    unsigned dim_parallel_space;
-};
+       /** Return dimension of parallel space. */
+       unsigned get_dim_parallel_space(void) const {return dim_parallel_space;}
 
-// global constants
+       lorentzidx create_anonymous_representative(void) const; 
 
-extern const lorentzidx some_lorentzidx;
-extern const type_info & typeid_lorentzidx;
+       // member variables
+protected:
+       bool orthogonal_only;        /**< Symbolic index only lives in orthogonal space? */
+       unsigned dim_parallel_space; /**< Dimension of parallel space */
+};
 
 // utility functions
 inline const lorentzidx &ex_to_lorentzidx(const ex &e)
@@ -93,8 +87,8 @@ inline const lorentzidx &ex_to_lorentzidx(const ex &e)
        return static_cast<const lorentzidx &>(*e.bp);
 }
 
-#ifndef NO_NAMESPACE_GINAC
+ex Dim(void);
+
 } // namespace GiNaC
-#endif // ndef NO_NAMESPACE_GINAC
 
 #endif // ndef __GINAC_LORENTZIDX_H__