- building GiNaC in a separate directory now works
[ginac.git] / ginac / basic.h
1 /** @file basic.h
2  *
3  *  Interface to GiNaC's ABC. */
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_BASIC_H__
24 #define __GINAC_BASIC_H__
25
26 #include <iostream>
27 #include <typeinfo>
28 #include <vector>
29
30 // CINT needs <algorithm> to work properly with <vector> 
31 #include <algorithm>
32
33 #include "flags.h"
34 #include "tinfos.h"
35 #include "assertion.h"
36 #include "registrar.h"
37
38 #ifndef NO_GINAC_NAMESPACE
39 namespace GiNaC {
40 #endif // ndef NO_GINAC_NAMESPACE
41
42 class basic;
43 class ex;
44 class symbol;
45 class lst;
46 class numeric;
47 class archive_node;
48
49 //typedef vector<ex> exvector;
50 typedef vector<ex,malloc_alloc> exvector; // CINT does not like vector<...,default_alloc>
51
52 #define INLINE_BASIC_CONSTRUCTORS
53
54 /** This class is the ABC (abstract base class) of GiNaC's class hierarchy.
55  *  It is responsible for the reference counting. */
56 class basic
57 {
58     GINAC_DECLARE_REGISTERED_CLASS(basic, void)
59
60     friend class ex;
61
62 // member functions
63
64     // default constructor, destructor, copy constructor assignment operator and helpers
65 public:
66     basic()
67 #ifdef INLINE_BASIC_CONSTRUCTORS
68     : tinfo_key(TINFO_basic), flags(0), refcount(0)
69     {
70     }
71 #else
72 ;
73 #endif // def INLINE_BASIC_CONSTRUCTORS
74
75     virtual ~basic()
76 #ifdef INLINE_BASIC_CONSTRUCTORS
77     {
78         destroy(0);
79         GINAC_ASSERT((!(flags & status_flags::dynallocated))||(refcount==0));
80     }
81 #else
82 ;
83 #endif // def INLINE_BASIC_CONSTRUCTORS
84
85     basic(const basic & other)
86 #ifdef INLINE_BASIC_CONSTRUCTORS
87     {
88         copy(other);
89     }
90 #else
91 ;
92 #endif // def INLINE_BASIC_CONSTRUCTORS
93
94     virtual const basic & operator=(const basic & other);
95     
96 protected:
97     void copy(const basic & other)
98     {
99         flags = other.flags & ~status_flags::dynallocated;
100         hashvalue = other.hashvalue;
101         tinfo_key = other.tinfo_key;
102     }
103     void destroy(bool call_parent) {}
104
105     // other constructors
106     basic(unsigned ti)
107 #ifdef INLINE_BASIC_CONSTRUCTORS
108     : tinfo_key(ti), flags(0), refcount(0)
109     {
110     }
111 #else
112 ;
113 #endif // def INLINE_BASIC_CONSTRUCTORS
114
115     // functions overriding virtual functions from bases classes
116     // none
117     
118     // new virtual functions which can be overridden by derived classes
119 public: // only const functions please (may break reference counting)
120     virtual basic * duplicate() const;
121     virtual void print(ostream & os,unsigned upper_precedence=0) const;
122     virtual void printraw(ostream & os) const;
123     virtual void printtree(ostream & os, unsigned indent) const;
124     virtual void printcsrc(ostream & os, unsigned type, unsigned upper_precedence=0) const;
125     virtual void dbgprint(void) const;
126     virtual void dbgprinttree(void) const;
127     virtual bool info(unsigned inf) const;
128     virtual unsigned nops() const;
129     virtual ex op(int i) const;
130     virtual ex & let_op(int i);
131     virtual ex operator[](const ex & index) const;
132     virtual ex operator[](int i) const;
133     virtual bool has(const ex & other) const;
134     virtual int degree(const symbol & s) const;
135     virtual int ldegree(const symbol & s) const;
136     virtual ex coeff(const symbol & s, int n=1) const;
137     virtual ex collect(const symbol & s) const;
138     virtual ex eval(int level=0) const;
139     virtual ex evalf(int level=0) const;
140     virtual ex diff(const symbol & s) const;
141     virtual ex series(const symbol & s, const ex & point, int order) const;
142     virtual ex subs(const lst & ls, const lst & lr) const;
143     virtual ex normal(lst &sym_lst, lst &repl_lst, int level=0) const;
144     virtual numeric integer_content(void) const;
145     virtual ex smod(const numeric &xi) const;
146     virtual numeric max_coefficient(void) const;
147     virtual exvector get_indices(void) const;
148     virtual ex simplify_ncmul(const exvector & v) const;
149 protected: // non-const functions should be called from class ex only
150     virtual int compare_same_type(const basic & other) const;
151     virtual bool is_equal_same_type(const basic & other) const;
152     virtual unsigned return_type(void) const;
153     virtual unsigned return_type_tinfo(void) const;
154     virtual unsigned calchash(void) const;
155     virtual ex expand(unsigned options=0) const;
156
157     // non-virtual functions in this class
158 public:
159     ex subs(const ex & e) const;
160     int compare(const basic & other) const;
161     bool is_equal(const basic & other) const;
162     const basic & hold(void) const;
163     unsigned gethash(void) const {if (flags & status_flags::hash_calculated) return hashvalue; else return calchash();}
164     unsigned tinfo(void) const {return tinfo_key;}
165 protected:
166     const basic & setflag(unsigned f) const {flags |= f; return *this;}
167     const basic & clearflag(unsigned f) const {flags &= ~f; return *this;}
168     void ensure_if_modifiable(void) const;
169
170 // member variables
171     
172 protected:
173     unsigned tinfo_key;
174     mutable unsigned flags;
175     mutable unsigned hashvalue;
176     static unsigned precedence;
177     static unsigned delta_indent;
178 private:
179     unsigned refcount;
180 };
181
182 // global constants
183
184 extern const basic some_basic;
185 extern const type_info & typeid_basic;
186
187 // global variables
188
189 extern int max_recursion_level;
190
191 // convenience macros
192
193 #ifndef NO_GINAC_NAMESPACE
194
195 #define is_of_type(OBJ,TYPE) \
196     (dynamic_cast<TYPE *>(const_cast<GiNaC::basic *>(&OBJ))!=0)
197
198 #define is_exactly_of_type(OBJ,TYPE) \
199     ((OBJ).tinfo()==GiNaC::TINFO_##TYPE)
200
201 #define is_ex_of_type(OBJ,TYPE) \
202     (dynamic_cast<TYPE *>(const_cast<GiNaC::basic *>((OBJ).bp))!=0)
203
204 #define is_ex_exactly_of_type(OBJ,TYPE) \
205     ((*(OBJ).bp).tinfo()==GiNaC::TINFO_##TYPE)
206
207 #else // ndef NO_GINAC_NAMESPACE
208
209 #define is_of_type(OBJ,TYPE) \
210     (dynamic_cast<TYPE *>(const_cast<basic *>(&OBJ))!=0)
211
212 #define is_exactly_of_type(OBJ,TYPE) \
213     ((OBJ).tinfo()==TINFO_##TYPE)
214
215 #define is_ex_of_type(OBJ,TYPE) \
216     (dynamic_cast<TYPE *>(const_cast<basic *>((OBJ).bp))!=0)
217
218 #define is_ex_exactly_of_type(OBJ,TYPE) \
219     ((*(OBJ).bp).tinfo()==TINFO_##TYPE)
220
221 #endif // ndef NO_GINAC_NAMESPACE
222
223 #ifndef NO_GINAC_NAMESPACE
224 } // namespace GiNaC
225 #endif // ndef NO_GINAC_NAMESPACE
226
227 #endif // ndef __GINAC_BASIC_H__