ff460638e0ed3c402b3499040200d534880e4d89
[ginac.git] / ginac / numeric.h
1 /** @file numeric.h
2  *
3  *  Makes the interface to the underlying bignum package available. */
4
5 /*
6  *  GiNaC Copyright (C) 1999-2006 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
21  */
22
23 #ifndef __GINAC_NUMERIC_H__
24 #define __GINAC_NUMERIC_H__
25
26 #include "basic.h"
27 #include "ex.h"
28
29 #include <stdexcept>
30 #include <vector>
31
32 #include <cln/complex.h>
33
34 #if defined(G__CINTVERSION) && !defined(__MAKECINT__)
35 // Cint @$#$! doesn't like forward declaring classes used for casting operators
36 // so we have to include the definition of cln::cl_N here, but it is enough to
37 // do so for the compiler, hence the !defined(__MAKECINT__).
38   #include <cln/complex_class.h>
39 #endif
40
41 namespace GiNaC {
42
43 /** Function pointer to implement callbacks in the case 'Digits' gets changed.
44  *  Main purpose of such callbacks is to adjust look-up tables of certain
45  *  functions to the new precision. Parameter contains the signed difference
46  *  between new Digits and old Digits. */
47 typedef void (* digits_changed_callback)(long);
48
49 /** This class is used to instantiate a global singleton object Digits
50  *  which behaves just like Maple's Digits.  We need an object rather 
51  *  than a dumber basic type since as a side-effect we let it change
52  *  cl_default_float_format when it gets changed.  The only other
53  *  meaningful thing to do with it is converting it to an unsigned,
54  *  for temprary storing its value e.g.  The user must not create an
55  *  own working object of this class!  Since C++ forces us to make the
56  *  class definition visible in order to use an object we put in a
57  *  flag which prevents other objects of that class to be created. */
58 class _numeric_digits
59 {
60 // member functions
61 public:
62         _numeric_digits();
63         _numeric_digits& operator=(long prec);
64         operator long();
65         void print(std::ostream& os) const;
66         void add_callback(digits_changed_callback callback);
67 // member variables
68 private:
69         long digits;                        ///< Number of decimal digits
70         static bool too_late;               ///< Already one object present
71         // Holds a list of functions that get called when digits is changed.
72         std::vector<digits_changed_callback> callbacklist;
73 };
74
75
76 /** Exception class thrown when a singularity is encountered. */
77 class pole_error : public std::domain_error {
78 public:
79         explicit pole_error(const std::string& what_arg, int degree);
80         int degree() const;
81 private:
82         int deg;
83 };
84
85
86 /** This class is a wrapper around CLN-numbers within the GiNaC class
87  *  hierarchy. Objects of this type may directly be created by the user.*/
88 class numeric : public basic
89 {
90         GINAC_DECLARE_REGISTERED_CLASS(numeric, basic)
91         
92 // member functions
93         
94         // other constructors
95 public:
96         numeric(int i);
97         numeric(unsigned int i);
98         numeric(long i);
99         numeric(unsigned long i);
100         numeric(long numer, long denom);
101         numeric(double d);
102         numeric(const char *);
103         
104         // functions overriding virtual functions from base classes
105 public:
106         unsigned precedence() const {return 30;}
107         bool info(unsigned inf) const;
108         bool is_polynomial(const ex & var) const;
109         int degree(const ex & s) const;
110         int ldegree(const ex & s) const;
111         ex coeff(const ex & s, int n = 1) const;
112         bool has(const ex &other, unsigned options = 0) const;
113         ex eval(int level = 0) const;
114         ex evalf(int level = 0) const;
115         ex subs(const exmap & m, unsigned options = 0) const { return subs_one_level(m, options); } // overwrites basic::subs() for performance reasons
116         ex normal(exmap & repl, exmap & rev_lookup, int level = 0) const;
117         ex to_rational(exmap & repl) const;
118         ex to_polynomial(exmap & repl) const;
119         numeric integer_content() const;
120         ex smod(const numeric &xi) const;
121         numeric max_coefficient() const;
122         ex conjugate() const;
123 protected:
124         /** Implementation of ex::diff for a numeric always returns 0.
125          *  @see ex::diff */
126         ex derivative(const symbol &s) const { return 0; }
127         bool is_equal_same_type(const basic &other) const;
128         unsigned calchash() const;
129         
130         // new virtual functions which can be overridden by derived classes
131         // (none)
132         
133         // non-virtual functions in this class
134 public:
135         const numeric add(const numeric &other) const;
136         const numeric sub(const numeric &other) const;
137         const numeric mul(const numeric &other) const;
138         const numeric div(const numeric &other) const;
139         const numeric power(const numeric &other) const;
140         const numeric & add_dyn(const numeric &other) const;
141         const numeric & sub_dyn(const numeric &other) const;
142         const numeric & mul_dyn(const numeric &other) const;
143         const numeric & div_dyn(const numeric &other) const;
144         const numeric & power_dyn(const numeric &other) const;
145         const numeric & operator=(int i);
146         const numeric & operator=(unsigned int i);
147         const numeric & operator=(long i);
148         const numeric & operator=(unsigned long i);
149         const numeric & operator=(double d);
150         const numeric & operator=(const char *s);
151         const numeric inverse() const;
152         numeric step() const;
153         int csgn() const;
154         int compare(const numeric &other) const;
155         bool is_equal(const numeric &other) const;
156         bool is_zero() const;
157         bool is_positive() const;
158         bool is_negative() const;
159         bool is_integer() const;
160         bool is_pos_integer() const;
161         bool is_nonneg_integer() const;
162         bool is_even() const;
163         bool is_odd() const;
164         bool is_prime() const;
165         bool is_rational() const;
166         bool is_real() const;
167         bool is_cinteger() const;
168         bool is_crational() const;
169         bool operator==(const numeric &other) const;
170         bool operator!=(const numeric &other) const;
171         bool operator<(const numeric &other) const;
172         bool operator<=(const numeric &other) const;
173         bool operator>(const numeric &other) const;
174         bool operator>=(const numeric &other) const;
175         int to_int() const;
176         long to_long() const;
177         double to_double() const;
178         cln::cl_N to_cl_N() const;
179         const numeric real() const;
180         const numeric imag() const;
181         const numeric numer() const;
182         const numeric denom() const;
183         int int_length() const;
184         // converting routines for interfacing with CLN:
185         numeric(const cln::cl_N &z);
186
187 protected:
188         void print_numeric(const print_context & c, const char *par_open, const char *par_close, const char *imag_sym, const char *mul_sym, unsigned level) const;
189         void do_print(const print_context & c, unsigned level) const;
190         void do_print_latex(const print_latex & c, unsigned level) const;
191         void do_print_csrc(const print_csrc & c, unsigned level) const;
192         void do_print_csrc_cl_N(const print_csrc_cl_N & c, unsigned level) const;
193         void do_print_tree(const print_tree & c, unsigned level) const;
194         void do_print_python_repr(const print_python_repr & c, unsigned level) const;
195
196 // member variables
197
198 protected:
199         cln::cl_N value;
200 };
201
202
203 // global constants
204
205 extern const numeric I;
206 extern _numeric_digits Digits;
207
208 // global functions
209
210 const numeric exp(const numeric &x);
211 const numeric log(const numeric &x);
212 const numeric sin(const numeric &x);
213 const numeric cos(const numeric &x);
214 const numeric tan(const numeric &x);
215 const numeric asin(const numeric &x);
216 const numeric acos(const numeric &x);
217 const numeric atan(const numeric &x);
218 const numeric atan(const numeric &y, const numeric &x);
219 const numeric sinh(const numeric &x);
220 const numeric cosh(const numeric &x);
221 const numeric tanh(const numeric &x);
222 const numeric asinh(const numeric &x);
223 const numeric acosh(const numeric &x);
224 const numeric atanh(const numeric &x);
225 const numeric Li2(const numeric &x);
226 const numeric zeta(const numeric &x);
227 const numeric lgamma(const numeric &x);
228 const numeric tgamma(const numeric &x);
229 const numeric psi(const numeric &x);
230 const numeric psi(const numeric &n, const numeric &x);
231 const numeric factorial(const numeric &n);
232 const numeric doublefactorial(const numeric &n);
233 const numeric binomial(const numeric &n, const numeric &k);
234 const numeric bernoulli(const numeric &n);
235 const numeric fibonacci(const numeric &n);
236 const numeric isqrt(const numeric &x);
237 const numeric sqrt(const numeric &x);
238 const numeric abs(const numeric &x);
239 const numeric mod(const numeric &a, const numeric &b);
240 const numeric smod(const numeric &a, const numeric &b);
241 const numeric irem(const numeric &a, const numeric &b);
242 const numeric irem(const numeric &a, const numeric &b, numeric &q);
243 const numeric iquo(const numeric &a, const numeric &b);
244 const numeric iquo(const numeric &a, const numeric &b, numeric &r);
245 const numeric gcd(const numeric &a, const numeric &b);
246 const numeric lcm(const numeric &a, const numeric &b);
247
248 // wrapper functions around member functions
249 inline const numeric pow(const numeric &x, const numeric &y)
250 { return x.power(y); }
251
252 inline const numeric inverse(const numeric &x)
253 { return x.inverse(); }
254
255 inline numeric step(const numeric &x)
256 { return x.step(); }
257
258 inline int csgn(const numeric &x)
259 { return x.csgn(); }
260
261 inline bool is_zero(const numeric &x)
262 { return x.is_zero(); }
263
264 inline bool is_positive(const numeric &x)
265 { return x.is_positive(); }
266
267 inline bool is_integer(const numeric &x)
268 { return x.is_integer(); }
269
270 inline bool is_pos_integer(const numeric &x)
271 { return x.is_pos_integer(); }
272
273 inline bool is_nonneg_integer(const numeric &x)
274 { return x.is_nonneg_integer(); }
275
276 inline bool is_even(const numeric &x)
277 { return x.is_even(); }
278
279 inline bool is_odd(const numeric &x)
280 { return x.is_odd(); }
281
282 inline bool is_prime(const numeric &x)
283 { return x.is_prime(); }
284
285 inline bool is_rational(const numeric &x)
286 { return x.is_rational(); }
287
288 inline bool is_real(const numeric &x)
289 { return x.is_real(); }
290
291 inline bool is_cinteger(const numeric &x)
292 { return x.is_cinteger(); }
293
294 inline bool is_crational(const numeric &x)
295 { return x.is_crational(); }
296
297 inline int to_int(const numeric &x)
298 { return x.to_int(); }
299
300 inline long to_long(const numeric &x)
301 { return x.to_long(); }
302
303 inline double to_double(const numeric &x)
304 { return x.to_double(); }
305
306 inline const numeric real(const numeric &x)
307 { return x.real(); }
308
309 inline const numeric imag(const numeric &x)
310 { return x.imag(); }
311
312 inline const numeric numer(const numeric &x)
313 { return x.numer(); }
314
315 inline const numeric denom(const numeric &x)
316 { return x.denom(); }
317
318 // numeric evaluation functions for class constant objects:
319
320 ex PiEvalf();
321 ex EulerEvalf();
322 ex CatalanEvalf();
323
324
325 } // namespace GiNaC
326
327 #ifdef __MAKECINT__
328 #pragma link off defined_in cln/number.h;
329 #pragma link off defined_in cln/complex_class.h;
330 #endif
331
332 #endif // ndef __GINAC_NUMERIC_H__