3 * Interface to GiNaC's ABC. */
6 * GiNaC Copyright (C) 1999 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 #include <ginac/flags.h>
31 #include <ginac/tinfos.h>
32 #include <ginac/debugmsg.h>
40 typedef vector<ex> exvector;
42 #define INLINE_BASIC_CONSTRUCTORS
44 /** This class is the ABC (abstract base class) of GiNaC's class hierarchy.
45 * It is responsible for the reference counting. */
52 // default constructor, destructor, copy constructor assignment operator and helpers
55 #ifdef INLINE_BASIC_CONSTRUCTORS
56 : tinfo_key(TINFO_basic), flags(0), refcount(0)
58 debugmsg("basic default constructor",LOGLEVEL_CONSTRUCT);
63 #endif // def INLINE_BASIC_CONSTRUCTORS
66 #ifdef INLINE_BASIC_CONSTRUCTORS
68 debugmsg("basic destructor",LOGLEVEL_DESTRUCT);
70 ASSERT((!(flags & status_flags::dynallocated))||(refcount==0));
74 #endif // def INLINE_BASIC_CONSTRUCTORS
76 basic(basic const & other)
77 #ifdef INLINE_BASIC_CONSTRUCTORS
79 debugmsg("basic copy constructor",LOGLEVEL_CONSTRUCT);
84 #endif // def INLINE_BASIC_CONSTRUCTORS
86 virtual basic const & operator=(basic const & other);
89 void copy(basic const & other)
91 flags = other.flags & ~status_flags::dynallocated;
92 hashvalue = other.hashvalue;
93 tinfo_key = other.tinfo_key;
95 void destroy(bool call_parent) {}
99 #ifdef INLINE_BASIC_CONSTRUCTORS
100 : tinfo_key(ti), flags(0), refcount(0)
102 debugmsg("basic constructor with tinfo_key",LOGLEVEL_CONSTRUCT);
107 #endif // def INLINE_BASIC_CONSTRUCTORS
109 // functions overriding virtual functions from bases classes
112 // new virtual functions which can be overridden by derived classes
113 public: // only const functions please (may break reference counting)
114 virtual basic * duplicate() const;
115 virtual void printraw(ostream & os) const;
116 virtual void printtree(ostream & os, unsigned indent) const;
117 virtual void print(ostream & os,unsigned upper_precedence=0) const;
118 virtual void printcsrc(ostream & os, unsigned type, unsigned upper_precedence=0) const;
119 virtual void dbgprint(void) const;
120 virtual void dbgprinttree(void) const;
121 virtual bool info(unsigned inf) const;
122 virtual int nops() const;
123 virtual ex op(int const i) const;
124 virtual ex & let_op(int const i);
125 virtual ex operator[](ex const & index) const;
126 virtual ex operator[](int const i) const;
127 virtual bool has(ex const & other) const;
128 virtual int degree(symbol const & s) const;
129 virtual int ldegree(symbol const & s) const;
130 virtual ex coeff(symbol const & s, int const n=1) const;
131 virtual ex collect(symbol const & s) const;
132 virtual ex eval(int level=0) const;
133 virtual ex evalf(int level=0) const;
134 virtual ex diff(symbol const & s) const;
135 virtual ex series(symbol const & s, ex const & point, int order) const;
136 virtual ex subs(lst const & ls, lst const & lr) const;
137 virtual ex normal(lst &sym_lst, lst &repl_lst, int level=0) const;
138 virtual numeric integer_content(void) const;
139 virtual ex smod(numeric const &xi) const;
140 virtual numeric max_coefficient(void) const;
141 virtual exvector get_indices(void) const;
142 virtual ex simplify_ncmul(exvector const & v) const;
143 protected: // non-const functions should be called from class ex only
144 virtual int compare_same_type(basic const & other) const;
145 virtual bool is_equal_same_type(basic const & other) const;
146 virtual unsigned return_type(void) const;
147 virtual unsigned return_type_tinfo(void) const;
148 virtual unsigned calchash(void) const;
149 virtual ex expand(unsigned options=0) const;
151 // non-virtual functions in this class
153 ex subs(ex const & e) const;
154 int compare(basic const & other) const;
155 bool is_equal(basic const & other) const;
156 basic const & hold(void) const;
157 unsigned gethash(void) const {if (flags & status_flags::hash_calculated) return hashvalue; else return calchash();}
158 unsigned tinfo(void) const {return tinfo_key;}
160 basic const & setflag(unsigned f) const {flags |= f; return *this;}
161 basic const & clearflag(unsigned f) const {flags &= ~f; return *this;}
162 void ensure_if_modifiable(void) const;
168 mutable unsigned flags;
169 mutable unsigned hashvalue;
170 static unsigned precedence;
171 static unsigned delta_indent;
178 extern const basic some_basic;
179 extern type_info const & typeid_basic;
183 extern int max_recursion_level;
185 // convenience macros
187 #define is_of_type(OBJ,TYPE) \
188 (dynamic_cast<TYPE *>(const_cast<basic *>(&OBJ))!=0)
190 #define is_exactly_of_type(OBJ,TYPE) \
191 ((OBJ).tinfo()==TINFO_##TYPE)
193 #define is_ex_of_type(OBJ,TYPE) \
194 (dynamic_cast<TYPE *>(const_cast<basic *>((OBJ).bp))!=0)
196 #define is_ex_exactly_of_type(OBJ,TYPE) \
197 ((*(OBJ).bp).tinfo()==TINFO_##TYPE)
199 #define are_ex_trivially_equal(EX1,EX2) \
204 inline unsigned rotate_left_31(unsigned n)
206 // clear highest bit and shift 1 bit to the left
207 n=(n & 0x7FFFFFFFU) << 1;
209 // overflow? clear highest bit and set lowest bit
210 if (n & 0x80000000U) {
211 n=(n & 0x7FFFFFFFU) | 0x00000001U;
214 ASSERT(n<0x80000000U);
219 inline unsigned golden_ratio_hash(unsigned n)
222 // This requires ´long long´ (or an equivalent 64 bit type)---which is,
223 // unfortunately, not ANSI-compliant:
224 unsigned long long l = n * 0x4f1bbcddLL;
225 return (l & 0x7fffffffU) ^ (l >> 32);
227 // This requires ´long double´ to have a mantissa of at least 64 bit---
228 // which is not guaranteed by any standard:
229 const static long double golden_ratio=.618033988749894848204586834370;
230 long double m=golden_ratio*n;
231 return unsigned((m-int(m))*0x80000000);
235 #endif // ndef __GINAC_BASIC_H__