/[GiNaC]/ginac/numeric.h
ViewVC logotype

Contents of /ginac/numeric.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.28 - (hide annotations)
Wed Mar 15 19:28:41 2000 UTC (13 years, 2 months ago) by kreckel
Branch: MAIN
CVS Tags: release_0-5-4
Changes since 1.27: +4 -4 lines
File MIME type: text/plain
- According to CLTL 0^I is undefined, 0^(I+epsilon) is 0 and 0^(I-epsilon)
  is an overflow.  Now, this should be honored.

1 cbauer 1.1 /** @file numeric.h
2     *
3 cbauer 1.4 * Makes the interface to the underlying bignum package available. */
4    
5     /*
6 kreckel 1.17 * GiNaC Copyright (C) 1999-2000 Johannes Gutenberg University Mainz, Germany
7 cbauer 1.2 *
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 cbauer 1.1
23 cbauer 1.2 #ifndef __GINAC_NUMERIC_H__
24     #define __GINAC_NUMERIC_H__
25 cbauer 1.1
26     #include <strstream>
27 cbauer 1.21 #include "basic.h"
28     #include "ex.h"
29 cbauer 1.1
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.
32    
33 kreckel 1.22 #ifndef NO_NAMESPACE_GINAC
34 cbauer 1.5 namespace GiNaC {
35 kreckel 1.22 #endif // ndef NO_NAMESPACE_GINAC
36 cbauer 1.5
37     #define HASHVALUE_NUMERIC 0x80000001U
38    
39 cbauer 1.1 /** 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. */
48     class _numeric_digits
49     {
50     // member functions
51     public:
52     _numeric_digits();
53     _numeric_digits& operator=(long prec);
54     operator long();
55     void print(ostream & os) const;
56     // member variables
57     private:
58     long digits;
59     static bool too_late;
60     };
61    
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
65     {
66 cbauer 1.18 GINAC_DECLARE_REGISTERED_CLASS(numeric, basic)
67    
68 cbauer 1.1 // friends
69 kreckel 1.20 friend const numeric exp(const numeric & x);
70     friend const numeric log(const numeric & x);
71     friend const numeric sin(const numeric & x);
72     friend const numeric cos(const numeric & x);
73     friend const numeric tan(const numeric & x);
74     friend const numeric asin(const numeric & x);
75     friend const numeric acos(const numeric & x);
76     friend const numeric atan(const numeric & x);
77     friend const numeric atan(const numeric & y, const numeric & x);
78     friend const numeric sinh(const numeric & x);
79     friend const numeric cosh(const numeric & x);
80     friend const numeric tanh(const numeric & x);
81     friend const numeric asinh(const numeric & x);
82     friend const numeric acosh(const numeric & x);
83     friend const numeric atanh(const numeric & x);
84     friend const numeric zeta(const numeric & x);
85     friend const numeric bernoulli(const numeric & n);
86 kreckel 1.27 friend const numeric fibonacci(const numeric & n);
87 kreckel 1.16 friend numeric abs(const numeric & x);
88     friend numeric mod(const numeric & a, const numeric & b);
89     friend numeric smod(const numeric & a, const numeric & b);
90     friend numeric irem(const numeric & a, const numeric & b);
91     friend numeric irem(const numeric & a, const numeric & b, numeric & q);
92     friend numeric iquo(const numeric & a, const numeric & b);
93     friend numeric iquo(const numeric & a, const numeric & b, numeric & r);
94     friend numeric sqrt(const numeric & x);
95     friend numeric isqrt(const numeric & x);
96     friend numeric gcd(const numeric & a, const numeric & b);
97     friend numeric lcm(const numeric & a, const numeric & b);
98 cbauer 1.1
99     // member functions
100    
101     // default constructor, destructor, copy constructor assignment
102     // operator and helpers
103     public:
104     numeric();
105     ~numeric();
106 kreckel 1.16 numeric(const numeric & other);
107     const numeric & operator=(const numeric & other);
108 cbauer 1.1 protected:
109 kreckel 1.16 void copy(const numeric & other);
110 cbauer 1.1 void destroy(bool call_parent);
111    
112     // other constructors
113     public:
114     explicit numeric(int i);
115     explicit numeric(unsigned int i);
116     explicit numeric(long i);
117     explicit numeric(unsigned long i);
118     explicit numeric(long numer, long denom);
119     explicit numeric(double d);
120 cbauer 1.19 explicit numeric(const char *);
121 kreckel 1.24 numeric(const cl_N & z);
122    
123 cbauer 1.1 // functions overriding virtual functions from bases classes
124     public:
125     basic * duplicate() const;
126 kreckel 1.14 void print(ostream & os, unsigned precedence=0) const;
127 cbauer 1.1 void printraw(ostream & os) const;
128     void printtree(ostream & os, unsigned indent) const;
129     void printcsrc(ostream & os, unsigned type, unsigned precedence=0) const;
130     bool info(unsigned inf) const;
131 kreckel 1.25 bool has(const ex & other) const;
132 kreckel 1.22 ex eval(int level=0) const;
133 cbauer 1.1 ex evalf(int level=0) const;
134     ex normal(lst &sym_lst, lst &repl_lst, int level=0) const;
135     numeric integer_content(void) const;
136 kreckel 1.16 ex smod(const numeric &xi) const;
137 cbauer 1.1 numeric max_coefficient(void) const;
138     protected:
139 kreckel 1.23 ex derivative(const symbol & s) const;
140 cbauer 1.19 int compare_same_type(const basic & other) const;
141     bool is_equal_same_type(const basic & other) const;
142 frink 1.26 unsigned calchash(void) const;
143 cbauer 1.1
144     // new virtual functions which can be overridden by derived classes
145     // (none)
146    
147     // non-virtual functions in this class
148     public:
149 kreckel 1.16 numeric add(const numeric & other) const;
150     numeric sub(const numeric & other) const;
151     numeric mul(const numeric & other) const;
152     numeric div(const numeric & other) const;
153     numeric power(const numeric & other) const;
154     const numeric & add_dyn(const numeric & other) const;
155     const numeric & sub_dyn(const numeric & other) const;
156     const numeric & mul_dyn(const numeric & other) const;
157     const numeric & div_dyn(const numeric & other) const;
158     const numeric & power_dyn(const numeric & other) const;
159     const numeric & operator=(int i);
160     const numeric & operator=(unsigned int i);
161     const numeric & operator=(long i);
162     const numeric & operator=(unsigned long i);
163     const numeric & operator=(double d);
164 cbauer 1.19 const numeric & operator=(const char * s);
165 cbauer 1.1 numeric inverse(void) const;
166 kreckel 1.6 int csgn(void) const;
167 kreckel 1.16 int compare(const numeric & other) const;
168     bool is_equal(const numeric & other) const;
169 cbauer 1.1 bool is_zero(void) const;
170     bool is_positive(void) const;
171     bool is_negative(void) const;
172     bool is_integer(void) const;
173     bool is_pos_integer(void) const;
174     bool is_nonneg_integer(void) const;
175     bool is_even(void) const;
176     bool is_odd(void) const;
177     bool is_prime(void) const;
178     bool is_rational(void) const;
179     bool is_real(void) const;
180 kreckel 1.13 bool is_cinteger(void) const;
181     bool is_crational(void) const;
182 kreckel 1.16 bool operator==(const numeric & other) const;
183     bool operator!=(const numeric & other) const;
184     bool operator<(const numeric & other) const;
185     bool operator<=(const numeric & other) const;
186     bool operator>(const numeric & other) const;
187     bool operator>=(const numeric & other) const;
188 cbauer 1.1 int to_int(void) const;
189 kreckel 1.20 long to_long(void) const;
190 cbauer 1.1 double to_double(void) const;
191 kreckel 1.28 const numeric real(void) const;
192     const numeric imag(void) const;
193     const numeric numer(void) const;
194     const numeric denom(void) const;
195 cbauer 1.1 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 cbauer 1.19 extern const type_info & typeid_numeric;
209 cbauer 1.1 extern _numeric_digits Digits;
210    
211 frink 1.26 //#define is_a_numeric_hash(x) ((x)==HASHVALUE_NUMERIC)
212 cbauer 1.1 // may have to be changed to ((x)>=0x80000000U)
213 frink 1.26
214     // has been changed
215     //#define is_a_numeric_hash(x) ((x)&0x80000000U)
216 cbauer 1.1
217     // global functions
218    
219 kreckel 1.20 const numeric exp(const numeric & x);
220     const numeric log(const numeric & x);
221     const numeric sin(const numeric & x);
222     const numeric cos(const numeric & x);
223     const numeric tan(const numeric & x);
224     const numeric asin(const numeric & x);
225     const numeric acos(const numeric & x);
226     const numeric atan(const numeric & x);
227     const numeric atan(const numeric & y, const numeric & x);
228     const numeric sinh(const numeric & x);
229     const numeric cosh(const numeric & x);
230     const numeric tanh(const numeric & x);
231     const numeric asinh(const numeric & x);
232     const numeric acosh(const numeric & x);
233     const numeric atanh(const numeric & x);
234     const numeric zeta(const numeric & x);
235     const numeric gamma(const numeric & x);
236     const numeric psi(const numeric & x);
237     const numeric psi(const numeric & n, const numeric & x);
238     const numeric factorial(const numeric & n);
239     const numeric doublefactorial(const numeric & n);
240     const numeric binomial(const numeric & n, const numeric & k);
241     const numeric bernoulli(const numeric & n);
242     const numeric fibonacci(const numeric & n);
243 kreckel 1.16
244     numeric abs(const numeric & x);
245     numeric mod(const numeric & a, const numeric & b);
246     numeric smod(const numeric & a, const numeric & b);
247     numeric irem(const numeric & a, const numeric & b);
248     numeric irem(const numeric & a, const numeric & b, numeric & q);
249     numeric iquo(const numeric & a, const numeric & b);
250     numeric iquo(const numeric & a, const numeric & b, numeric & r);
251     numeric sqrt(const numeric & x);
252     numeric isqrt(const numeric & x);
253 cbauer 1.1
254 kreckel 1.16 numeric gcd(const numeric & a, const numeric & b);
255     numeric lcm(const numeric & a, const numeric & b);
256 cbauer 1.1
257     /** Exception thrown by numeric members to signal failure */
258     struct numeric_fail
259     {
260     int failval;
261     numeric_fail(int n) { failval = n; }
262     };
263    
264     // wrapper functions around member functions
265 kreckel 1.16 inline numeric pow(const numeric & x, const numeric & y)
266     { return x.power(y); }
267    
268     inline numeric inverse(const numeric & x)
269 cbauer 1.1 { return x.inverse(); }
270 kreckel 1.6
271 kreckel 1.16 inline bool csgn(const numeric & x)
272 kreckel 1.6 { return x.csgn(); }
273 cbauer 1.1
274 kreckel 1.16 inline bool is_zero(const numeric & x)
275 cbauer 1.1 { return x.is_zero(); }
276    
277 kreckel 1.16 inline bool is_positive(const numeric & x)
278 cbauer 1.1 { return x.is_positive(); }
279    
280 kreckel 1.16 inline bool is_integer(const numeric & x)
281 cbauer 1.1 { return x.is_integer(); }
282    
283 kreckel 1.16 inline bool is_pos_integer(const numeric & x)
284 cbauer 1.1 { return x.is_pos_integer(); }
285    
286 kreckel 1.16 inline bool is_nonneg_integer(const numeric & x)
287 cbauer 1.1 { return x.is_nonneg_integer(); }
288    
289 kreckel 1.16 inline bool is_even(const numeric & x)
290 cbauer 1.1 { return x.is_even(); }
291    
292 kreckel 1.16 inline bool is_odd(const numeric & x)
293 cbauer 1.1 { return x.is_odd(); }
294    
295 kreckel 1.16 inline bool is_prime(const numeric & x)
296 cbauer 1.1 { return x.is_prime(); }
297    
298 kreckel 1.16 inline bool is_rational(const numeric & x)
299 cbauer 1.1 { return x.is_rational(); }
300    
301 kreckel 1.16 inline bool is_real(const numeric & x)
302 cbauer 1.1 { return x.is_real(); }
303    
304 kreckel 1.16 inline bool is_cinteger(const numeric & x)
305 kreckel 1.14 { return x.is_cinteger(); }
306    
307 kreckel 1.16 inline bool is_crational(const numeric & x)
308 kreckel 1.14 { return x.is_crational(); }
309    
310 kreckel 1.16 inline numeric real(const numeric & x)
311 cbauer 1.1 { return x.real(); }
312    
313 kreckel 1.16 inline numeric imag(const numeric & x)
314 cbauer 1.1 { return x.imag(); }
315    
316 kreckel 1.16 inline numeric numer(const numeric & x)
317 cbauer 1.1 { return x.numer(); }
318    
319 kreckel 1.16 inline numeric denom(const numeric & x)
320 cbauer 1.1 { return x.denom(); }
321    
322 kreckel 1.11 // numeric evaluation functions for class constant objects:
323    
324 cbauer 1.1 ex PiEvalf(void);
325     ex EulerGammaEvalf(void);
326     ex CatalanEvalf(void);
327    
328 kreckel 1.23
329 cbauer 1.5 // utility functions
330 kreckel 1.23 inline const numeric &ex_to_numeric(const ex &e)
331     {
332     return static_cast<const numeric &>(*e.bp);
333     }
334    
335 cbauer 1.1
336 kreckel 1.22 #ifndef NO_NAMESPACE_GINAC
337 cbauer 1.5 } // namespace GiNaC
338 kreckel 1.22 #endif // ndef NO_NAMESPACE_GINAC
339 cbauer 1.1
340 cbauer 1.2 #endif // ndef __GINAC_NUMERIC_H__

Christian Bauer">Christian Bauer
ViewVC Help
Powered by ViewVC 1.1.15