Allocate complex numbers in contiguous pointer-less memory.
[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, 2010 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 \f
37
38 /* Immediate Numbers, also known as fixnums
39 *
40 * Inums are exact integer data that fits within an SCM word. */
41
42 /* SCM_T_SIGNED_MAX is (- (expt 2 n) 1),
43 * SCM_MOST_POSITIVE_FIXNUM should be (- (expt 2 (- n 2)) 1)
44 * which is the same as (/ (- (expt 2 n) 4) 4)
45 */
46
47 #define SCM_I_FIXNUM_BIT (SCM_LONG_BIT - 2)
48 #define SCM_MOST_POSITIVE_FIXNUM ((SCM_T_SIGNED_BITS_MAX-3)/4)
49 #define SCM_MOST_NEGATIVE_FIXNUM (-SCM_MOST_POSITIVE_FIXNUM-1)
50
51 /* SCM_SRS is signed right shift */
52 #if (-1 == (((-1) << 2) + 2) >> 2)
53 # define SCM_SRS(x, y) ((x) >> (y))
54 #else
55 # define SCM_SRS(x, y) ((x) < 0 ? ~((~(x)) >> (y)) : ((x) >> (y)))
56 #endif /* (-1 == (((-1) << 2) + 2) >> 2) */
57
58
59 #define SCM_I_INUMP(x) (2 & SCM_UNPACK (x))
60 #define SCM_I_NINUMP(x) (!SCM_I_INUMP (x))
61 #define SCM_I_MAKINUM(x) \
62 (SCM_PACK ((((scm_t_signed_bits) (x)) << 2) + scm_tc2_int))
63 #define SCM_I_INUM(x) (SCM_SRS ((scm_t_signed_bits) SCM_UNPACK (x), 2))
64
65 /* SCM_FIXABLE is true if its long argument can be encoded in an SCM_INUM. */
66 #define SCM_POSFIXABLE(n) ((n) <= SCM_MOST_POSITIVE_FIXNUM)
67 #define SCM_NEGFIXABLE(n) ((n) >= SCM_MOST_NEGATIVE_FIXNUM)
68 #define SCM_FIXABLE(n) (SCM_POSFIXABLE (n) && SCM_NEGFIXABLE (n))
69
70
71 /* A name for 0. */
72 #define SCM_INUM0 (SCM_I_MAKINUM (0))
73
74 /* SCM_MAXEXP is the maximum double precision exponent
75 * SCM_FLTMAX is less than or scm_equal the largest single precision float
76 */
77
78 #if SCM_HAVE_STDC_HEADERS
79 # ifndef GO32
80 # include <float.h>
81 # ifdef __MINGW32__
82 # define copysign _copysign
83 # define finite _finite
84 # endif /* __MINGW32__ */
85 # endif /* ndef GO32 */
86 #endif /* def STDC_HEADERS */
87
88 #ifdef DBL_MAX_10_EXP
89 # define SCM_MAXEXP DBL_MAX_10_EXP
90 #else
91 # define SCM_MAXEXP 308 /* IEEE doubles */
92 #endif /* def DBL_MAX_10_EXP */
93
94 #ifdef FLT_MAX
95 # define SCM_FLTMAX FLT_MAX
96 #else
97 # define SCM_FLTMAX 1e+23
98 #endif /* def FLT_MAX */
99
100
101 /* SCM_INTBUFLEN is the maximum number of characters neccessary for
102 * the printed or scm_string representation of an scm_t_intmax in
103 * radix 2. The buffer passed to scm_iint2str and scm_iuint2str must
104 * be of this size, for example.
105 */
106 #define SCM_INTBUFLEN (5 + SCM_CHAR_BIT*sizeof(scm_t_intmax))
107
108 \f
109
110 /* Numbers
111 */
112
113
114 /* Note that scm_tc16_real and scm_tc16_complex are given tc16-codes that only
115 * differ in one bit: This way, checking if an object is an inexact number can
116 * be done quickly (using the TYP16S macro). */
117
118 /* Number subtype 1 to 3 (note the dependency on the predicates SCM_INEXACTP
119 * and SCM_NUMP) */
120 #define scm_tc16_big (scm_tc7_number + 1 * 256L)
121 #define scm_tc16_real (scm_tc7_number + 2 * 256L)
122 #define scm_tc16_complex (scm_tc7_number + 3 * 256L)
123 #define scm_tc16_fraction (scm_tc7_number + 4 * 256L)
124
125 #define SCM_INEXACTP(x) \
126 (!SCM_IMP (x) && (0xfeff & SCM_CELL_TYPE (x)) == scm_tc16_real)
127 #define SCM_REALP(x) (!SCM_IMP (x) && SCM_TYP16 (x) == scm_tc16_real)
128 #define SCM_COMPLEXP(x) (!SCM_IMP (x) && SCM_TYP16 (x) == scm_tc16_complex)
129
130 #define SCM_REAL_VALUE(x) (((scm_t_double *) SCM2PTR (x))->real)
131 #define SCM_COMPLEX_REAL(x) (((scm_t_complex *) SCM2PTR (x))->real)
132 #define SCM_COMPLEX_IMAG(x) (((scm_t_complex *) SCM2PTR (x))->imag)
133
134 /* Each bignum is just an mpz_t stored in a double cell starting at word 1. */
135 #define SCM_I_BIG_MPZ(x) (*((mpz_t *) (SCM_CELL_OBJECT_LOC((x),1))))
136 #define SCM_BIGP(x) (!SCM_IMP (x) && SCM_TYP16 (x) == scm_tc16_big)
137
138 #define SCM_NUMBERP(x) (SCM_I_INUMP(x) || SCM_NUMP(x))
139 #define SCM_NUMP(x) (!SCM_IMP(x) \
140 && (((0xfcff & SCM_CELL_TYPE (x)) == scm_tc7_number) \
141 || ((0xfbff & SCM_CELL_TYPE (x)) == scm_tc7_number)))
142 /* 0xfcff (#b1100) for 0 free, 1 big, 2 real, 3 complex, then 0xfbff (#b1011) for 4 fraction */
143
144 #define SCM_FRACTIONP(x) (!SCM_IMP (x) && SCM_TYP16 (x) == scm_tc16_fraction)
145 #define SCM_FRACTION_NUMERATOR(x) (SCM_CELL_OBJECT_1 (x))
146 #define SCM_FRACTION_DENOMINATOR(x) (SCM_CELL_OBJECT_2 (x))
147
148 \f
149
150 typedef struct scm_t_double
151 {
152 SCM type;
153 SCM pad;
154 double real;
155 } scm_t_double;
156
157 typedef struct scm_t_complex
158 {
159 SCM type;
160 SCM pad;
161 double real;
162 double imag;
163 } scm_t_complex;
164
165
166 \f
167
168 SCM_API SCM scm_exact_p (SCM x);
169 SCM_API SCM scm_odd_p (SCM n);
170 SCM_API SCM scm_even_p (SCM n);
171 SCM_API SCM scm_inf_p (SCM n);
172 SCM_API SCM scm_nan_p (SCM n);
173 SCM_API SCM scm_inf (void);
174 SCM_API SCM scm_nan (void);
175 SCM_API SCM scm_abs (SCM x);
176 SCM_API SCM scm_quotient (SCM x, SCM y);
177 SCM_API SCM scm_remainder (SCM x, SCM y);
178 SCM_API SCM scm_modulo (SCM x, SCM y);
179 SCM_API SCM scm_gcd (SCM x, SCM y);
180 SCM_API SCM scm_lcm (SCM n1, SCM n2);
181 SCM_API SCM scm_logand (SCM n1, SCM n2);
182 SCM_API SCM scm_logior (SCM n1, SCM n2);
183 SCM_API SCM scm_logxor (SCM n1, SCM n2);
184 SCM_API SCM scm_logtest (SCM n1, SCM n2);
185 SCM_API SCM scm_logbit_p (SCM n1, SCM n2);
186 SCM_API SCM scm_lognot (SCM n);
187 SCM_API SCM scm_modulo_expt (SCM n, SCM k, SCM m);
188 SCM_API SCM scm_integer_expt (SCM z1, SCM z2);
189 SCM_API SCM scm_ash (SCM n, SCM cnt);
190 SCM_API SCM scm_bit_extract (SCM n, SCM start, SCM end);
191 SCM_API SCM scm_logcount (SCM n);
192 SCM_API SCM scm_integer_length (SCM n);
193
194 SCM_INTERNAL SCM scm_i_gcd (SCM x, SCM y, SCM rest);
195 SCM_INTERNAL SCM scm_i_lcm (SCM x, SCM y, SCM rest);
196 SCM_INTERNAL SCM scm_i_logand (SCM x, SCM y, SCM rest);
197 SCM_INTERNAL SCM scm_i_logior (SCM x, SCM y, SCM rest);
198 SCM_INTERNAL SCM scm_i_logxor (SCM x, SCM y, SCM rest);
199
200 SCM_API size_t scm_iint2str (scm_t_intmax num, int rad, char *p);
201 SCM_API size_t scm_iuint2str (scm_t_uintmax num, int rad, char *p);
202 SCM_API SCM scm_number_to_string (SCM x, SCM radix);
203 SCM_API int scm_print_real (SCM sexp, SCM port, scm_print_state *pstate);
204 SCM_API int scm_print_complex (SCM sexp, SCM port, scm_print_state *pstate);
205 SCM_API int scm_bigprint (SCM exp, SCM port, scm_print_state *pstate);
206 SCM_API SCM scm_c_locale_stringn_to_number (const char *mem, size_t len,
207 unsigned int radix);
208 SCM_INTERNAL SCM scm_i_string_to_number (SCM str, unsigned int radix);
209 SCM_API SCM scm_string_to_number (SCM str, SCM radix);
210 SCM_API SCM scm_bigequal (SCM x, SCM y);
211 SCM_API SCM scm_real_equalp (SCM x, SCM y);
212 SCM_API SCM scm_complex_equalp (SCM x, SCM y);
213 SCM_API SCM scm_number_p (SCM x);
214 SCM_API SCM scm_complex_p (SCM x);
215 SCM_API SCM scm_real_p (SCM x);
216 SCM_API SCM scm_rational_p (SCM z);
217 SCM_API SCM scm_integer_p (SCM x);
218 SCM_API SCM scm_inexact_p (SCM x);
219 SCM_API SCM scm_num_eq_p (SCM x, SCM y);
220 SCM_API SCM scm_less_p (SCM x, SCM y);
221 SCM_API SCM scm_gr_p (SCM x, SCM y);
222 SCM_API SCM scm_leq_p (SCM x, SCM y);
223 SCM_API SCM scm_geq_p (SCM x, SCM y);
224 SCM_API SCM scm_zero_p (SCM z);
225 SCM_API SCM scm_positive_p (SCM x);
226 SCM_API SCM scm_negative_p (SCM x);
227 SCM_API SCM scm_max (SCM x, SCM y);
228 SCM_API SCM scm_min (SCM x, SCM y);
229 SCM_API SCM scm_sum (SCM x, SCM y);
230 SCM_API SCM scm_oneplus (SCM x);
231 SCM_API SCM scm_difference (SCM x, SCM y);
232 SCM_API SCM scm_oneminus (SCM x);
233 SCM_API SCM scm_product (SCM x, SCM y);
234 SCM_API SCM scm_divide (SCM x, SCM y);
235 SCM_API SCM scm_floor (SCM x);
236 SCM_API SCM scm_ceiling (SCM x);
237 SCM_API double scm_c_truncate (double x);
238 SCM_API double scm_c_round (double x);
239 SCM_API SCM scm_truncate_number (SCM x);
240 SCM_API SCM scm_round_number (SCM x);
241 SCM_API SCM scm_expt (SCM z1, SCM z2);
242 SCM_API SCM scm_sin (SCM z);
243 SCM_API SCM scm_cos (SCM z);
244 SCM_API SCM scm_tan (SCM z);
245 SCM_API SCM scm_sinh (SCM z);
246 SCM_API SCM scm_cosh (SCM z);
247 SCM_API SCM scm_tanh (SCM z);
248 SCM_API SCM scm_asin (SCM z);
249 SCM_API SCM scm_acos (SCM z);
250 SCM_API SCM scm_atan (SCM x, SCM y);
251 SCM_API SCM scm_sys_asinh (SCM z);
252 SCM_API SCM scm_sys_acosh (SCM z);
253 SCM_API SCM scm_sys_atanh (SCM z);
254 SCM_API SCM scm_make_rectangular (SCM z1, SCM z2);
255 SCM_API SCM scm_make_polar (SCM z1, SCM z2);
256 SCM_API SCM scm_real_part (SCM z);
257 SCM_API SCM scm_imag_part (SCM z);
258 SCM_API SCM scm_magnitude (SCM z);
259 SCM_API SCM scm_angle (SCM z);
260 SCM_API SCM scm_exact_to_inexact (SCM z);
261 SCM_API SCM scm_inexact_to_exact (SCM z);
262 SCM_API SCM scm_trunc (SCM x);
263 SCM_API SCM scm_log (SCM z);
264 SCM_API SCM scm_log10 (SCM z);
265 SCM_API SCM scm_exp (SCM z);
266 SCM_API SCM scm_sqrt (SCM z);
267
268 SCM_INTERNAL SCM scm_i_min (SCM x, SCM y, SCM rest);
269 SCM_INTERNAL SCM scm_i_max (SCM x, SCM y, SCM rest);
270 SCM_INTERNAL SCM scm_i_sum (SCM x, SCM y, SCM rest);
271 SCM_INTERNAL SCM scm_i_difference (SCM x, SCM y, SCM rest);
272 SCM_INTERNAL SCM scm_i_product (SCM x, SCM y, SCM rest);
273 SCM_INTERNAL SCM scm_i_divide (SCM x, SCM y, SCM rest);
274
275 /* bignum internal functions */
276 SCM_INTERNAL SCM scm_i_mkbig (void);
277 SCM_API /* FIXME: not internal */ SCM scm_i_normbig (SCM x);
278 SCM_INTERNAL int scm_i_bigcmp (SCM a, SCM b);
279 SCM_INTERNAL SCM scm_i_dbl2big (double d);
280 SCM_INTERNAL SCM scm_i_dbl2num (double d);
281 SCM_API /* FIXME: not internal */ double scm_i_big2dbl (SCM b);
282 SCM_API /* FIXME: not internal */ SCM scm_i_long2big (long n);
283 SCM_API /* FIXME: not internal */ SCM scm_i_ulong2big (unsigned long n);
284 SCM_API /* FIXME: not internal */ SCM scm_i_clonebig (SCM src_big, int same_sign_p);
285
286 /* ratio functions */
287 SCM_API SCM scm_rationalize (SCM x, SCM err);
288 SCM_API SCM scm_numerator (SCM z);
289 SCM_API SCM scm_denominator (SCM z);
290
291 /* fraction internal functions */
292 SCM_INTERNAL double scm_i_fraction2double (SCM z);
293 SCM_INTERNAL SCM scm_i_fraction_equalp (SCM x, SCM y);
294 SCM_INTERNAL int scm_i_print_fraction (SCM sexp, SCM port, scm_print_state *pstate);
295
296 /* general internal functions */
297 SCM_INTERNAL void scm_i_print_double (double val, SCM port);
298 SCM_INTERNAL void scm_i_print_complex (double real, double imag, SCM port);
299
300 /* conversion functions for integers */
301
302 SCM_API int scm_is_integer (SCM val);
303 SCM_API int scm_is_signed_integer (SCM val,
304 scm_t_intmax min, scm_t_intmax max);
305 SCM_API int scm_is_unsigned_integer (SCM val,
306 scm_t_uintmax min, scm_t_uintmax max);
307
308 SCM_API SCM scm_from_signed_integer (scm_t_intmax val);
309 SCM_API SCM scm_from_unsigned_integer (scm_t_uintmax val);
310
311 SCM_API scm_t_intmax scm_to_signed_integer (SCM val,
312 scm_t_intmax min,
313 scm_t_intmax max);
314 SCM_API scm_t_uintmax scm_to_unsigned_integer (SCM val,
315 scm_t_uintmax min,
316 scm_t_uintmax max);
317
318 SCM_API scm_t_int8 scm_to_int8 (SCM x);
319 SCM_API SCM scm_from_int8 (scm_t_int8 x);
320
321 SCM_API scm_t_uint8 scm_to_uint8 (SCM x);
322 SCM_API SCM scm_from_uint8 (scm_t_uint8 x);
323
324 SCM_API scm_t_int16 scm_to_int16 (SCM x);
325 SCM_API SCM scm_from_int16 (scm_t_int16 x);
326
327 SCM_API scm_t_uint16 scm_to_uint16 (SCM x);
328 SCM_API SCM scm_from_uint16 (scm_t_uint16 x);
329
330 SCM_API scm_t_int32 scm_to_int32 (SCM x);
331 SCM_API SCM scm_from_int32 (scm_t_int32 x);
332
333 SCM_API scm_t_uint32 scm_to_uint32 (SCM x);
334 SCM_API SCM scm_from_uint32 (scm_t_uint32 x);
335
336 SCM_API scm_t_wchar scm_to_wchar (SCM x);
337 SCM_API SCM scm_from_wchar (scm_t_wchar x);
338
339 SCM_API scm_t_int64 scm_to_int64 (SCM x);
340 SCM_API SCM scm_from_int64 (scm_t_int64 x);
341
342 SCM_API scm_t_uint64 scm_to_uint64 (SCM x);
343 SCM_API SCM scm_from_uint64 (scm_t_uint64 x);
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 */