5b5856e5838f8021a5e859a392b25911a5b266f4
[ginac.git] / ginac / indexed.h
1 /** @file indexed.h
2  *
3  *  Interface to GiNaC's index carrying objects. */
4
5 /*
6  *  GiNaC Copyright (C) 1999-2000 Johannes Gutenberg University Mainz, Germany
7  *
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
23 #ifndef __GINAC_INDEXED_H__
24 #define __GINAC_INDEXED_H__
25
26 #include <string>
27 #include <ginac/exprseq.h>
28
29 #ifndef NO_GINAC_NAMESPACE
30 namespace GiNaC {
31 #endif // ndef NO_GINAC_NAMESPACE
32
33 /** Base class for non-commutative indexed objects */
34 class indexed : public exprseq
35 {
36     GINAC_DECLARE_REGISTERED_CLASS(indexed, exprseq)
37
38 // member functions
39
40     // default constructor, destructor, copy constructor assignment operator and helpers
41 public:
42     indexed();
43     ~indexed();
44     indexed(const indexed & other);
45     const indexed & operator=(const indexed & other);
46 protected:
47     void copy(const indexed & other); 
48     void destroy(bool call_parent);
49
50     // other constructors
51 public:
52     indexed(const ex & i1);
53     indexed(const ex & i1, const ex & i2);
54     indexed(const ex & i1, const ex & i2, const ex & i3);
55     indexed(const ex & i1, const ex & i2, const ex & i3, const ex & i4);
56     indexed(const exvector & iv);
57     indexed(exvector * iv);
58
59     // functions overriding virtual functions from base classes
60 public:
61     basic * duplicate() const;
62     void printraw(ostream & os) const;
63     void printtree(ostream & os, unsigned indent) const;
64     void print(ostream & os, unsigned upper_precedence=0) const;
65     void printcsrc(ostream & os, unsigned type, unsigned upper_precedence) const;
66     bool info(unsigned inf) const;
67     ex diff(const symbol & s) const;
68     exvector get_indices(void) const;
69 protected:
70     int compare_same_type(const basic & other) const;
71     bool is_equal_same_type(const basic & other) const;
72     unsigned return_type(void) const;
73     unsigned return_type_tinfo(void) const;
74     ex thisexprseq(const exvector & v) const;
75     ex thisexprseq(exvector * vp) const;
76
77     // new virtual functions which can be overridden by derived classes
78     // none
79     
80     // non-virtual functions in this class
81 protected:
82     void printrawindices(ostream & os) const;
83     void printtreeindices(ostream & os, unsigned indent) const;
84     void printindices(ostream & os) const;
85     bool all_of_type_idx(void) const;
86
87 // member variables
88     // none
89 };
90
91 // global constants
92
93 extern const indexed some_indexed;
94 extern const type_info & typeid_indexed;
95
96 // utility functions
97 inline const indexed &ex_to_indexed(const ex &e)
98 {
99         return static_cast<const indexed &>(*e.bp);
100 }
101
102 #ifndef NO_GINAC_NAMESPACE
103 } // namespace GiNaC
104 #endif // ndef NO_GINAC_NAMESPACE
105
106 #endif // ndef __GINAC_INDEXED_H__