GiNaC/ginac/idx.h

/** @file idx.h
 *
 *  Interface to GiNaC's indices. */

/*
 *  GiNaC Copyright (C) 1999-2000 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 <ginac/basic.h>
#include <ginac/ex.h>

#ifndef NO_GINAC_NAMESPACE
namespace GiNaC {
#endif // ndef NO_GINAC_NAMESPACE

class idx : public basic
{
// member functions

    // 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 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(ostream & os) const;
    void printtree(ostream & os, unsigned indent) const;
    void print(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:
    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;}

    // member variables
protected:
    unsigned serial;
    bool symbolic;
    string name;
    unsigned value;
    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;

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

// 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);
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_GINAC_NAMESPACE
} // namespace GiNaC
#endif // ndef NO_GINAC_NAMESPACE

#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.8	* GiNaC Copyright (C) 1999-2000 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.3	#include <ginac/basic.h>
29	cbauer	1.6	#include <ginac/ex.h>
30
31	frink	1.7	#ifndef NO_GINAC_NAMESPACE
32	cbauer	1.6	namespace GiNaC {
33	frink	1.7	#endif // ndef NO_GINAC_NAMESPACE
34	cbauer	1.1
35			class idx : public basic
36			{
37			// member functions
38
39			// default constructor, destructor, copy constructor assignment operator and helpers
40			public:
41			idx();
42			~idx();
43	cbauer	1.9	idx (const idx & other);
44			const idx & operator=(const idx & other);
45	cbauer	1.1	protected:
46	cbauer	1.9	void copy(const idx & other);
47	cbauer	1.1	void destroy(bool call_parent);
48
49			// other constructors
50			public:
51			explicit idx(bool cov);
52	cbauer	1.9	explicit idx(const string & n, bool cov=false);
53			explicit idx(const char * n, bool cov=false);
54			explicit idx(unsigned v, bool cov=false);
55	cbauer	1.1
56			// functions overriding virtual functions from bases classes
57			public:
58			basic * duplicate() const;
59			void printraw(ostream & os) const;
60			void printtree(ostream & os, unsigned indent) const;
61			void print(ostream & os, unsigned upper_precedence=0) const;
62			bool info(unsigned inf) const;
63			protected:
64	cbauer	1.9	int compare_same_type(const basic & other) const;
65			bool is_equal_same_type(const basic & other) const;
66	cbauer	1.1	unsigned calchash(void) const;
67	cbauer	1.9	ex subs(const lst & ls, const lst & lr) const;
68	cbauer	1.1
69			// new virtual functions which can be overridden by derived classes
70			public:
71	cbauer	1.9	virtual bool is_co_contra_pair(const basic & other) const;
72	cbauer	1.1	virtual ex toggle_covariant(void) const;
73
74			// non-virtual functions in this class
75			public:
76			bool is_symbolic(void) const;
77			unsigned get_value(void) const;
78			bool is_covariant(void) const;
79	cbauer	1.9	void setname(const string & n) {name=n;}
80	frink	1.4	string getname(void) const {return name;}
81	cbauer	1.1
82			// member variables
83			protected:
84			unsigned serial;
85			bool symbolic;
86			string name;
87			unsigned value;
88			static unsigned next_serial;
89			bool covariant; // x_mu, default is contravariant: x^mu
90			};
91
92			// global constants
93
94			extern const idx some_idx;
95	cbauer	1.9	extern const type_info & typeid_idx;
96	cbauer	1.1
97	cbauer	1.6	// utility functions
98			inline const idx &ex_to_idx(const ex &e)
99			{
100			return static_cast<const idx &>(*e.bp);
101			}
102	cbauer	1.1
103	cbauer	1.6	// global functions
104	cbauer	1.1
105	frink	1.7	// typedef vector<ex> exvector;
106	cbauer	1.1
107			int canonicalize_indices(exvector & iv, bool antisymmetric=false);
108	cbauer	1.9	exvector idx_intersect(const exvector & iv1, const exvector & iv2);
109			ex permute_free_index_to_front(const exvector & iv3, const exvector & iv2,
110	cbauer	1.1	bool antisymmetric, int * sig);
111	cbauer	1.9	unsigned subs_index_in_exvector(exvector & v, const ex & is, const ex & ir);
112			ex subs_indices(const ex & e, const exvector & idxv_contra,
113			const exvector & idxv_co);
114			unsigned count_index(const ex & e, const ex & i);
115	cbauer	1.6
116	frink	1.7	#ifndef NO_GINAC_NAMESPACE
117	cbauer	1.6	} // namespace GiNaC
118	frink	1.7	#endif // ndef NO_GINAC_NAMESPACE
119	cbauer	1.1
120	cbauer	1.2	#endif // ndef __GINAC_IDX_H__
Christian Bauer">Christian Bauer	ViewVC Help
Powered by ViewVC 1.1.15