3 * Interface to GiNaC's ABC. */
6 * GiNaC Copyright (C) 1999-2000 Johannes Gutenberg University Mainz, Germany
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.
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.
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
23 #ifndef __GINAC_BASIC_H__
24 #define __GINAC_BASIC_H__
30 // CINT needs <algorithm> to work properly with <vector>
35 #include "assertion.h"
36 #include "registrar.h"
38 #ifndef NO_NAMESPACE_GINAC
40 #endif // ndef NO_NAMESPACE_GINAC
50 // typedef std::vector<ex> exvector;
51 typedef std::vector<ex,malloc_alloc> exvector; // CINT does not like vector<...,default_alloc>
53 #define INLINE_BASIC_CONSTRUCTORS
55 /** This class is the ABC (abstract base class) of GiNaC's class hierarchy.
56 * It is responsible for the reference counting. */
59 GINAC_DECLARE_REGISTERED_CLASS(basic, void)
65 // default constructor, destructor, copy constructor assignment operator and helpers
68 #ifdef INLINE_BASIC_CONSTRUCTORS
69 : tinfo_key(TINFO_basic), flags(0), refcount(0)
74 #endif // def INLINE_BASIC_CONSTRUCTORS
77 #ifdef INLINE_BASIC_CONSTRUCTORS
80 GINAC_ASSERT((!(flags & status_flags::dynallocated))||(refcount==0));
84 #endif // def INLINE_BASIC_CONSTRUCTORS
86 basic(const basic & other)
87 #ifdef INLINE_BASIC_CONSTRUCTORS
93 #endif // def INLINE_BASIC_CONSTRUCTORS
95 const basic & operator=(const basic & other);
98 void copy(const basic & other)
100 flags = other.flags & ~status_flags::dynallocated;
101 hashvalue = other.hashvalue;
102 tinfo_key = other.tinfo_key;
104 void destroy(bool call_parent) {}
106 // other constructors
108 #ifdef INLINE_BASIC_CONSTRUCTORS
109 : tinfo_key(ti), flags(0), refcount(0)
114 #endif // def INLINE_BASIC_CONSTRUCTORS
116 // functions overriding virtual functions from bases classes
119 // new virtual functions which can be overridden by derived classes
120 public: // only const functions please (may break reference counting)
121 virtual basic * duplicate() const;
122 virtual void print(std::ostream & os,unsigned upper_precedence = 0) const;
123 virtual void printraw(std::ostream & os) const;
124 virtual void printtree(std::ostream & os, unsigned indent) const;
125 virtual void printcsrc(std::ostream & os, unsigned type, unsigned upper_precedence = 0) const;
126 virtual void dbgprint(void) const;
127 virtual void dbgprinttree(void) const;
128 virtual bool info(unsigned inf) const;
129 virtual unsigned nops() const;
130 virtual ex op(int i) const;
131 virtual ex & let_op(int i);
132 virtual ex operator[](const ex & index) const;
133 virtual ex operator[](int i) const;
134 virtual bool has(const ex & other) const;
135 virtual int degree(const symbol & s) const;
136 virtual int ldegree(const symbol & s) const;
137 virtual ex coeff(const symbol & s, int n = 1) const;
138 virtual ex collect(const symbol & s) const;
139 virtual ex eval(int level = 0) const;
140 virtual ex evalf(int level = 0) const;
141 virtual ex series(const relational & r, int order, unsigned options = 0) 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 ex to_rational(lst &repl_lst) const;
145 virtual numeric integer_content(void) const;
146 virtual ex smod(const numeric &xi) const;
147 virtual numeric max_coefficient(void) const;
148 virtual exvector get_indices(void) const;
149 virtual ex simplify_ncmul(const exvector & v) const;
150 protected: // non-const functions should be called from class ex only
151 virtual ex derivative(const symbol & s) const;
152 virtual int compare_same_type(const basic & other) const;
153 virtual bool is_equal_same_type(const basic & other) const;
154 virtual unsigned return_type(void) const;
155 virtual unsigned return_type_tinfo(void) const;
156 virtual unsigned calchash(void) const;
157 virtual ex expand(unsigned options=0) const;
159 // non-virtual functions in this class
161 ex subs(const ex & e) const;
162 ex diff(const symbol & s, unsigned nth=1) const;
163 int compare(const basic & other) const;
164 bool is_equal(const basic & other) const;
165 const basic & hold(void) const;
166 unsigned gethash(void) const {if (flags & status_flags::hash_calculated) return hashvalue; else return calchash();}
167 unsigned tinfo(void) const {return tinfo_key;}
168 const basic & setflag(unsigned f) const {flags |= f; return *this;}
169 const basic & clearflag(unsigned f) const {flags &= ~f; return *this;}
171 void ensure_if_modifiable(void) const;
177 mutable unsigned flags;
178 mutable unsigned hashvalue;
179 static unsigned precedence;
180 static unsigned delta_indent;
187 extern const basic some_basic;
188 extern const type_info & typeid_basic;
192 extern int max_recursion_level;
194 // convenience macros
196 #ifndef NO_NAMESPACE_GINAC
198 #define is_of_type(OBJ,TYPE) \
199 (dynamic_cast<TYPE *>(const_cast<GiNaC::basic *>(&OBJ))!=0)
201 #define is_exactly_of_type(OBJ,TYPE) \
202 ((OBJ).tinfo()==GiNaC::TINFO_##TYPE)
204 #define is_ex_of_type(OBJ,TYPE) \
205 (dynamic_cast<TYPE *>(const_cast<GiNaC::basic *>((OBJ).bp))!=0)
207 #define is_ex_exactly_of_type(OBJ,TYPE) \
208 ((*(OBJ).bp).tinfo()==GiNaC::TINFO_##TYPE)
210 #else // ndef NO_NAMESPACE_GINAC
212 #define is_of_type(OBJ,TYPE) \
213 (dynamic_cast<TYPE *>(const_cast<basic *>(&OBJ))!=0)
215 #define is_exactly_of_type(OBJ,TYPE) \
216 ((OBJ).tinfo()==TINFO_##TYPE)
218 #define is_ex_of_type(OBJ,TYPE) \
219 (dynamic_cast<TYPE *>(const_cast<basic *>((OBJ).bp))!=0)
221 #define is_ex_exactly_of_type(OBJ,TYPE) \
222 ((*(OBJ).bp).tinfo()==TINFO_##TYPE)
224 #endif // ndef NO_NAMESPACE_GINAC
226 #ifndef NO_NAMESPACE_GINAC
228 #endif // ndef NO_NAMESPACE_GINAC
230 #endif // ndef __GINAC_BASIC_H__