- replaced the various print*() member functions by a single print() that
[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 <strstream>
27 #include "basic.h"
28 #include "ex.h"
29
30 #include <cln/number.h>
31 // forward decln of cln::cl_N, since cln/complex_class.h is not included:
32 namespace cln { class cl_N; }
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 #define HASHVALUE_NUMERIC 0x80000001U
44
45 /** This class is used to instantiate a global singleton object Digits
46  *  which behaves just like Maple's Digits.  We need an object rather 
47  *  than a dumber basic type since as a side-effect we let it change
48  *  cl_default_float_format when it gets changed.  The only other
49  *  meaningful thing to do with it is converting it to an unsigned,
50  *  for temprary storing its value e.g.  The user must not create an
51  *  own working object of this class!  Since C++ forces us to make the
52  *  class definition visible in order to use an object we put in a
53  *  flag which prevents other objects of that class to be created. */
54 class _numeric_digits
55 {
56 // member functions
57 public:
58         _numeric_digits();
59         _numeric_digits& operator=(long prec);
60         operator long();
61         void print(std::ostream &os) const;
62 // member variables
63 private:
64         long digits;                        ///< Number of decimal digits
65         static bool too_late;               ///< Already one object present
66 };
67
68 /** This class is a wrapper around CLN-numbers within the GiNaC class
69  *  hierarchy. Objects of this type may directly be created by the user.*/
70 class numeric : public basic
71 {
72         GINAC_DECLARE_REGISTERED_CLASS(numeric, basic)
73         
74 // member functions
75         
76         // other ctors
77 public:
78         explicit numeric(int i);
79         explicit numeric(unsigned int i);
80         explicit numeric(long i);
81         explicit numeric(unsigned long i);
82         explicit numeric(long numer, long denom);
83         explicit numeric(double d);
84         explicit numeric(const char *);
85         
86         // functions overriding virtual functions from bases classes
87 public:
88         void print(const print_context & c, unsigned level = 0) const;
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         static unsigned precedence;
165         cln::cl_number value;
166 };
167
168 // global constants
169
170 extern const numeric I;
171 extern _numeric_digits Digits;
172
173 // deprecated macro, for internal use only
174 #define is_a_numeric_hash(x) ((x)&0x80000000U)
175
176 // global functions
177
178 const numeric exp(const numeric &x);
179 const numeric log(const numeric &x);
180 const numeric sin(const numeric &x);
181 const numeric cos(const numeric &x);
182 const numeric tan(const numeric &x);
183 const numeric asin(const numeric &x);
184 const numeric acos(const numeric &x);
185 const numeric atan(const numeric &x);
186 const numeric atan(const numeric &y, const numeric &x);
187 const numeric sinh(const numeric &x);
188 const numeric cosh(const numeric &x);
189 const numeric tanh(const numeric &x);
190 const numeric asinh(const numeric &x);
191 const numeric acosh(const numeric &x);
192 const numeric atanh(const numeric &x);
193 const numeric Li2(const numeric &x);
194 const numeric zeta(const numeric &x);
195 const numeric lgamma(const numeric &x);
196 const numeric tgamma(const numeric &x);
197 const numeric psi(const numeric &x);
198 const numeric psi(const numeric &n, const numeric &x);
199 const numeric factorial(const numeric &n);
200 const numeric doublefactorial(const numeric &n);
201 const numeric binomial(const numeric &n, const numeric &k);
202 const numeric bernoulli(const numeric &n);
203 const numeric fibonacci(const numeric &n);
204 const numeric abs(const numeric &x);
205 const numeric isqrt(const numeric &x);
206 const numeric sqrt(const numeric &x);
207 const numeric abs(const numeric &x);
208 const numeric mod(const numeric &a, const numeric &b);
209 const numeric smod(const numeric &a, const numeric &b);
210 const numeric irem(const numeric &a, const numeric &b);
211 const numeric irem(const numeric &a, const numeric &b, numeric &q);
212 const numeric iquo(const numeric &a, const numeric &b);
213 const numeric iquo(const numeric &a, const numeric &b, numeric &r);
214 const numeric gcd(const numeric &a, const numeric &b);
215 const numeric lcm(const numeric &a, const numeric &b);
216
217 // wrapper functions around member functions
218 inline const numeric pow(const numeric &x, const numeric &y)
219 { return x.power(y); }
220
221 inline const numeric inverse(const numeric &x)
222 { return x.inverse(); }
223
224 inline int csgn(const numeric &x)
225 { return x.csgn(); }
226
227 inline bool is_zero(const numeric &x)
228 { return x.is_zero(); }
229
230 inline bool is_positive(const numeric &x)
231 { return x.is_positive(); }
232
233 inline bool is_integer(const numeric &x)
234 { return x.is_integer(); }
235
236 inline bool is_pos_integer(const numeric &x)
237 { return x.is_pos_integer(); }
238
239 inline bool is_nonneg_integer(const numeric &x)
240 { return x.is_nonneg_integer(); }
241
242 inline bool is_even(const numeric &x)
243 { return x.is_even(); }
244
245 inline bool is_odd(const numeric &x)
246 { return x.is_odd(); }
247
248 inline bool is_prime(const numeric &x)
249 { return x.is_prime(); }
250
251 inline bool is_rational(const numeric &x)
252 { return x.is_rational(); }
253
254 inline bool is_real(const numeric &x)
255 { return x.is_real(); }
256
257 inline bool is_cinteger(const numeric &x)
258 { return x.is_cinteger(); }
259
260 inline bool is_crational(const numeric &x)
261 { return x.is_crational(); }
262
263 inline int to_int(const numeric &x)
264 { return x.to_int(); }
265
266 inline long to_long(const numeric &x)
267 { return x.to_long(); }
268
269 inline double to_double(const numeric &x)
270 { return x.to_double(); }
271
272 inline const numeric real(const numeric &x)
273 { return x.real(); }
274
275 inline const numeric imag(const numeric &x)
276 { return x.imag(); }
277
278 inline const numeric numer(const numeric &x)
279 { return x.numer(); }
280
281 inline const numeric denom(const numeric &x)
282 { return x.denom(); }
283
284 // numeric evaluation functions for class constant objects:
285
286 ex PiEvalf(void);
287 ex EulerEvalf(void);
288 ex CatalanEvalf(void);
289
290
291 // utility functions
292 inline const numeric &ex_to_numeric(const ex &e)
293 {
294         return static_cast<const numeric &>(*e.bp);
295 }
296
297 } // namespace GiNaC
298
299 #ifdef __MAKECINT__
300 #pragma link off defined_in cln/number.h;
301 #pragma link off defined_in cln/complex_class.h;
302 #endif
303
304 #endif // ndef __GINAC_NUMERIC_H__