3 * Makes the interface to the underlying bignum package available. */
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_NUMERIC_H__
24 #define __GINAC_NUMERIC_H__
27 #include <ginac/basic.h>
30 class cl_N; // We want to include cln.h only in numeric.cpp in order to
31 // avoid namespace pollution and keep compile-time low.
33 #ifndef NO_GINAC_NAMESPACE
35 #endif // ndef NO_GINAC_NAMESPACE
37 #define HASHVALUE_NUMERIC 0x80000001U
39 /** This class is used to instantiate a global object Digits which
40 * behaves just like Maple's Digits. We need an object rather than a
41 * dumber basic type since as a side-effect we let it change
42 * cl_default_float_format when it gets changed. The only other
43 * meaningful thing to do with it is converting it to an unsigned,
44 * for temprary storing its value e.g. The user must not create an
45 * own working object of this class! Since C++ forces us to make the
46 * class definition visible in order to use an object we put in a
47 * flag which prevents other objects of that class to be created. */
53 _numeric_digits& operator=(long prec);
55 void print(ostream & os) const;
62 /** This class is a wrapper around CLN-numbers within the GiNaC class
63 * hierarchy. Objects of this type may directly be created by the user.*/
64 class numeric : public basic
67 friend numeric exp(numeric const & x);
68 friend numeric log(numeric const & x);
69 friend numeric sin(numeric const & x);
70 friend numeric cos(numeric const & x);
71 friend numeric tan(numeric const & x);
72 friend numeric asin(numeric const & x);
73 friend numeric acos(numeric const & x);
74 friend numeric atan(numeric const & x);
75 friend numeric atan(numeric const & y, numeric const & x);
76 friend numeric sinh(numeric const & x);
77 friend numeric cosh(numeric const & x);
78 friend numeric tanh(numeric const & x);
79 friend numeric asinh(numeric const & x);
80 friend numeric acosh(numeric const & x);
81 friend numeric atanh(numeric const & x);
82 friend numeric bernoulli(numeric const & n);
83 friend numeric abs(numeric const & x);
84 friend numeric mod(numeric const & a, numeric const & b);
85 friend numeric smod(numeric const & a, numeric const & b);
86 friend numeric irem(numeric const & a, numeric const & b);
87 friend numeric irem(numeric const & a, numeric const & b, numeric & q);
88 friend numeric iquo(numeric const & a, numeric const & b);
89 friend numeric iquo(numeric const & a, numeric const & b, numeric & r);
90 friend numeric sqrt(numeric const & x);
91 friend numeric isqrt(numeric const & x);
92 friend numeric gcd(numeric const & a, numeric const & b);
93 friend numeric lcm(numeric const & a, numeric const & b);
94 friend numeric const & numZERO(void);
95 friend numeric const & numONE(void);
96 friend numeric const & numTWO(void);
97 friend numeric const & numTHREE(void);
98 friend numeric const & numMINUSONE(void);
99 friend numeric const & numHALF(void);
103 // default constructor, destructor, copy constructor assignment
104 // operator and helpers
108 numeric(numeric const & other);
109 numeric const & operator=(numeric const & other);
111 void copy(numeric const & other);
112 void destroy(bool call_parent);
114 // other constructors
116 explicit numeric(int i);
117 explicit numeric(unsigned int i);
118 explicit numeric(long i);
119 explicit numeric(unsigned long i);
120 explicit numeric(long numer, long denom);
121 explicit numeric(double d);
122 explicit numeric(char const *);
123 numeric(cl_N const & z);
125 // functions overriding virtual functions from bases classes
127 basic * duplicate() const;
128 void printraw(ostream & os) const;
129 void printtree(ostream & os, unsigned indent) const;
130 void print(ostream & os, unsigned precedence=0) const;
131 void printcsrc(ostream & os, unsigned type, unsigned precedence=0) const;
132 bool info(unsigned inf) const;
133 ex evalf(int level=0) const;
134 ex diff(symbol const & s) const;
135 ex normal(lst &sym_lst, lst &repl_lst, int level=0) const;
136 numeric integer_content(void) const;
137 ex smod(numeric const &xi) const;
138 numeric max_coefficient(void) const;
140 int compare_same_type(basic const & other) const;
141 bool is_equal_same_type(basic const & other) const;
142 unsigned calchash(void) const {
143 hashvalue=HASHVALUE_NUMERIC;
144 return HASHVALUE_NUMERIC;
147 // new virtual functions which can be overridden by derived classes
150 // non-virtual functions in this class
152 numeric add(numeric const & other) const;
153 numeric sub(numeric const & other) const;
154 numeric mul(numeric const & other) const;
155 numeric div(numeric const & other) const;
156 numeric power(numeric const & other) const;
157 numeric const & add_dyn(numeric const & other) const;
158 numeric const & sub_dyn(numeric const & other) const;
159 numeric const & mul_dyn(numeric const & other) const;
160 numeric const & div_dyn(numeric const & other) const;
161 numeric const & power_dyn(numeric const & other) const;
162 numeric const & operator=(int i);
163 numeric const & operator=(unsigned int i);
164 numeric const & operator=(long i);
165 numeric const & operator=(unsigned long i);
166 numeric const & operator=(double d);
167 numeric const & operator=(char const * s);
169 numeric add_dyn(numeric const & other) const { return add(other); }
170 numeric sub_dyn(numeric const & other) const { return sub(other); }
171 numeric mul_dyn(numeric const & other) const { return mul(other); }
172 numeric div_dyn(numeric const & other) const { return div(other); }
173 numeric power_dyn(numeric const & other) const { return power(other); }
175 numeric inverse(void) const;
176 int csgn(void) const;
177 int compare(numeric const & other) const;
178 bool is_equal(numeric const & other) const;
179 bool is_zero(void) const;
180 bool is_positive(void) const;
181 bool is_negative(void) const;
182 bool is_integer(void) const;
183 bool is_pos_integer(void) const;
184 bool is_nonneg_integer(void) const;
185 bool is_even(void) const;
186 bool is_odd(void) const;
187 bool is_prime(void) const;
188 bool is_rational(void) const;
189 bool is_real(void) const;
190 bool operator==(numeric const & other) const;
191 bool operator!=(numeric const & other) const;
192 bool operator<(numeric const & other) const;
193 bool operator<=(numeric const & other) const;
194 bool operator>(numeric const & other) const;
195 bool operator>=(numeric const & other) const;
196 int to_int(void) const;
197 double to_double(void) const;
198 numeric real(void) const;
199 numeric imag(void) const;
200 numeric numer(void) const;
201 numeric denom(void) const;
202 int int_length(void) const;
207 static unsigned precedence;
213 extern const numeric some_numeric;
214 extern const numeric I;
215 extern type_info const & typeid_numeric;
216 extern _numeric_digits Digits;
218 #define is_a_numeric_hash(x) ((x)==HASHVALUE_NUMERIC)
219 // may have to be changed to ((x)>=0x80000000U)
223 numeric const & numZERO(void);
224 numeric const & numONE(void);
225 numeric const & numTWO(void);
226 numeric const & numMINUSONE(void);
227 numeric const & numHALF(void);
229 numeric exp(numeric const & x);
230 numeric log(numeric const & x);
231 numeric sin(numeric const & x);
232 numeric cos(numeric const & x);
233 numeric tan(numeric const & x);
234 numeric asin(numeric const & x);
235 numeric acos(numeric const & x);
236 numeric atan(numeric const & x);
237 numeric atan(numeric const & y, numeric const & x);
238 numeric sinh(numeric const & x);
239 numeric cosh(numeric const & x);
240 numeric tanh(numeric const & x);
241 numeric asinh(numeric const & x);
242 numeric acosh(numeric const & x);
243 numeric atanh(numeric const & x);
244 numeric zeta(numeric const & x);
245 numeric gamma(numeric const & x);
246 numeric psi(numeric const & x);
247 numeric psi(numeric const & n, numeric const & x);
248 numeric factorial(numeric const & n);
249 numeric doublefactorial(numeric const & n);
250 numeric binomial(numeric const & n, numeric const & k);
251 numeric bernoulli(numeric const & n);
253 numeric abs(numeric const & x);
254 numeric mod(numeric const & a, numeric const & b);
255 numeric smod(numeric const & a, numeric const & b);
256 numeric irem(numeric const & a, numeric const & b);
257 numeric irem(numeric const & a, numeric const & b, numeric & q);
258 numeric iquo(numeric const & a, numeric const & b);
259 numeric iquo(numeric const & a, numeric const & b, numeric & r);
260 numeric sqrt(numeric const & x);
261 numeric isqrt(numeric const & x);
263 numeric gcd(numeric const & a, numeric const & b);
264 numeric lcm(numeric const & a, numeric const & b);
266 /** Exception thrown by numeric members to signal failure */
270 numeric_fail(int n) { failval = n; }
273 // wrapper functions around member functions
274 inline numeric inverse(numeric const & x)
275 { return x.inverse(); }
277 inline bool csgn(numeric const & x)
280 inline bool is_zero(numeric const & x)
281 { return x.is_zero(); }
283 inline bool is_positive(numeric const & x)
284 { return x.is_positive(); }
286 inline bool is_integer(numeric const & x)
287 { return x.is_integer(); }
289 inline bool is_pos_integer(numeric const & x)
290 { return x.is_pos_integer(); }
292 inline bool is_nonneg_integer(numeric const & x)
293 { return x.is_nonneg_integer(); }
295 inline bool is_even(numeric const & x)
296 { return x.is_even(); }
298 inline bool is_odd(numeric const & x)
299 { return x.is_odd(); }
301 inline bool is_prime(numeric const & x)
302 { return x.is_prime(); }
304 inline bool is_rational(numeric const & x)
305 { return x.is_rational(); }
307 inline bool is_real(numeric const & x)
308 { return x.is_real(); }
310 inline numeric real(numeric const & x)
313 inline numeric imag(numeric const & x)
316 inline numeric numer(numeric const & x)
317 { return x.numer(); }
319 inline numeric denom(numeric const & x)
320 { return x.denom(); }
322 // numeric evaluation functions for class constant objects:
325 ex EulerGammaEvalf(void);
326 ex CatalanEvalf(void);
329 inline const numeric &ex_to_numeric(const ex &e)
331 return static_cast<const numeric &>(*e.bp);
334 #ifndef NO_GINAC_NAMESPACE
336 #endif // ndef NO_GINAC_NAMESPACE
338 #endif // ndef __GINAC_NUMERIC_H__