documentation update

[ginac.git] / ginac / lorentzidx.h

diff --git a/ginac/lorentzidx.h b/ginac/lorentzidx.h
index 001494088735c39fc96002ab234e442bc9cc48af..582cdc0bb379b4c723481d4e4a5d5682b6c15db3 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,64 +25,76 @@
 
 #include <string>
 #include <vector>
-#include <ginac/idx.h>
+#include "idx.h"
+
+#ifndef NO_NAMESPACE_GINAC
+namespace GiNaC {
+#endif // ndef NO_NAMESPACE_GINAC
 
 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
+       // default constructor, destructor, copy constructor assignment operator and helpers
 public:
-    lorentzidx();
-    ~lorentzidx();
-    lorentzidx (lorentzidx const & other);
-    lorentzidx const & operator=(lorentzidx const & other);
+       lorentzidx();
+       ~lorentzidx();
+       lorentzidx (const lorentzidx & other);
+       const lorentzidx & operator=(const lorentzidx & other);
 protected:
-    void copy(lorentzidx const & other);
-    void destroy(bool call_parent);
+       void copy(const lorentzidx & other);
+       void destroy(bool call_parent);
 
-    // other constructors
+       // other constructors
 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
+       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(ostream & os) const;
-    void printtree(ostream & os, unsigned indent) const;
-    void print(ostream & os, unsigned upper_precedence=0) const;
-    bool info(unsigned inf) const;
+       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;
 
-    // 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; 
+       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; 
 
-    // member variables
+       // member variables
 protected:
-    bool orthogonal_only;
-    unsigned dim_parallel_space;
+       bool orthogonal_only;
+       unsigned dim_parallel_space;
 };
 
 // global constants
 
 extern const lorentzidx some_lorentzidx;
-extern type_info const & typeid_lorentzidx;
+extern const std::type_info & typeid_lorentzidx;
 
-// macros
+// utility functions
+inline const lorentzidx &ex_to_lorentzidx(const ex &e)
+{
+       return static_cast<const lorentzidx &>(*e.bp);
+}
 
-#define ex_to_lorentzidx(X) (static_cast<lorentzidx const &>(*(X).bp))
+#ifndef NO_NAMESPACE_GINAC
+} // namespace GiNaC
+#endif // ndef NO_NAMESPACE_GINAC
 
 #endif // ndef __GINAC_LORENTZIDX_H__