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

[ginac.git] / ginac / indexed.h

diff --git a/ginac/indexed.h b/ginac/indexed.h
index 6121e020ce05016675e83684f43da5fbd6cc5d3f..2ff8c3a126bbfe1ed7f657a7c4906e07fd068fd2 100644 (file)
--- a/ginac/indexed.h
+++ b/ginac/indexed.h
@@ -3,7 +3,7 @@
  *  Interface to GiNaC's index carrying objects. */
 
 /*
- *  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
@@ -24,72 +24,78 @@
 #define __GINAC_INDEXED_H__
 
 #include <string>
-#include <ginac/exprseq.h>
+#include "exprseq.h"
 
-#ifndef NO_GINAC_NAMESPACE
+#ifndef NO_NAMESPACE_GINAC
 namespace GiNaC {
-#endif // ndef NO_GINAC_NAMESPACE
+#endif // ndef NO_NAMESPACE_GINAC
 
-/** Base class for non-commutative indexed objects */
+
+/** Base class for objects with indices. */
 class indexed : public exprseq
 {
+       GINAC_DECLARE_REGISTERED_CLASS(indexed, exprseq)
+
 // member functions
 
-    // default constructor, destructor, copy constructor assignment operator and helpers
+       // default constructor, destructor, copy constructor assignment operator and helpers
 public:
-    indexed();
-    ~indexed();
-    indexed(indexed const & other);
-    indexed const & operator=(indexed const & other);
+       indexed();
+       ~indexed();
+       indexed(const indexed & other);
+       const indexed & operator=(const indexed & other);
 protected:
-    void copy(indexed const & other); 
-    void destroy(bool call_parent);
+       void copy(const indexed & other); 
+       void destroy(bool call_parent);
 
-    // other constructors
+       // other constructors
 public:
-    indexed(ex const & i1);
-    indexed(ex const & i1, ex const & i2);
-    indexed(ex const & i1, ex const & i2, ex const & i3);
-    indexed(ex const & i1, ex const & i2, ex const & i3, ex const & i4);
-    indexed(exvector const & iv);
-    indexed(exvector * iv);
-
-    // functions overriding virtual functions from base classes
+       indexed(const ex & i1);
+       indexed(const ex & i1, const ex & i2);
+       indexed(const ex & i1, const ex & i2, const ex & i3);
+       indexed(const ex & i1, const ex & i2, const ex & i3, const ex & i4);
+       indexed(const exvector & iv);
+       indexed(exvector * iv);
+
+       // functions overriding virtual functions from base 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;
-    void printcsrc(ostream & os, unsigned type, unsigned upper_precedence) const;
-    bool info(unsigned inf) const;
-    ex diff(symbol const & s) const;
-    exvector get_indices(void) 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;
+       void printcsrc(std::ostream & os, unsigned type, unsigned upper_precedence) const;
+       bool info(unsigned inf) const;
+
+       /** Return the vector of indices on this object. */
+       exvector get_indices(void) const {return seq;}
+
 protected:
-    int compare_same_type(basic const & other) const;
-    bool is_equal_same_type(basic const & other) const;
-    unsigned return_type(void) const;
-    unsigned return_type_tinfo(void) const;
-    ex thisexprseq(exvector const & v) const;
-    ex thisexprseq(exvector * vp) const;
-
-    // new virtual functions which can be overridden by derived classes
-    // none
-    
-    // non-virtual functions in this class
+       ex derivative(const symbol & s) const;
+       int compare_same_type(const basic & other) const;
+       bool is_equal_same_type(const basic & other) const;
+       unsigned return_type(void) const;
+       unsigned return_type_tinfo(void) const;
+       ex thisexprseq(const exvector & v) const;
+       ex thisexprseq(exvector * vp) const;
+
+       // new virtual functions which can be overridden by derived classes
+       // none
+       
+       // non-virtual functions in this class
 protected:
-    void printrawindices(ostream & os) const;
-    void printtreeindices(ostream & os, unsigned indent) const;
-    void printindices(ostream & os) const;
-    bool all_of_type_idx(void) const;
+       void printrawindices(std::ostream & os) const;
+       void printtreeindices(std::ostream & os, unsigned indent) const;
+       void printindices(std::ostream & os) const;
+       bool all_of_type_idx(void) const;
 
 // member variables
-    // none
+       // none
 };
 
 // global constants
 
 extern const indexed some_indexed;
-extern type_info const & typeid_indexed;
+extern const std::type_info & typeid_indexed;
 
 // utility functions
 inline const indexed &ex_to_indexed(const ex &e)
@@ -97,8 +103,8 @@ inline const indexed &ex_to_indexed(const ex &e)
        return static_cast<const indexed &>(*e.bp);
 }
 
-#ifndef NO_GINAC_NAMESPACE
+#ifndef NO_NAMESPACE_GINAC
 } // namespace GiNaC
-#endif // ndef NO_GINAC_NAMESPACE
+#endif // ndef NO_NAMESPACE_GINAC
 
 #endif // ndef __GINAC_INDEXED_H__