GiNaC/ginac/idx.h

/** @file idx.h
 *
 *  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
 *  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
 */

#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
{
        GINAC_DECLARE_REGISTERED_CLASS(idx, basic)

        // default constructor, destructor, copy constructor assignment operator and helpers
public:
        idx();
        ~idx();
        idx (const idx & other);
        const idx & operator=(const idx & other);
protected:
        void copy(const idx & other);
        void destroy(bool call_parent);

        // other constructors
public:
        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
public:
        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;

        // 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;

        // non-virtual functions in this class
public:
        /** 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;}

        /** 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;}

private:
        std::string & autoname_prefix(void);

        // member variables
protected:
        unsigned serial;  /**< Unique serial number for comparing symbolic indices */
        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 */
};

// utility functions
inline const idx &ex_to_idx(const ex &e)
{
        return static_cast<const idx &>(*e.bp);
}

// global 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);

#ifndef NO_NAMESPACE_GINAC
} // namespace GiNaC
#endif // ndef NO_NAMESPACE_GINAC

#endif // ndef __GINAC_IDX_H__
1	cbauer	1.1	/** @file idx.h
2			*
3	cbauer	1.5	* Interface to GiNaC's indices. */
4
5			/*
6	kreckel	1.18	* GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
7	cbauer	1.2	*
8			* This program is free software; you can redistribute it and/or modify
9			* it under the terms of the GNU General Public License as published by
10			* the Free Software Foundation; either version 2 of the License, or
11			* (at your option) any later version.
12			*
13			* This program is distributed in the hope that it will be useful,
14			* but WITHOUT ANY WARRANTY; without even the implied warranty of
15			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16			* GNU General Public License for more details.
17			*
18			* You should have received a copy of the GNU General Public License
19			* along with this program; if not, write to the Free Software
20			* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21			*/
22	cbauer	1.1
23	cbauer	1.2	#ifndef __GINAC_IDX_H__
24			#define __GINAC_IDX_H__
25	cbauer	1.1
26			#include <string>
27	frink	1.7	//#include <vector>
28	cbauer	1.11	#include "basic.h"
29			#include "ex.h"
30	cbauer	1.6
31	kreckel	1.12	#ifndef NO_NAMESPACE_GINAC
32	cbauer	1.6	namespace GiNaC {
33	kreckel	1.12	#endif // ndef NO_NAMESPACE_GINAC
34	cbauer	1.1
35	cbauer	1.19
36			/** This class holds one index of an indexed object. Indices can be symbolic
37			* (e.g. "mu", "i") or numeric (unsigned integer), and they can be contravariant
38			* (the default) or covariant. */
39	cbauer	1.1	class idx : public basic
40			{
41	cbauer	1.14	GINAC_DECLARE_REGISTERED_CLASS(idx, basic)
42	cbauer	1.10
43	cbauer	1.14	// default constructor, destructor, copy constructor assignment operator and helpers
44	cbauer	1.1	public:
45	cbauer	1.14	idx();
46			~idx();
47			idx (const idx & other);
48			const idx & operator=(const idx & other);
49	cbauer	1.1	protected:
50	cbauer	1.14	void copy(const idx & other);
51			void destroy(bool call_parent);
52	cbauer	1.1
53	cbauer	1.14	// other constructors
54	cbauer	1.1	public:
55	cbauer	1.14	explicit idx(bool cov);
56			explicit idx(const std::string & n, bool cov=false);
57			explicit idx(const char * n, bool cov=false);
58			explicit idx(unsigned v, bool cov=false);
59	cbauer	1.1
60	cbauer	1.14	// functions overriding virtual functions from bases classes
61	cbauer	1.1	public:
62	cbauer	1.14	basic * duplicate() const;
63			void printraw(std::ostream & os) const;
64			void printtree(std::ostream & os, unsigned indent) const;
65			void print(std::ostream & os, unsigned upper_precedence=0) const;
66			bool info(unsigned inf) const;
67	cbauer	1.1	protected:
68	cbauer	1.14	int compare_same_type(const basic & other) const;
69			bool is_equal_same_type(const basic & other) const;
70			unsigned calchash(void) const;
71			ex subs(const lst & ls, const lst & lr) const;
72	cbauer	1.1
73	cbauer	1.14	// new virtual functions which can be overridden by derived classes
74	cbauer	1.1	public:
75	cbauer	1.14	virtual bool is_co_contra_pair(const basic & other) const;
76			virtual ex toggle_covariant(void) const;
77	cbauer	1.1
78	cbauer	1.14	// non-virtual functions in this class
79	cbauer	1.1	public:
80	cbauer	1.19	/** Check whether index is symbolic (not numeric). */
81			bool is_symbolic(void) const {return symbolic;}
82
83			/** Get numeric value of index. Undefined for symbolic indices. */
84			unsigned get_value(void) const {return value;}
85
86			/** Check whether index is covariant (not contravariant). */
87			bool is_covariant(void) const {return covariant;}
88
89	cbauer	1.14	void setname(const std::string & n) {name=n;}
90			std::string getname(void) const {return name;}
91	cbauer	1.1
92	cbauer	1.20	private:
93			std::string & autoname_prefix(void);
94
95	cbauer	1.14	// member variables
96	cbauer	1.1	protected:
97	cbauer	1.20	unsigned serial; /*< Unique serial number for comparing symbolic indices /
98	cbauer	1.19	bool symbolic; /*< Is index symbolic? /
99			std::string name; /*< Symbolic name (if symbolic == true) /
100			unsigned value; /*< Numeric value (if symbolic == false) /
101	cbauer	1.14	static unsigned next_serial;
102	cbauer	1.19	bool covariant; /*< x_mu, default is contravariant: x~mu /
103	cbauer	1.1	};
104
105	cbauer	1.6	// utility functions
106			inline const idx &ex_to_idx(const ex &e)
107			{
108			return static_cast<const idx &>(*e.bp);
109			}
110	cbauer	1.1
111	cbauer	1.6	// global functions
112	cbauer	1.1
113			int canonicalize_indices(exvector & iv, bool antisymmetric=false);
114	cbauer	1.9	exvector idx_intersect(const exvector & iv1, const exvector & iv2);
115	cbauer	1.19	ex permute_free_index_to_front(const exvector & iv3, const exvector & iv2, int * sig);
116	cbauer	1.9	unsigned subs_index_in_exvector(exvector & v, const ex & is, const ex & ir);
117	cbauer	1.19	ex subs_indices(const ex & e, const exvector & idxv_contra, const exvector & idxv_co);
118	cbauer	1.9	unsigned count_index(const ex & e, const ex & i);
119	cbauer	1.6
120	kreckel	1.12	#ifndef NO_NAMESPACE_GINAC
121	cbauer	1.6	} // namespace GiNaC
122	kreckel	1.12	#endif // ndef NO_NAMESPACE_GINAC
123	cbauer	1.1
124	cbauer	1.2	#endif // ndef __GINAC_IDX_H__
Christian Bauer">Christian Bauer	ViewVC Help
Powered by ViewVC 1.1.15