- modified the comment blocks so the copyright message no longer appears in
[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 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 <ginac/basic.h>
28
29 #define HASHVALUE_NUMERIC 0x80000001U
30
31 class cl_N;     // We want to include cln.h only in numeric.cpp in order to 
32                 // avoid namespace pollution and keep compile-time low.
33
34 /** This class is used to instantiate a global object Digits which
35  *  behaves just like Maple's Digits.  We need an object rather than a
36  *  dumber basic type since as a side-effect we let it change
37  *  cl_default_float_format when it gets changed.  The only other
38  *  meaningful thing to do with it is converting it to an unsigned,
39  *  for temprary storing its value e.g.  The user must not create an
40  *  own working object of this class!  Since C++ forces us to make the
41  *  class definition visible in order to use an object we put in a
42  *  flag which prevents other objects of that class to be created. */
43 class _numeric_digits
44 {
45 // member functions
46 public:
47     _numeric_digits();
48     _numeric_digits& operator=(long prec);
49     operator long();
50     void print(ostream & os) const;
51 // member variables
52 private:
53     long digits;
54     static bool too_late;
55 };
56
57 /** This class is a wrapper around CLN-numbers within the GiNaC class
58  *  hierarchy. Objects of this type may directly be created by the user.*/
59 class numeric : public basic
60 {
61 // friends
62     friend numeric exp(numeric const & x);
63     friend numeric log(numeric const & x);
64     friend numeric sin(numeric const & x);
65     friend numeric cos(numeric const & x);
66     friend numeric tan(numeric const & x);
67     friend numeric asin(numeric const & x);
68     friend numeric acos(numeric const & x);
69     friend numeric atan(numeric const & x);
70     friend numeric atan(numeric const & y, numeric const & x);
71     friend numeric sinh(numeric const & x);
72     friend numeric cosh(numeric const & x);
73     friend numeric tanh(numeric const & x);
74     friend numeric asinh(numeric const & x);
75     friend numeric acosh(numeric const & x);
76     friend numeric atanh(numeric const & x);
77     friend numeric abs(numeric const & x);
78     friend numeric mod(numeric const & a, numeric const & b);
79     friend numeric smod(numeric const & a, numeric const & b);
80     friend numeric irem(numeric const & a, numeric const & b);
81     friend numeric irem(numeric const & a, numeric const & b, numeric & q);
82     friend numeric iquo(numeric const & a, numeric const & b);
83     friend numeric iquo(numeric const & a, numeric const & b, numeric & r);
84     friend numeric sqrt(numeric const & x);
85     friend numeric isqrt(numeric const & x);
86     friend numeric gcd(numeric const & a, numeric const & b);
87     friend numeric lcm(numeric const & a, numeric const & b);
88     friend numeric const & numZERO(void);
89     friend numeric const & numONE(void);
90     friend numeric const & numTWO(void);
91     friend numeric const & numTHREE(void);
92     friend numeric const & numMINUSONE(void);
93     friend numeric const & numHALF(void);
94
95 // member functions
96
97     // default constructor, destructor, copy constructor assignment
98     // operator and helpers
99 public:
100     numeric();
101     ~numeric();
102     numeric(numeric const & other);
103     numeric const & operator=(numeric const & other);
104 protected:
105     void copy(numeric const & other);
106     void destroy(bool call_parent);
107
108     // other constructors
109 public:
110     explicit numeric(int i);
111     explicit numeric(unsigned int i);
112     explicit numeric(long i);
113     explicit numeric(unsigned long i);
114     explicit numeric(long numer, long denom);
115     explicit numeric(double d);
116     explicit numeric(char const *);
117     numeric(cl_N const & z);
118
119     // functions overriding virtual functions from bases classes
120 public:
121     basic * duplicate() const;
122     void printraw(ostream & os) const;
123     void printtree(ostream & os, unsigned indent) const;
124     void print(ostream & os, unsigned precedence=0) const;
125     void printcsrc(ostream & os, unsigned type, unsigned precedence=0) const;
126     bool info(unsigned inf) const;
127     ex evalf(int level=0) const;
128     ex diff(symbol const & s) const;
129     ex normal(lst &sym_lst, lst &repl_lst, int level=0) const;
130     numeric integer_content(void) const;
131     ex smod(numeric const &xi) const;
132     numeric max_coefficient(void) const;
133 protected:
134     int compare_same_type(basic const & other) const;
135     bool is_equal_same_type(basic const & other) const;
136     unsigned calchash(void) const {
137         hashvalue=HASHVALUE_NUMERIC;
138         return HASHVALUE_NUMERIC;
139     }
140
141     // new virtual functions which can be overridden by derived classes
142     // (none)
143
144     // non-virtual functions in this class
145 public:
146     numeric add(numeric const & other) const;
147     numeric sub(numeric const & other) const;
148     numeric mul(numeric const & other) const;
149     numeric div(numeric const & other) const;
150     numeric power(numeric const & other) const;
151     numeric const & add_dyn(numeric const & other) const;
152     numeric const & sub_dyn(numeric const & other) const;
153     numeric const & mul_dyn(numeric const & other) const;
154     numeric const & div_dyn(numeric const & other) const;
155     numeric const & power_dyn(numeric const & other) const;
156     numeric const & operator=(int i);
157     numeric const & operator=(unsigned int i);
158     numeric const & operator=(long i);
159     numeric const & operator=(unsigned long i);
160     numeric const & operator=(double d);
161     numeric const & operator=(char const * s);
162     /*
163     numeric add_dyn(numeric const & other) const   { return add(other);   }
164     numeric sub_dyn(numeric const & other) const   { return sub(other);   }
165     numeric mul_dyn(numeric const & other) const   { return mul(other);   }
166     numeric div_dyn(numeric const & other) const   { return div(other);   }
167     numeric power_dyn(numeric const & other) const { return power(other); }
168     */
169     numeric inverse(void) const;
170     int compare(numeric const & other) const;
171     bool is_equal(numeric const & other) const;
172     bool is_zero(void) const;
173     bool is_positive(void) const;
174     bool is_negative(void) const;
175     bool is_integer(void) const;
176     bool is_pos_integer(void) const;
177     bool is_nonneg_integer(void) const;
178     bool is_even(void) const;
179     bool is_odd(void) const;
180     bool is_prime(void) const;
181     bool is_rational(void) const;
182     bool is_real(void) const;
183     bool operator==(numeric const & other) const;
184     bool operator!=(numeric const & other) const;
185     bool operator<(numeric const & other) const;
186     bool operator<=(numeric const & other) const;
187     bool operator>(numeric const & other) const;
188     bool operator>=(numeric const & other) const;
189     int to_int(void) const;
190     double to_double(void) const;
191     numeric real(void) const;
192     numeric imag(void) const;
193     numeric numer(void) const;
194     numeric denom(void) const;
195     int int_length(void) const;
196
197 // member variables
198
199 protected:
200     static unsigned precedence;
201     cl_N *value;
202 };
203
204 // global constants
205
206 extern const numeric some_numeric;
207 extern const numeric I;
208 extern type_info const & typeid_numeric;
209 extern _numeric_digits Digits;
210
211 #define is_a_numeric_hash(x) ((x)==HASHVALUE_NUMERIC)
212 // may have to be changed to ((x)>=0x80000000U)
213
214 // global functions
215
216 numeric const & numZERO(void);
217 numeric const & numONE(void);
218 numeric const & numTWO(void);
219 numeric const & numMINUSONE(void);
220 numeric const & numHALF(void);
221
222 numeric exp(numeric const & x);
223 numeric log(numeric const & x);
224 numeric sin(numeric const & x);
225 numeric cos(numeric const & x);
226 numeric tan(numeric const & x);
227 numeric asin(numeric const & x);
228 numeric acos(numeric const & x);
229 numeric atan(numeric const & x);
230 numeric atan(numeric const & y, numeric const & x);
231 numeric sinh(numeric const & x);
232 numeric cosh(numeric const & x);
233 numeric tanh(numeric const & x);
234 numeric asinh(numeric const & x);
235 numeric acosh(numeric const & x);
236 numeric atanh(numeric const & x);
237 numeric gamma(numeric const & x);
238 numeric factorial(numeric const & n);
239 numeric doublefactorial(numeric const & n);
240 numeric binomial(numeric const & n, numeric const & k);
241
242 numeric abs(numeric const & x);
243 numeric mod(numeric const & a, numeric const & b);
244 numeric smod(numeric const & a, numeric const & b);
245 numeric irem(numeric const & a, numeric const & b);
246 numeric irem(numeric const & a, numeric const & b, numeric & q);
247 numeric iquo(numeric const & a, numeric const & b);
248 numeric iquo(numeric const & a, numeric const & b, numeric & r);
249 numeric sqrt(numeric const & x);
250 numeric isqrt(numeric const & x);
251
252 numeric gcd(numeric const & a, numeric const & b);
253 numeric lcm(numeric const & a, numeric const & b);
254
255 /** Exception thrown by numeric members to signal failure */
256 struct numeric_fail
257 {
258     int failval;
259     numeric_fail(int n) { failval = n; }
260 };
261
262 // wrapper functions around member functions
263 inline numeric inverse(numeric const & x)
264 { return x.inverse(); }
265
266 inline bool is_zero(numeric const & x)
267 { return x.is_zero(); }
268
269 inline bool is_positive(numeric const & x)
270 { return x.is_positive(); }
271
272 inline bool is_integer(numeric const & x)
273 { return x.is_integer(); }
274
275 inline bool is_pos_integer(numeric const & x)
276 { return x.is_pos_integer(); }
277
278 inline bool is_nonneg_integer(numeric const & x)
279 { return x.is_nonneg_integer(); }
280
281 inline bool is_even(numeric const & x)
282 { return x.is_even(); }
283
284 inline bool is_odd(numeric const & x)
285 { return x.is_odd(); }
286
287 inline bool is_prime(numeric const & x)
288 { return x.is_prime(); }
289
290 inline bool is_rational(numeric const & x)
291 { return x.is_rational(); }
292
293 inline bool is_real(numeric const & x)
294 { return x.is_real(); }
295
296 inline numeric real(numeric const & x)
297 { return x.real(); }
298
299 inline numeric imag(numeric const & x)
300 { return x.imag(); }
301
302 inline numeric numer(numeric const & x)
303 { return x.numer(); }
304
305 inline numeric denom(numeric const & x)
306 { return x.denom(); }
307
308 /* do we need this any more? */
309 //inline numeric factorial(int n)
310 //{ return factorial(numeric(n)); }
311
312 /* do we need this any more? */
313 //inline numeric binomial(int n, int k)
314 //{ return binomial(numeric(n), numeric(k)); }
315
316 ex IEvalf(void);
317 ex PiEvalf(void);
318 ex EulerGammaEvalf(void);
319 ex CatalanEvalf(void);
320
321 #define ex_to_numeric(X) static_cast<numeric const &>(*(X).bp)
322
323
324 #endif // ndef __GINAC_NUMERIC_H__