* Interface to GiNaC's 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
#include <string>
//#include <vector>
-#include <ginac/basic.h>
-#include <ginac/ex.h>
+#include "basic.h"
+#include "ex.h"
-#ifndef NO_GINAC_NAMESPACE
+#ifndef NO_NAMESPACE_GINAC
namespace GiNaC {
-#endif // ndef NO_GINAC_NAMESPACE
+#endif // ndef NO_NAMESPACE_GINAC
+
+/** This class holds one index of an indexed object. Indices can be symbolic
+ * (e.g. "mu", "i") or numeric (unsigned integer), and they can be contravariant
+ * (the default) or covariant. */
class idx : public basic
{
- GINAC_DECLARE_REGISTERED_CLASS(idx, basic)
-
-// member functions
+ GINAC_DECLARE_REGISTERED_CLASS(idx, basic)
- // default constructor, destructor, copy constructor assignment operator and helpers
+ // default constructor, destructor, copy constructor assignment operator and helpers
public:
- idx();
- ~idx();
- idx (const idx & other);
- const idx & operator=(const idx & other);
+ idx();
+ ~idx();
+ idx (const idx & other);
+ const idx & operator=(const idx & other);
protected:
- void copy(const idx & other);
- void destroy(bool call_parent);
+ void copy(const idx & other);
+ void destroy(bool call_parent);
- // other constructors
+ // other constructors
public:
- explicit idx(bool cov);
- explicit idx(const string & n, bool cov=false);
- explicit idx(const char * n, bool cov=false);
- explicit idx(unsigned v, bool cov=false);
+ explicit idx(bool cov);
+ explicit idx(const std::string & n, bool cov=false);
+ explicit idx(const char * n, bool cov=false);
+ explicit idx(unsigned v, bool cov=false);
- // functions overriding virtual functions from bases classes
+ // 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;
protected:
- int compare_same_type(const basic & other) const;
- bool is_equal_same_type(const basic & other) const;
- unsigned calchash(void) const;
- ex subs(const lst & ls, const lst & lr) const;
+ int compare_same_type(const basic & other) const;
+ bool is_equal_same_type(const basic & other) const;
+ unsigned calchash(void) const;
+ ex subs(const lst & ls, const lst & lr) const;
- // new virtual functions which can be overridden by derived classes
+ // new virtual functions which can be overridden by derived classes
public:
- virtual bool is_co_contra_pair(const basic & other) const;
- virtual ex toggle_covariant(void) const;
+ virtual bool is_co_contra_pair(const basic & other) const;
+ virtual ex toggle_covariant(void) const;
- // non-virtual functions in this class
+ // non-virtual functions in this class
public:
- bool is_symbolic(void) const;
- unsigned get_value(void) const;
- bool is_covariant(void) const;
- void setname(const string & n) {name=n;}
- string getname(void) const {return name;}
+ /** Check whether index is symbolic (not numeric). */
+ bool is_symbolic(void) const {return symbolic;}
+
+ /** Get numeric value of index. Undefined for symbolic indices. */
+ unsigned get_value(void) const {return value;}
- // member variables
+ /** Check whether index is covariant (not contravariant). */
+ bool is_covariant(void) const {return covariant;}
+
+ void setname(const std::string & n) {name=n;}
+ std::string getname(void) const {return name;}
+
+ // member variables
protected:
- unsigned serial;
- bool symbolic;
- string name;
- unsigned value;
- static unsigned next_serial;
- bool covariant; // x_mu, default is contravariant: x^mu
+ unsigned serial;
+ bool symbolic; /**< Is index symbolic? */
+ std::string name; /**< Symbolic name (if symbolic == true) */
+ unsigned value; /**< Numeric value (if symbolic == false) */
+ static unsigned next_serial;
+ bool covariant; /**< x_mu, default is contravariant: x~mu */
};
// global constants
extern const idx some_idx;
-extern const type_info & typeid_idx;
+extern const std::type_info & typeid_idx;
// utility functions
inline const idx &ex_to_idx(const ex &e)
// global functions
-// typedef vector<ex> exvector;
-
int canonicalize_indices(exvector & iv, bool antisymmetric=false);
exvector idx_intersect(const exvector & iv1, const exvector & iv2);
-ex permute_free_index_to_front(const exvector & iv3, const exvector & iv2,
- bool antisymmetric, int * sig);
+ex permute_free_index_to_front(const exvector & iv3, const exvector & iv2, int * sig);
unsigned subs_index_in_exvector(exvector & v, const ex & is, const ex & ir);
-ex subs_indices(const ex & e, const exvector & idxv_contra,
- const exvector & idxv_co);
+ex subs_indices(const ex & e, const exvector & idxv_contra, const exvector & idxv_co);
unsigned count_index(const ex & e, const ex & i);
-#ifndef NO_GINAC_NAMESPACE
+#ifndef NO_NAMESPACE_GINAC
} // namespace GiNaC
-#endif // ndef NO_GINAC_NAMESPACE
+#endif // ndef NO_NAMESPACE_GINAC
#endif // ndef __GINAC_IDX_H__