- ++version_major.
[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-2001 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_NUMERIC_H__
24 #define __GINAC_NUMERIC_H__
25
26 #include "basic.h"
27 #include "ex.h"
28
29 #include <cln/number.h>
30 // forward decln of cln::cl_N, since cln/complex_class.h is not included:
31 namespace cln { class cl_N; }
32
33 #if defined(G__CINTVERSION) && !defined(__MAKECINT__)
34 // Cint @$#$! doesn't like forward declaring classes used for casting operators
35 // so we have to include the definition of cln::cl_N here, but it is enough to
36 // do so for the compiler, hence the !defined(__MAKECINT__).
37   #include <cln/complex_class.h>
38 #endif
39
40 namespace GiNaC {
41
42 #define HASHVALUE_NUMERIC 0x80000001U
43
44 /** This class is used to instantiate a global singleton object Digits
45  *  which behaves just like Maple's Digits.  We need an object rather 
46  *  than a dumber basic type since as a side-effect we let it change
47  *  cl_default_float_format when it gets changed.  The only other
48  *  meaningful thing to do with it is converting it to an unsigned,
49  *  for temprary storing its value e.g.  The user must not create an
50  *  own working object of this class!  Since C++ forces us to make the
51  *  class definition visible in order to use an object we put in a
52  *  flag which prevents other objects of that class to be created. */
53 class _numeric_digits
54 {
55 // member functions
56 public:
57         _numeric_digits();
58         _numeric_digits& operator=(long prec);
59         operator long();
60         void print(std::ostream &os) const;
61 // member variables
62 private:
63         long digits;                        ///< Number of decimal digits
64         static bool too_late;               ///< Already one object present
65 };
66
67 /** This class is a wrapper around CLN-numbers within the GiNaC class
68  *  hierarchy. Objects of this type may directly be created by the user.*/
69 class numeric : public basic
70 {
71         GINAC_DECLARE_REGISTERED_CLASS(numeric, basic)
72         
73 // member functions
74         
75         // other ctors
76 public:
77         explicit numeric(int i);
78         explicit numeric(unsigned int i);
79         explicit numeric(long i);
80         explicit numeric(unsigned long i);
81         explicit numeric(long numer, long denom);
82         explicit numeric(double d);
83         explicit numeric(const char *);
84         
85         // functions overriding virtual functions from bases classes
86 public:
87         void print(const print_context & c, unsigned level = 0) const;
88         unsigned precedence(void) const {return 30;}
89         bool info(unsigned inf) const;
90         bool has(const ex &other) const;
91         ex eval(int level = 0) const;
92         ex evalf(int level = 0) const;
93         ex normal(lst &sym_lst, lst &repl_lst, int level = 0) const;
94         ex to_rational(lst &repl_lst) const;
95         numeric integer_content(void) const;
96         ex smod(const numeric &xi) const;
97         numeric max_coefficient(void) const;
98 protected:
99         /** Implementation of ex::diff for a numeric always returns 0.
100          *  @see ex::diff */
101         ex derivative(const symbol &s) const { return _ex0(); }
102         bool is_equal_same_type(const basic &other) const;
103         unsigned calchash(void) const;
104         
105         // new virtual functions which can be overridden by derived classes
106         // (none)
107         
108         // non-virtual functions in this class
109 public:
110         const numeric add(const numeric &other) const;
111         const numeric sub(const numeric &other) const;
112         const numeric mul(const numeric &other) const;
113         const numeric div(const numeric &other) const;
114         const numeric power(const numeric &other) const;
115         const numeric & add_dyn(const numeric &other) const;
116         const numeric & sub_dyn(const numeric &other) const;
117         const numeric & mul_dyn(const numeric &other) const;
118         const numeric & div_dyn(const numeric &other) const;
119         const numeric & power_dyn(const numeric &other) const;
120         const numeric & operator=(int i);
121         const numeric & operator=(unsigned int i);
122         const numeric & operator=(long i);
123         const numeric & operator=(unsigned long i);
124         const numeric & operator=(double d);
125         const numeric & operator=(const char *s);
126         const numeric inverse(void) const;
127         int csgn(void) const;
128         int compare(const numeric &other) const;
129         bool is_equal(const numeric &other) const;
130         bool is_zero(void) const;
131         bool is_positive(void) const;
132         bool is_negative(void) const;
133         bool is_integer(void) const;
134         bool is_pos_integer(void) const;
135         bool is_nonneg_integer(void) const;
136         bool is_even(void) const;
137         bool is_odd(void) const;
138         bool is_prime(void) const;
139         bool is_rational(void) const;
140         bool is_real(void) const;
141         bool is_cinteger(void) const;
142         bool is_crational(void) const;
143         bool operator==(const numeric &other) const;
144         bool operator!=(const numeric &other) const;
145         bool operator<(const numeric &other) const;
146         bool operator<=(const numeric &other) const;
147         bool operator>(const numeric &other) const;
148         bool operator>=(const numeric &other) const;
149         int to_int(void) const;
150         long to_long(void) const;
151         double to_double(void) const;
152         cln::cl_N to_cl_N(void) const;
153         const numeric real(void) const;
154         const numeric imag(void) const;
155         const numeric numer(void) const;
156         const numeric denom(void) const;
157         int int_length(void) const;
158         // converting routines for interfacing with CLN:
159         numeric(const cln::cl_N &z);
160
161 // member variables
162
163 protected:
164         cln::cl_number value;
165 };
166
167 // global constants
168
169 extern const numeric I;
170 extern _numeric_digits Digits;
171
172 // deprecated macro, for internal use only
173 #define is_a_numeric_hash(x) ((x)&0x80000000U)
174
175 // global functions
176
177 const numeric exp(const numeric &x);
178 const numeric log(const numeric &x);
179 const numeric sin(const numeric &x);
180 const numeric cos(const numeric &x);
181 const numeric tan(const numeric &x);
182 const numeric asin(const numeric &x);
183 const numeric acos(const numeric &x);
184 const numeric atan(const numeric &x);
185 const numeric atan(const numeric &y, const numeric &x);
186 const numeric sinh(const numeric &x);
187 const numeric cosh(const numeric &x);
188 const numeric tanh(const numeric &x);
189 const numeric asinh(const numeric &x);
190 const numeric acosh(const numeric &x);
191 const numeric atanh(const numeric &x);
192 const numeric Li2(const numeric &x);
193 const numeric zeta(const numeric &x);
194 const numeric lgamma(const numeric &x);
195 const numeric tgamma(const numeric &x);
196 const numeric psi(const numeric &x);
197 const numeric psi(const numeric &n, const numeric &x);
198 const numeric factorial(const numeric &n);
199 const numeric doublefactorial(const numeric &n);
200 const numeric binomial(const numeric &n, const numeric &k);
201 const numeric bernoulli(const numeric &n);
202 const numeric fibonacci(const numeric &n);
203 const numeric isqrt(const numeric &x);
204 const numeric sqrt(const numeric &x);
205 const numeric abs(const numeric &x);
206 const numeric mod(const numeric &a, const numeric &b);
207 const numeric smod(const numeric &a, const numeric &b);
208 const numeric irem(const numeric &a, const numeric &b);
209 const numeric irem(const numeric &a, const numeric &b, numeric &q);
210 const numeric iquo(const numeric &a, const numeric &b);
211 const numeric iquo(const numeric &a, const numeric &b, numeric &r);
212 const numeric gcd(const numeric &a, const numeric &b);
213 const numeric lcm(const numeric &a, const numeric &b);
214
215 // wrapper functions around member functions
216 inline const numeric pow(const numeric &x, const numeric &y)
217 { return x.power(y); }
218
219 inline const numeric inverse(const numeric &x)
220 { return x.inverse(); }
221
222 inline int csgn(const numeric &x)
223 { return x.csgn(); }
224
225 inline bool is_zero(const numeric &x)
226 { return x.is_zero(); }
227
228 inline bool is_positive(const numeric &x)
229 { return x.is_positive(); }
230
231 inline bool is_integer(const numeric &x)
232 { return x.is_integer(); }
233
234 inline bool is_pos_integer(const numeric &x)
235 { return x.is_pos_integer(); }
236
237 inline bool is_nonneg_integer(const numeric &x)
238 { return x.is_nonneg_integer(); }
239
240 inline bool is_even(const numeric &x)
241 { return x.is_even(); }
242
243 inline bool is_odd(const numeric &x)
244 { return x.is_odd(); }
245
246 inline bool is_prime(const numeric &x)
247 { return x.is_prime(); }
248
249 inline bool is_rational(const numeric &x)
250 { return x.is_rational(); }
251
252 inline bool is_real(const numeric &x)
253 { return x.is_real(); }
254
255 inline bool is_cinteger(const numeric &x)
256 { return x.is_cinteger(); }
257
258 inline bool is_crational(const numeric &x)
259 { return x.is_crational(); }
260
261 inline int to_int(const numeric &x)
262 { return x.to_int(); }
263
264 inline long to_long(const numeric &x)
265 { return x.to_long(); }
266
267 inline double to_double(const numeric &x)
268 { return x.to_double(); }
269
270 inline const numeric real(const numeric &x)
271 { return x.real(); }
272
273 inline const numeric imag(const numeric &x)
274 { return x.imag(); }
275
276 inline const numeric numer(const numeric &x)
277 { return x.numer(); }
278
279 inline const numeric denom(const numeric &x)
280 { return x.denom(); }
281
282 // numeric evaluation functions for class constant objects:
283
284 ex PiEvalf(void);
285 ex EulerEvalf(void);
286 ex CatalanEvalf(void);
287
288
289 // utility functions
290 inline const numeric &ex_to_numeric(const ex &e)
291 {
292         return static_cast<const numeric &>(*e.bp);
293 }
294
295 } // namespace GiNaC
296
297 #ifdef __MAKECINT__
298 #pragma link off defined_in cln/number.h;
299 #pragma link off defined_in cln/complex_class.h;
300 #endif
301
302 #endif // ndef __GINAC_NUMERIC_H__