- added documentation to the indexed, color, lortensor and clifford classes

[ginac.git] / ginac / lorentzidx.h

diff --git a/ginac/lorentzidx.h b/ginac/lorentzidx.h
index f644fa2bd73b229c80a63657e838e2f1b4da0eef..91c364440dafc2977a9258755ff3604253bc9a5b 100644 (file)
--- a/ginac/lorentzidx.h
+++ b/ginac/lorentzidx.h
@@ -31,11 +31,14 @@
 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-like space with integral dimension P and the orthogonal
- *  space is a Euclidean space with (possibly complex) dimension D-P. */
+
+/** 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)
@@ -102,6 +105,8 @@ inline const lorentzidx &ex_to_lorentzidx(const ex &e)
        return static_cast<const lorentzidx &>(*e.bp);
 }
 
+ex Dim(void);
+
 #ifndef NO_NAMESPACE_GINAC
 } // namespace GiNaC
 #endif // ndef NO_NAMESPACE_GINAC