GINAC_DECLARE_REGISTERED_CLASS declares duplicate() and compare_same_type(),
[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-2001 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 "exprseq.h"
28
29 #ifndef NO_NAMESPACE_GINAC
30 namespace GiNaC {
31 #endif // ndef NO_NAMESPACE_GINAC
32
33
34 /** Base class for objects with indices. */
35 class indexed : public exprseq
36 {
37         GINAC_DECLARE_REGISTERED_CLASS(indexed, exprseq)
38
39         // other constructors
40 public:
41         indexed(const ex & i1);
42         indexed(const ex & i1, const ex & i2);
43         indexed(const ex & i1, const ex & i2, const ex & i3);
44         indexed(const ex & i1, const ex & i2, const ex & i3, const ex & i4);
45         indexed(const exvector & iv);
46         indexed(exvector * iv);
47
48         // functions overriding virtual functions from base classes
49 public:
50         void printraw(std::ostream & os) const;
51         void printtree(std::ostream & os, unsigned indent) const;
52         void print(std::ostream & os, unsigned upper_precedence=0) const;
53         void printcsrc(std::ostream & os, unsigned type, unsigned upper_precedence) const;
54         bool info(unsigned inf) const;
55
56         /** Return the vector of indices on this object. */
57         exvector get_indices(void) const {return seq;}
58
59 protected:
60         ex derivative(const symbol & s) const;
61         bool is_equal_same_type(const basic & other) const;
62         unsigned return_type(void) const;
63         unsigned return_type_tinfo(void) const;
64         ex thisexprseq(const exvector & v) const;
65         ex thisexprseq(exvector * vp) const;
66
67         // new virtual functions which can be overridden by derived classes
68         // none
69         
70         // non-virtual functions in this class
71 protected:
72         void printrawindices(std::ostream & os) const;
73         void printtreeindices(std::ostream & os, unsigned indent) const;
74         void printindices(std::ostream & os) const;
75         bool all_of_type_idx(void) const;
76
77 // member variables
78         // none
79 };
80
81 // utility functions
82 inline const indexed &ex_to_indexed(const ex &e)
83 {
84         return static_cast<const indexed &>(*e.bp);
85 }
86
87 #ifndef NO_NAMESPACE_GINAC
88 } // namespace GiNaC
89 #endif // ndef NO_NAMESPACE_GINAC
90
91 #endif // ndef __GINAC_INDEXED_H__