- modified the comment blocks so the copyright message no longer appears in
[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 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 /** Base class for non-commutative indexed objects */
30 class indexed : public exprseq
31 {
32 // member functions
33
34     // default constructor, destructor, copy constructor assignment operator and helpers
35 public:
36     indexed();
37     ~indexed();
38     indexed(indexed const & other);
39     indexed const & operator=(indexed const & other);
40 protected:
41     void copy(indexed const & other); 
42     void destroy(bool call_parent);
43
44     // other constructors
45 public:
46     indexed(ex const & i1);
47     indexed(ex const & i1, ex const & i2);
48     indexed(ex const & i1, ex const & i2, ex const & i3);
49     indexed(exvector const & iv);
50     indexed(exvector * iv);
51
52     // functions overriding virtual functions from base classes
53 public:
54     basic * duplicate() const;
55     void printraw(ostream & os) const;
56     void printtree(ostream & os, unsigned indent) const;
57     void print(ostream & os, unsigned upper_precedence=0) const;
58     void printcsrc(ostream & os, unsigned type, unsigned upper_precedence) const;
59     bool info(unsigned inf) const;
60     ex diff(symbol const & s) const;
61     exvector get_indices(void) const;
62 protected:
63     int compare_same_type(basic const & other) const;
64     bool is_equal_same_type(basic const & other) const;
65     unsigned return_type(void) const;
66     unsigned return_type_tinfo(void) const;
67     ex thisexprseq(exvector const & v) const;
68     ex thisexprseq(exvector * vp) const;
69
70     // new virtual functions which can be overridden by derived classes
71     // none
72     
73     // non-virtual functions in this class
74 protected:
75     void printrawindices(ostream & os) const;
76     void printtreeindices(ostream & os, unsigned indent) const;
77     void printindices(ostream & os) const;
78     bool all_of_type_idx(void) const;
79
80 // member variables
81     // none
82 };
83
84 // global constants
85
86 extern const indexed some_indexed;
87 extern type_info const & typeid_indexed;
88
89 // macros
90
91 #define ex_to_indexed(X) static_cast<indexed const &>(*(X).bp)
92
93 #endif // ndef __GINAC_INDEXED_H__
94
95