expt implemented in C, handles complex numbers
[bpt/guile.git] / libguile / numbers.h
1 /* classes: h_files */
2
3 #ifndef SCM_NUMBERS_H
4 #define SCM_NUMBERS_H
5
6 /* Copyright (C) 1995,1996,1998,2000,2001,2002,2003,2004,2005, 2006, 2008, 2009 Free Software Foundation, Inc.
7 *
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public License
10 * as published by the Free Software Foundation; either version 3 of
11 * the License, or (at your option) any later version.
12 *
13 * This library is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
17 *
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
21 * 02110-1301 USA
22 */
23
24 \f
25
26 #include <gmp.h>
27
28 #include "libguile/__scm.h"
29 #include "libguile/print.h"
30
31 #ifndef SCM_T_WCHAR_DEFINED
32 typedef scm_t_int32 scm_t_wchar;
33 #define SCM_T_WCHAR_DEFINED
34 #endif /* SCM_T_WCHAR_DEFINED */
35
36 #if SCM_HAVE_FLOATINGPOINT_H
37 # include <floatingpoint.h>
38 #endif
39
40 #if SCM_HAVE_IEEEFP_H
41 # include <ieeefp.h>
42 #endif
43
44 #if SCM_HAVE_NAN_H
45 # if defined (SCO)
46 # define _IEEE 1
47 # endif
48 # include <nan.h>
49 # if defined (SCO)
50 # undef _IEEE
51 # endif
52 #endif /* SCM_HAVE_NAN_H */
53
54 \f
55
56 /* Immediate Numbers, also known as fixnums
57 *
58 * Inums are exact integer data that fits within an SCM word. */
59
60 /* SCM_T_SIGNED_MAX is (- (expt 2 n) 1),
61 * SCM_MOST_POSITIVE_FIXNUM should be (- (expt 2 (- n 2)) 1)
62 * which is the same as (/ (- (expt 2 n) 4) 4)
63 */
64
65 #define SCM_I_FIXNUM_BIT (SCM_LONG_BIT - 2)
66 #define SCM_MOST_POSITIVE_FIXNUM ((SCM_T_SIGNED_BITS_MAX-3)/4)
67 #define SCM_MOST_NEGATIVE_FIXNUM (-SCM_MOST_POSITIVE_FIXNUM-1)
68
69 /* SCM_SRS is signed right shift */
70 #if (-1 == (((-1) << 2) + 2) >> 2)
71 # define SCM_SRS(x, y) ((x) >> (y))
72 #else
73 # define SCM_SRS(x, y) ((x) < 0 ? ~((~(x)) >> (y)) : ((x) >> (y)))
74 #endif /* (-1 == (((-1) << 2) + 2) >> 2) */
75
76
77 #define SCM_I_INUMP(x) (2 & SCM_UNPACK (x))
78 #define SCM_I_NINUMP(x) (!SCM_I_INUMP (x))
79 #define SCM_I_MAKINUM(x) \
80 (SCM_PACK ((((scm_t_signed_bits) (x)) << 2) + scm_tc2_int))
81 #define SCM_I_INUM(x) (SCM_SRS ((scm_t_signed_bits) SCM_UNPACK (x), 2))
82
83 /* SCM_FIXABLE is true if its long argument can be encoded in an SCM_INUM. */
84 #define SCM_POSFIXABLE(n) ((n) <= SCM_MOST_POSITIVE_FIXNUM)
85 #define SCM_NEGFIXABLE(n) ((n) >= SCM_MOST_NEGATIVE_FIXNUM)
86 #define SCM_FIXABLE(n) (SCM_POSFIXABLE (n) && SCM_NEGFIXABLE (n))
87
88
89 /* A name for 0. */
90 #define SCM_INUM0 (SCM_I_MAKINUM (0))
91
92 /* SCM_MAXEXP is the maximum double precision exponent
93 * SCM_FLTMAX is less than or scm_equal the largest single precision float
94 */
95
96 #if SCM_HAVE_STDC_HEADERS
97 # ifndef GO32
98 # include <float.h>
99 # ifdef __MINGW32__
100 # define copysign _copysign
101 # define finite _finite
102 # endif /* __MINGW32__ */
103 # endif /* ndef GO32 */
104 #endif /* def STDC_HEADERS */
105
106 #ifdef DBL_MAX_10_EXP
107 # define SCM_MAXEXP DBL_MAX_10_EXP
108 #else
109 # define SCM_MAXEXP 308 /* IEEE doubles */
110 #endif /* def DBL_MAX_10_EXP */
111
112 #ifdef FLT_MAX
113 # define SCM_FLTMAX FLT_MAX
114 #else
115 # define SCM_FLTMAX 1e+23
116 #endif /* def FLT_MAX */
117
118
119 /* SCM_INTBUFLEN is the maximum number of characters neccessary for
120 * the printed or scm_string representation of an scm_t_intmax in
121 * radix 2. The buffer passed to scm_iint2str and scm_iuint2str must
122 * be of this size, for example.
123 */
124 #define SCM_INTBUFLEN (5 + SCM_CHAR_BIT*sizeof(scm_t_intmax))
125
126 \f
127
128 /* Numbers
129 */
130
131
132 /* Note that scm_tc16_real and scm_tc16_complex are given tc16-codes that only
133 * differ in one bit: This way, checking if an object is an inexact number can
134 * be done quickly (using the TYP16S macro). */
135
136 /* Number subtype 1 to 3 (note the dependency on the predicates SCM_INEXACTP
137 * and SCM_NUMP) */
138 #define scm_tc16_big (scm_tc7_number + 1 * 256L)
139 #define scm_tc16_real (scm_tc7_number + 2 * 256L)
140 #define scm_tc16_complex (scm_tc7_number + 3 * 256L)
141 #define scm_tc16_fraction (scm_tc7_number + 4 * 256L)
142
143 #define SCM_INEXACTP(x) \
144 (!SCM_IMP (x) && (0xfeff & SCM_CELL_TYPE (x)) == scm_tc16_real)
145 #define SCM_REALP(x) (!SCM_IMP (x) && SCM_TYP16 (x) == scm_tc16_real)
146 #define SCM_COMPLEXP(x) (!SCM_IMP (x) && SCM_TYP16 (x) == scm_tc16_complex)
147
148 #define SCM_REAL_VALUE(x) (((scm_t_double *) SCM2PTR (x))->real)
149 #define SCM_COMPLEX_MEM(x) ((scm_t_complex *) SCM_CELL_WORD_1 (x))
150 #define SCM_COMPLEX_REAL(x) (SCM_COMPLEX_MEM (x)->real)
151 #define SCM_COMPLEX_IMAG(x) (SCM_COMPLEX_MEM (x)->imag)
152
153 /* Each bignum is just an mpz_t stored in a double cell starting at word 1. */
154 #define SCM_I_BIG_MPZ(x) (*((mpz_t *) (SCM_CELL_OBJECT_LOC((x),1))))
155 #define SCM_BIGP(x) (!SCM_IMP (x) && SCM_TYP16 (x) == scm_tc16_big)
156
157 #define SCM_NUMBERP(x) (SCM_I_INUMP(x) || SCM_NUMP(x))
158 #define SCM_NUMP(x) (!SCM_IMP(x) \
159 && (((0xfcff & SCM_CELL_TYPE (x)) == scm_tc7_number) \
160 || ((0xfbff & SCM_CELL_TYPE (x)) == scm_tc7_number)))
161 /* 0xfcff (#b1100) for 0 free, 1 big, 2 real, 3 complex, then 0xfbff (#b1011) for 4 fraction */
162
163 #define SCM_FRACTIONP(x) (!SCM_IMP (x) && SCM_TYP16 (x) == scm_tc16_fraction)
164 #define SCM_FRACTION_NUMERATOR(x) (SCM_CELL_OBJECT_1 (x))
165 #define SCM_FRACTION_DENOMINATOR(x) (SCM_CELL_OBJECT_2 (x))
166
167 \f
168
169 typedef struct scm_t_double
170 {
171 SCM type;
172 SCM pad;
173 double real;
174 } scm_t_double;
175
176 typedef struct scm_t_complex
177 {
178 double real;
179 double imag;
180 } scm_t_complex;
181
182
183 \f
184
185 SCM_API SCM scm_exact_p (SCM x);
186 SCM_API SCM scm_odd_p (SCM n);
187 SCM_API SCM scm_even_p (SCM n);
188 SCM_API SCM scm_inf_p (SCM n);
189 SCM_API SCM scm_nan_p (SCM n);
190 SCM_API SCM scm_inf (void);
191 SCM_API SCM scm_nan (void);
192 SCM_API SCM scm_abs (SCM x);
193 SCM_API SCM scm_quotient (SCM x, SCM y);
194 SCM_API SCM scm_remainder (SCM x, SCM y);
195 SCM_API SCM scm_modulo (SCM x, SCM y);
196 SCM_API SCM scm_gcd (SCM x, SCM y);
197 SCM_API SCM scm_lcm (SCM n1, SCM n2);
198 SCM_API SCM scm_logand (SCM n1, SCM n2);
199 SCM_API SCM scm_logior (SCM n1, SCM n2);
200 SCM_API SCM scm_logxor (SCM n1, SCM n2);
201 SCM_API SCM scm_logtest (SCM n1, SCM n2);
202 SCM_API SCM scm_logbit_p (SCM n1, SCM n2);
203 SCM_API SCM scm_lognot (SCM n);
204 SCM_API SCM scm_modulo_expt (SCM n, SCM k, SCM m);
205 SCM_API SCM scm_integer_expt (SCM z1, SCM z2);
206 SCM_API SCM scm_ash (SCM n, SCM cnt);
207 SCM_API SCM scm_bit_extract (SCM n, SCM start, SCM end);
208 SCM_API SCM scm_logcount (SCM n);
209 SCM_API SCM scm_integer_length (SCM n);
210
211 SCM_API size_t scm_iint2str (scm_t_intmax num, int rad, char *p);
212 SCM_API size_t scm_iuint2str (scm_t_uintmax num, int rad, char *p);
213 SCM_API SCM scm_number_to_string (SCM x, SCM radix);
214 SCM_API int scm_print_real (SCM sexp, SCM port, scm_print_state *pstate);
215 SCM_API int scm_print_complex (SCM sexp, SCM port, scm_print_state *pstate);
216 SCM_API int scm_bigprint (SCM exp, SCM port, scm_print_state *pstate);
217 SCM_API SCM scm_c_locale_stringn_to_number (const char *mem, size_t len,
218 unsigned int radix);
219 SCM_INTERNAL SCM scm_i_string_to_number (SCM str, unsigned int radix);
220 SCM_API SCM scm_string_to_number (SCM str, SCM radix);
221 SCM_API SCM scm_bigequal (SCM x, SCM y);
222 SCM_API SCM scm_real_equalp (SCM x, SCM y);
223 SCM_API SCM scm_complex_equalp (SCM x, SCM y);
224 SCM_API SCM scm_number_p (SCM x);
225 SCM_API SCM scm_complex_p (SCM x);
226 SCM_API SCM scm_real_p (SCM x);
227 SCM_API SCM scm_rational_p (SCM z);
228 SCM_API SCM scm_integer_p (SCM x);
229 SCM_API SCM scm_inexact_p (SCM x);
230 SCM_API SCM scm_num_eq_p (SCM x, SCM y);
231 SCM_API SCM scm_less_p (SCM x, SCM y);
232 SCM_API SCM scm_gr_p (SCM x, SCM y);
233 SCM_API SCM scm_leq_p (SCM x, SCM y);
234 SCM_API SCM scm_geq_p (SCM x, SCM y);
235 SCM_API SCM scm_zero_p (SCM z);
236 SCM_API SCM scm_positive_p (SCM x);
237 SCM_API SCM scm_negative_p (SCM x);
238 SCM_API SCM scm_max (SCM x, SCM y);
239 SCM_API SCM scm_min (SCM x, SCM y);
240 SCM_API SCM scm_sum (SCM x, SCM y);
241 SCM_API SCM scm_oneplus (SCM x);
242 SCM_API SCM scm_difference (SCM x, SCM y);
243 SCM_API SCM scm_oneminus (SCM x);
244 SCM_API SCM scm_product (SCM x, SCM y);
245 SCM_API SCM scm_divide (SCM x, SCM y);
246 SCM_API SCM scm_floor (SCM x);
247 SCM_API SCM scm_ceiling (SCM x);
248 SCM_API double scm_asinh (double x);
249 SCM_API double scm_acosh (double x);
250 SCM_API double scm_atanh (double x);
251 SCM_API double scm_c_truncate (double x);
252 SCM_API double scm_c_round (double x);
253 SCM_API SCM scm_truncate_number (SCM x);
254 SCM_API SCM scm_round_number (SCM x);
255 SCM_API SCM scm_expt (SCM z1, SCM z2);
256 SCM_API SCM scm_sys_atan2 (SCM z1, SCM z2);
257 SCM_API SCM scm_make_rectangular (SCM z1, SCM z2);
258 SCM_API SCM scm_make_polar (SCM z1, SCM z2);
259 SCM_API SCM scm_real_part (SCM z);
260 SCM_API SCM scm_imag_part (SCM z);
261 SCM_API SCM scm_magnitude (SCM z);
262 SCM_API SCM scm_angle (SCM z);
263 SCM_API SCM scm_exact_to_inexact (SCM z);
264 SCM_API SCM scm_inexact_to_exact (SCM z);
265 SCM_API SCM scm_trunc (SCM x);
266 SCM_API SCM scm_log (SCM z);
267 SCM_API SCM scm_log10 (SCM z);
268 SCM_API SCM scm_exp (SCM z);
269 SCM_API SCM scm_sqrt (SCM z);
270
271 /* bignum internal functions */
272 SCM_INTERNAL SCM scm_i_mkbig (void);
273 SCM_API /* FIXME: not internal */ SCM scm_i_normbig (SCM x);
274 SCM_INTERNAL int scm_i_bigcmp (SCM a, SCM b);
275 SCM_INTERNAL SCM scm_i_dbl2big (double d);
276 SCM_INTERNAL SCM scm_i_dbl2num (double d);
277 SCM_API /* FIXME: not internal */ double scm_i_big2dbl (SCM b);
278 SCM_API /* FIXME: not internal */ SCM scm_i_long2big (long n);
279 SCM_API /* FIXME: not internal */ SCM scm_i_ulong2big (unsigned long n);
280 SCM_API /* FIXME: not internal */ SCM scm_i_clonebig (SCM src_big, int same_sign_p);
281
282 /* ratio functions */
283 SCM_API SCM scm_rationalize (SCM x, SCM err);
284 SCM_API SCM scm_numerator (SCM z);
285 SCM_API SCM scm_denominator (SCM z);
286
287 /* fraction internal functions */
288 SCM_INTERNAL double scm_i_fraction2double (SCM z);
289 SCM_INTERNAL SCM scm_i_fraction_equalp (SCM x, SCM y);
290 SCM_INTERNAL int scm_i_print_fraction (SCM sexp, SCM port, scm_print_state *pstate);
291
292 /* general internal functions */
293 SCM_INTERNAL void scm_i_print_double (double val, SCM port);
294 SCM_INTERNAL void scm_i_print_complex (double real, double imag, SCM port);
295
296 /* conversion functions for integers */
297
298 SCM_API int scm_is_integer (SCM val);
299 SCM_API int scm_is_signed_integer (SCM val,
300 scm_t_intmax min, scm_t_intmax max);
301 SCM_API int scm_is_unsigned_integer (SCM val,
302 scm_t_uintmax min, scm_t_uintmax max);
303
304 SCM_API SCM scm_from_signed_integer (scm_t_intmax val);
305 SCM_API SCM scm_from_unsigned_integer (scm_t_uintmax val);
306
307 SCM_API scm_t_intmax scm_to_signed_integer (SCM val,
308 scm_t_intmax min,
309 scm_t_intmax max);
310 SCM_API scm_t_uintmax scm_to_unsigned_integer (SCM val,
311 scm_t_uintmax min,
312 scm_t_uintmax max);
313
314 SCM_API scm_t_int8 scm_to_int8 (SCM x);
315 SCM_API SCM scm_from_int8 (scm_t_int8 x);
316
317 SCM_API scm_t_uint8 scm_to_uint8 (SCM x);
318 SCM_API SCM scm_from_uint8 (scm_t_uint8 x);
319
320 SCM_API scm_t_int16 scm_to_int16 (SCM x);
321 SCM_API SCM scm_from_int16 (scm_t_int16 x);
322
323 SCM_API scm_t_uint16 scm_to_uint16 (SCM x);
324 SCM_API SCM scm_from_uint16 (scm_t_uint16 x);
325
326 SCM_API scm_t_int32 scm_to_int32 (SCM x);
327 SCM_API SCM scm_from_int32 (scm_t_int32 x);
328
329 SCM_API scm_t_uint32 scm_to_uint32 (SCM x);
330 SCM_API SCM scm_from_uint32 (scm_t_uint32 x);
331
332 SCM_API scm_t_wchar scm_to_wchar (SCM x);
333 SCM_API SCM scm_from_wchar (scm_t_wchar x);
334
335 #if SCM_HAVE_T_INT64
336
337 SCM_API scm_t_int64 scm_to_int64 (SCM x);
338 SCM_API SCM scm_from_int64 (scm_t_int64 x);
339
340 SCM_API scm_t_uint64 scm_to_uint64 (SCM x);
341 SCM_API SCM scm_from_uint64 (scm_t_uint64 x);
342
343 #endif
344
345 SCM_API void scm_to_mpz (SCM x, mpz_t rop);
346 SCM_API SCM scm_from_mpz (mpz_t rop);
347
348
349 /* The conversion functions for other types are aliased to the
350 appropriate ones from above. We pick the right one based on the
351 size of the type.
352
353 Not each and every possibility is covered by the code below, and
354 while it is trivial to complete the tests, it might be better to
355 just test for the 'sane' possibilities. When one of the tests
356 below fails, chances are good that some silent assumption somewhere
357 else will also fail.
358 */
359
360 #if SCM_SIZEOF_CHAR == 1
361 #define scm_to_schar scm_to_int8
362 #define scm_from_schar scm_from_int8
363 #define scm_to_uchar scm_to_uint8
364 #define scm_from_uchar scm_from_uint8
365 #if CHAR_MIN == 0
366 #define scm_to_char scm_to_uint8
367 #define scm_from_char scm_from_uint8
368 #else
369 #define scm_to_char scm_to_int8
370 #define scm_from_char scm_from_int8
371 #endif
372 #else
373 #error sizeof(char) is not 1.
374 #endif
375
376 #if SCM_SIZEOF_SHORT == 1
377 #define scm_to_short scm_to_int8
378 #define scm_from_short scm_from_int8
379 #define scm_to_ushort scm_to_uint8
380 #define scm_from_ushort scm_from_uint8
381 #else
382 #if SCM_SIZEOF_SHORT == 2
383 #define scm_to_short scm_to_int16
384 #define scm_from_short scm_from_int16
385 #define scm_to_ushort scm_to_uint16
386 #define scm_from_ushort scm_from_uint16
387 #else
388 #if SCM_SIZEOF_SHORT == 4
389 #define scm_to_short scm_to_int32
390 #define scm_from_short scm_from_int32
391 #define scm_to_ushort scm_to_uint32
392 #define scm_from_ushort scm_from_uint32
393 #else
394 #error sizeof(short) is not 1, 2, or 4.
395 #endif
396 #endif
397 #endif
398
399 #if SCM_SIZEOF_INT == 4
400 #define scm_to_int scm_to_int32
401 #define scm_from_int scm_from_int32
402 #define scm_to_uint scm_to_uint32
403 #define scm_from_uint scm_from_uint32
404 #else
405 #if SCM_SIZEOF_INT == 8
406 #define scm_to_int scm_to_int64
407 #define scm_from_int scm_from_int64
408 #define scm_to_uint scm_to_uint64
409 #define scm_from_uint scm_from_uint64
410 #else
411 #error sizeof(int) is not 4 or 8.
412 #endif
413 #endif
414
415 #if SCM_SIZEOF_LONG == 4
416 #define scm_to_long scm_to_int32
417 #define scm_from_long scm_from_int32
418 #define scm_to_ulong scm_to_uint32
419 #define scm_from_ulong scm_from_uint32
420 #else
421 #if SCM_SIZEOF_LONG == 8
422 #define scm_to_long scm_to_int64
423 #define scm_from_long scm_from_int64
424 #define scm_to_ulong scm_to_uint64
425 #define scm_from_ulong scm_from_uint64
426 #else
427 #error sizeof(long) is not 4 or 8.
428 #endif
429 #endif
430
431 #if SCM_SIZEOF_INTMAX == 4
432 #define scm_to_intmax scm_to_int32
433 #define scm_from_intmax scm_from_int32
434 #define scm_to_uintmax scm_to_uint32
435 #define scm_from_uintmax scm_from_uint32
436 #else
437 #if SCM_SIZEOF_INTMAX == 8
438 #define scm_to_intmax scm_to_int64
439 #define scm_from_intmax scm_from_int64
440 #define scm_to_uintmax scm_to_uint64
441 #define scm_from_uintmax scm_from_uint64
442 #else
443 #error sizeof(scm_t_intmax) is not 4 or 8.
444 #endif
445 #endif
446
447 #if SCM_SIZEOF_LONG_LONG == 0
448 #else
449 #if SCM_SIZEOF_LONG_LONG == 8
450 #define scm_to_long_long scm_to_int64
451 #define scm_from_long_long scm_from_int64
452 #define scm_to_ulong_long scm_to_uint64
453 #define scm_from_ulong_long scm_from_uint64
454 #else
455 #error sizeof(long long) is not 8.
456 #endif
457 #endif
458
459 #if SCM_SIZEOF_SIZE_T == 4
460 #define scm_to_ssize_t scm_to_int32
461 #define scm_from_ssize_t scm_from_int32
462 #define scm_to_size_t scm_to_uint32
463 #define scm_from_size_t scm_from_uint32
464 #else
465 #if SCM_SIZEOF_SIZE_T == 8
466 #define scm_to_ssize_t scm_to_int64
467 #define scm_from_ssize_t scm_from_int64
468 #define scm_to_size_t scm_to_uint64
469 #define scm_from_size_t scm_from_uint64
470 #else
471 #error sizeof(size_t) is not 4 or 8.
472 #endif
473 #endif
474
475 /* conversion functions for double */
476
477 SCM_API int scm_is_real (SCM val);
478 SCM_API int scm_is_rational (SCM val);
479 SCM_API double scm_to_double (SCM val);
480 SCM_API SCM scm_from_double (double val);
481
482 /* conversion functions for complex */
483
484 SCM_API int scm_is_complex (SCM val);
485 SCM_API SCM scm_c_make_rectangular (double re, double im);
486 SCM_API SCM scm_c_make_polar (double mag, double ang);
487 SCM_API double scm_c_real_part (SCM z);
488 SCM_API double scm_c_imag_part (SCM z);
489 SCM_API double scm_c_magnitude (SCM z);
490 SCM_API double scm_c_angle (SCM z);
491
492 SCM_API int scm_is_number (SCM val);
493
494 SCM_INTERNAL void scm_init_numbers (void);
495
496 #endif /* SCM_NUMBERS_H */
497
498 /*
499 Local Variables:
500 c-file-style: "gnu"
501 End:
502 */