*
* Interface to GiNaC's indices. */
-#ifndef _IDX_H_
-#define _IDX_H_
+/*
+ * 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
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ */
-#include <string>
-#include <vector>
+#ifndef __GINAC_IDX_H__
+#define __GINAC_IDX_H__
+#include <string>
+//#include <vector>
#include "basic.h"
+#include "ex.h"
+
+#ifndef NO_NAMESPACE_GINAC
+namespace GiNaC {
+#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
{
-// 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 (idx const & other);
- idx const & operator=(idx const & other);
+ idx();
+ ~idx();
+ idx (const idx & other);
+ const idx & operator=(const idx & other);
protected:
- void copy(idx const & 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(string const & n, bool cov=false);
- explicit idx(char const * n, bool cov=false);
- explicit idx(unsigned const 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(basic const & other) const;
- bool is_equal_same_type(basic const & other) const;
- unsigned calchash(void) const;
- ex subs(lst const & ls, lst const & 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(basic const & 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;
+ /** Check whether index is symbolic (not numeric). */
+ bool is_symbolic(void) const {return symbolic;}
- // member variables
+ /** Get numeric value of index. Undefined for symbolic indices. */
+ unsigned get_value(void) const {return value;}
+
+ /** 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 type_info const & typeid_idx;
+extern const std::type_info & typeid_idx;
-// macros
+// utility functions
+inline const idx &ex_to_idx(const ex &e)
+{
+ return static_cast<const idx &>(*e.bp);
+}
-#define ex_to_idx(X) (static_cast<idx const &>(*(X).bp))
+// global functions
-// other functions
+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, 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);
+unsigned count_index(const ex & e, const ex & i);
-typedef vector<ex> exvector;
+#ifndef NO_NAMESPACE_GINAC
+} // namespace GiNaC
+#endif // ndef NO_NAMESPACE_GINAC
-int canonicalize_indices(exvector & iv, bool antisymmetric=false);
-exvector idx_intersect(exvector const & iv1, exvector const & iv2);
-ex permute_free_index_to_front(exvector const & iv3, exvector const & iv2,
- bool antisymmetric, int * sig);
-unsigned subs_index_in_exvector(exvector & v, ex const & is, ex const & ir);
-ex subs_indices(ex const & e, exvector const & idxv_contra,
- exvector const & idxv_co);
-unsigned count_index(ex const & e, ex const & i);
-
-#endif // ndef _IDX_H_
+#endif // ndef __GINAC_IDX_H__
git://www.ginac.de / ginac.git / blobdiff