X-Git-Url: https://www.ginac.de/ginac.git//ginac.git?p=ginac.git;a=blobdiff_plain;f=ginac%2Fidx.h;h=2941fa96724fba23cfecdc36e9bca983757190d5;hp=c742db6bce9c38b6dd3dd094f3019cc69003eea8;hb=7cbe7effc515e4575b4d1fd1d6d75f0148eb8a89;hpb=4e3986a8583584945681ee2dc1560e0fc08e4978;ds=sidebyside diff --git a/ginac/idx.h b/ginac/idx.h index c742db6b..2941fa96 100644 --- a/ginac/idx.h +++ b/ginac/idx.h @@ -1,8 +1,9 @@ /** @file idx.h * - * Interface to GiNaC's indices. - * - * GiNaC Copyright (C) 1999 Johannes Gutenberg University Mainz, Germany + * Interface to GiNaC's 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 @@ -23,86 +24,103 @@ #define __GINAC_IDX_H__ #include -#include -#include +//#include +#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; - void setname(string const & 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 type_info const & typeid_idx; - -// macros +extern const std::type_info & typeid_idx; -#define ex_to_idx(X) (static_cast(*(X).bp)) - -// other functions +// utility functions +inline const idx &ex_to_idx(const ex &e) +{ + return static_cast(*e.bp); +} -typedef vector exvector; +// global functions 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); +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); + +#ifndef NO_NAMESPACE_GINAC +} // namespace GiNaC +#endif // ndef NO_NAMESPACE_GINAC #endif // ndef __GINAC_IDX_H__