* conv-integer.i.c, conv-uinteger.i.c: New files, used to generate
[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 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
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
12 *
13 * This library 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 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 */
22
23 \f
24
25 #include "libguile/__scm.h"
26 #include "libguile/print.h"
27
28 #if SCM_HAVE_FLOATINGPOINT_H
29 # include <floatingpoint.h>
30 #endif
31
32 #if SCM_HAVE_IEEEFP_H
33 # include <ieeefp.h>
34 #endif
35
36 #if SCM_HAVE_NAN_H
37 # if defined (SCO)
38 # define _IEEE 1
39 # endif
40 # include <nan.h>
41 # if defined (SCO)
42 # undef _IEEE
43 # endif
44 #endif /* SCM_HAVE_NAN_H */
45
46 \f
47
48 /* Immediate Numbers, also known as fixnums
49 *
50 * Inums are exact integer data that fits within an SCM word. */
51
52 /* SCM_T_SIGNED_MAX is (- (expt 2 n) 1),
53 * SCM_MOST_POSITIVE_FIXNUM should be (- (expt 2 (- n 2)) 1)
54 * which is the same as (/ (- (expt 2 n) 4) 4)
55 */
56
57 #define SCM_I_FIXNUM_BIT (SCM_LONG_BIT - 2)
58 #define SCM_MOST_POSITIVE_FIXNUM ((SCM_T_SIGNED_BITS_MAX-3)/4)
59 #define SCM_MOST_NEGATIVE_FIXNUM (-SCM_MOST_POSITIVE_FIXNUM-1)
60
61 /* SCM_SRS is signed right shift */
62 #if (-1 == (((-1) << 2) + 2) >> 2)
63 # define SCM_SRS(x, y) ((x) >> (y))
64 #else
65 # define SCM_SRS(x, y) ((x) < 0 ? ~((~(x)) >> (y)) : ((x) >> (y)))
66 #endif /* (-1 == (((-1) << 2) + 2) >> 2) */
67
68
69 #define SCM_I_INUMP(x) (2 & SCM_UNPACK (x))
70 #define SCM_I_NINUMP(x) (!SCM_I_INUMP (x))
71 #define SCM_I_MAKINUM(x) \
72 (SCM_PACK ((((scm_t_signed_bits) (x)) << 2) + scm_tc2_int))
73 #define SCM_I_INUM(x) (SCM_SRS ((scm_t_signed_bits) SCM_UNPACK (x), 2))
74
75 /* SCM_FIXABLE is true if its long argument can be encoded in an SCM_INUM. */
76 #define SCM_POSFIXABLE(n) ((n) <= SCM_MOST_POSITIVE_FIXNUM)
77 #define SCM_NEGFIXABLE(n) ((n) >= SCM_MOST_NEGATIVE_FIXNUM)
78 #define SCM_FIXABLE(n) (SCM_POSFIXABLE (n) && SCM_NEGFIXABLE (n))
79
80
81 /* A name for 0. */
82 #define SCM_INUM0 (SCM_I_MAKINUM (0))
83
84 /* SCM_MAXEXP is the maximum double precision exponent
85 * SCM_FLTMAX is less than or scm_equal the largest single precision float
86 */
87
88 #if SCM_HAVE_STDC_HEADERS
89 # ifndef GO32
90 # include <float.h>
91 # ifdef __MINGW32__
92 # define copysign _copysign
93 # define isnan _isnan
94 # define finite _finite
95 # endif /* __MINGW32__ */
96 # endif /* ndef GO32 */
97 #endif /* def STDC_HEADERS */
98
99 #ifdef DBL_MAX_10_EXP
100 # define SCM_MAXEXP DBL_MAX_10_EXP
101 #else
102 # define SCM_MAXEXP 308 /* IEEE doubles */
103 #endif /* def DBL_MAX_10_EXP */
104
105 #ifdef FLT_MAX
106 # define SCM_FLTMAX FLT_MAX
107 #else
108 # define SCM_FLTMAX 1e+23
109 #endif /* def FLT_MAX */
110
111
112 /* SCM_INTBUFLEN is the maximum number of characters neccessary for the
113 * printed or scm_string representation of an exact immediate.
114 */
115 #define SCM_INTBUFLEN (5 + SCM_LONG_BIT)
116
117 \f
118
119 /* Numbers
120 */
121
122
123 /* Note that scm_tc16_real and scm_tc16_complex are given tc16-codes that only
124 * differ in one bit: This way, checking if an object is an inexact number can
125 * be done quickly (using the TYP16S macro). */
126
127 /* Number subtype 1 to 3 (note the dependency on the predicates SCM_INEXACTP
128 * and SCM_NUMP) */
129 #define scm_tc16_big (scm_tc7_number + 1 * 256L)
130 #define scm_tc16_real (scm_tc7_number + 2 * 256L)
131 #define scm_tc16_complex (scm_tc7_number + 3 * 256L)
132 #define scm_tc16_fraction (scm_tc7_number + 4 * 256L)
133
134 #define SCM_INEXACTP(x) \
135 (!SCM_IMP (x) && (0xfeff & SCM_CELL_TYPE (x)) == scm_tc16_real)
136 #define SCM_REALP(x) (!SCM_IMP (x) && SCM_TYP16 (x) == scm_tc16_real)
137 #define SCM_COMPLEXP(x) (!SCM_IMP (x) && SCM_TYP16 (x) == scm_tc16_complex)
138
139 #define SCM_REAL_VALUE(x) (((scm_t_double *) SCM2PTR (x))->real)
140 #define SCM_COMPLEX_MEM(x) ((scm_t_complex *) SCM_CELL_WORD_1 (x))
141 #define SCM_COMPLEX_REAL(x) (SCM_COMPLEX_MEM (x)->real)
142 #define SCM_COMPLEX_IMAG(x) (SCM_COMPLEX_MEM (x)->imag)
143
144 /* Each bignum is just an mpz_t stored in a double cell starting at word 1. */
145 #define SCM_I_BIG_MPZ(x) (*((mpz_t *) (SCM_CELL_OBJECT_LOC((x),1))))
146 #define SCM_BIGP(x) (!SCM_IMP (x) && SCM_TYP16 (x) == scm_tc16_big)
147
148 #define SCM_NUMBERP(x) (SCM_I_INUMP(x) || SCM_NUMP(x))
149 #define SCM_NUMP(x) (!SCM_IMP(x) \
150 && (((0xfcff & SCM_CELL_TYPE (x)) == scm_tc7_number) \
151 || ((0xfbff & SCM_CELL_TYPE (x)) == scm_tc7_number)))
152 /* 0xfcff (#b1100) for 0 free, 1 big, 2 real, 3 complex, then 0xfbff (#b1011) for 4 fraction */
153
154 #define SCM_FRACTIONP(x) (!SCM_IMP (x) && SCM_TYP16 (x) == scm_tc16_fraction)
155 #define SCM_FRACTION_NUMERATOR(x) (SCM_CELL_OBJECT_1 (x))
156 #define SCM_FRACTION_DENOMINATOR(x) (SCM_CELL_OBJECT_2 (x))
157 #define SCM_FRACTION_SET_NUMERATOR(x, v) (SCM_SET_CELL_OBJECT_1 ((x), (v)))
158 #define SCM_FRACTION_SET_DENOMINATOR(x, v) (SCM_SET_CELL_OBJECT_2 ((x), (v)))
159
160 /* I think the left half word is free in the type, so I'll use bit 17 */
161 #define SCM_FRACTION_REDUCED_BIT 0x10000
162 #define SCM_FRACTION_REDUCED_SET(x) (SCM_SET_CELL_TYPE((x), (SCM_CELL_TYPE (x) | SCM_FRACTION_REDUCED_BIT)))
163 #define SCM_FRACTION_REDUCED_CLEAR(x) (SCM_SET_CELL_TYPE((x), (SCM_CELL_TYPE (x) & ~SCM_FRACTION_REDUCED_BIT)))
164 #define SCM_FRACTION_REDUCED(x) (0x10000 & SCM_CELL_TYPE (x))
165
166 \f
167
168 typedef struct scm_t_double
169 {
170 SCM type;
171 SCM pad;
172 double real;
173 } scm_t_double;
174
175 typedef struct scm_t_complex
176 {
177 double real;
178 double imag;
179 } scm_t_complex;
180
181 \f
182
183 SCM_API SCM scm_exact_p (SCM x);
184 SCM_API SCM scm_odd_p (SCM n);
185 SCM_API SCM scm_even_p (SCM n);
186 SCM_API SCM scm_inf_p (SCM n);
187 SCM_API SCM scm_nan_p (SCM n);
188 SCM_API SCM scm_inf (void);
189 SCM_API SCM scm_nan (void);
190 SCM_API SCM scm_abs (SCM x);
191 SCM_API SCM scm_quotient (SCM x, SCM y);
192 SCM_API SCM scm_remainder (SCM x, SCM y);
193 SCM_API SCM scm_modulo (SCM x, SCM y);
194 SCM_API SCM scm_gcd (SCM x, SCM y);
195 SCM_API SCM scm_lcm (SCM n1, SCM n2);
196 SCM_API SCM scm_logand (SCM n1, SCM n2);
197 SCM_API SCM scm_logior (SCM n1, SCM n2);
198 SCM_API SCM scm_logxor (SCM n1, SCM n2);
199 SCM_API SCM scm_logtest (SCM n1, SCM n2);
200 SCM_API SCM scm_logbit_p (SCM n1, SCM n2);
201 SCM_API SCM scm_lognot (SCM n);
202 SCM_API SCM scm_modulo_expt (SCM n, SCM k, SCM m);
203 SCM_API SCM scm_integer_expt (SCM z1, SCM z2);
204 SCM_API SCM scm_ash (SCM n, SCM cnt);
205 SCM_API SCM scm_bit_extract (SCM n, SCM start, SCM end);
206 SCM_API SCM scm_logcount (SCM n);
207 SCM_API SCM scm_integer_length (SCM n);
208
209 SCM_API size_t scm_iint2str (long num, int rad, char *p);
210 SCM_API SCM scm_number_to_string (SCM x, SCM radix);
211 SCM_API int scm_print_real (SCM sexp, SCM port, scm_print_state *pstate);
212 SCM_API int scm_print_complex (SCM sexp, SCM port, scm_print_state *pstate);
213 SCM_API int scm_bigprint (SCM exp, SCM port, scm_print_state *pstate);
214 SCM_API SCM scm_i_mem2number (const char *mem, size_t len, unsigned int radix);
215 SCM_API SCM scm_string_to_number (SCM str, SCM radix);
216 SCM_API SCM scm_make_real (double x);
217 SCM_API SCM scm_make_complex (double x, double y);
218 SCM_API SCM scm_bigequal (SCM x, SCM y);
219 SCM_API SCM scm_real_equalp (SCM x, SCM y);
220 SCM_API SCM scm_complex_equalp (SCM x, SCM y);
221 SCM_API SCM scm_number_p (SCM x);
222 SCM_API SCM scm_real_p (SCM x);
223 SCM_API SCM scm_integer_p (SCM x);
224 SCM_API SCM scm_inexact_p (SCM x);
225 SCM_API SCM scm_num_eq_p (SCM x, SCM y);
226 SCM_API SCM scm_less_p (SCM x, SCM y);
227 SCM_API SCM scm_gr_p (SCM x, SCM y);
228 SCM_API SCM scm_leq_p (SCM x, SCM y);
229 SCM_API SCM scm_geq_p (SCM x, SCM y);
230 SCM_API SCM scm_zero_p (SCM z);
231 SCM_API SCM scm_positive_p (SCM x);
232 SCM_API SCM scm_negative_p (SCM x);
233 SCM_API SCM scm_max (SCM x, SCM y);
234 SCM_API SCM scm_min (SCM x, SCM y);
235 SCM_API SCM scm_sum (SCM x, SCM y);
236 SCM_API SCM scm_difference (SCM x, SCM y);
237 SCM_API SCM scm_product (SCM x, SCM y);
238 SCM_API double scm_num2dbl (SCM a, const char * why);
239 SCM_API SCM scm_divide (SCM x, SCM y);
240 SCM_API SCM scm_floor (SCM x);
241 SCM_API SCM scm_ceiling (SCM x);
242 SCM_API double scm_asinh (double x);
243 SCM_API double scm_acosh (double x);
244 SCM_API double scm_atanh (double x);
245 SCM_API double scm_truncate (double x);
246 SCM_API double scm_round (double x);
247 SCM_API SCM scm_truncate_number (SCM x);
248 SCM_API SCM scm_round_number (SCM x);
249 SCM_API SCM scm_sys_expt (SCM z1, SCM z2);
250 SCM_API SCM scm_sys_atan2 (SCM z1, SCM z2);
251 SCM_API SCM scm_make_rectangular (SCM z1, SCM z2);
252 SCM_API SCM scm_make_polar (SCM z1, SCM z2);
253 SCM_API SCM scm_real_part (SCM z);
254 SCM_API SCM scm_imag_part (SCM z);
255 SCM_API SCM scm_magnitude (SCM z);
256 SCM_API SCM scm_angle (SCM z);
257 SCM_API SCM scm_exact_to_inexact (SCM z);
258 SCM_API SCM scm_inexact_to_exact (SCM z);
259 SCM_API SCM scm_trunc (SCM x);
260
261 SCM_API SCM scm_short2num (short n);
262 SCM_API SCM scm_ushort2num (unsigned short n);
263 SCM_API SCM scm_int2num (int n);
264 SCM_API SCM scm_uint2num (unsigned int n);
265 SCM_API SCM scm_long2num (long n);
266 SCM_API SCM scm_ulong2num (unsigned long n);
267 SCM_API SCM scm_size2num (size_t n);
268 SCM_API SCM scm_ptrdiff2num (scm_t_ptrdiff n);
269 SCM_API short scm_num2short (SCM num, unsigned long int pos,
270 const char *s_caller);
271 SCM_API unsigned short scm_num2ushort (SCM num, unsigned long int pos,
272 const char *s_caller);
273 SCM_API int scm_num2int (SCM num, unsigned long int pos,
274 const char *s_caller);
275 SCM_API unsigned int scm_num2uint (SCM num, unsigned long int pos,
276 const char *s_caller);
277 SCM_API long scm_num2long (SCM num, unsigned long int pos,
278 const char *s_caller);
279 SCM_API unsigned long scm_num2ulong (SCM num, unsigned long int pos,
280 const char *s_caller);
281 SCM_API scm_t_ptrdiff scm_num2ptrdiff (SCM num, unsigned long int pos,
282 const char *s_caller);
283 SCM_API size_t scm_num2size (SCM num, unsigned long int pos,
284 const char *s_caller);
285 #if SCM_SIZEOF_LONG_LONG != 0
286 SCM_API SCM scm_long_long2num (long long sl);
287 SCM_API SCM scm_ulong_long2num (unsigned long long sl);
288 SCM_API long long scm_num2long_long (SCM num, unsigned long int pos,
289 const char *s_caller);
290 SCM_API unsigned long long scm_num2ulong_long (SCM num, unsigned long int pos,
291 const char *s_caller);
292 #endif
293
294 SCM_API SCM scm_float2num (float n);
295 SCM_API SCM scm_double2num (double n);
296 SCM_API float scm_num2float (SCM num, unsigned long int pos,
297 const char *s_caller);
298 SCM_API double scm_num2double (SCM num, unsigned long int pos,
299 const char *s_caller);
300
301
302 /* bignum internal functions */
303 SCM_API SCM scm_i_mkbig (void);
304 SCM_API SCM scm_i_normbig (SCM x);
305 SCM_API int scm_i_bigcmp (SCM a, SCM b);
306 SCM_API SCM scm_i_dbl2big (double d);
307 SCM_API SCM scm_i_dbl2num (double d);
308 SCM_API double scm_i_big2dbl (SCM b);
309 SCM_API SCM scm_i_short2big (short n);
310 SCM_API SCM scm_i_ushort2big (unsigned short n);
311 SCM_API SCM scm_i_int2big (int n);
312 SCM_API SCM scm_i_uint2big (unsigned int n);
313 SCM_API SCM scm_i_long2big (long n);
314 SCM_API SCM scm_i_ulong2big (unsigned long n);
315 SCM_API SCM scm_i_size2big (size_t n);
316 SCM_API SCM scm_i_ptrdiff2big (scm_t_ptrdiff n);
317
318 #if SCM_SIZEOF_LONG_LONG != 0
319 SCM_API SCM scm_i_long_long2big (long long n);
320 SCM_API SCM scm_i_ulong_long2big (unsigned long long n);
321 #endif
322
323
324 /* ratio functions */
325 SCM_API SCM scm_make_ratio (SCM num, SCM den);
326 SCM_API SCM scm_rationalize (SCM x, SCM err);
327 SCM_API SCM scm_numerator (SCM z);
328 SCM_API SCM scm_denominator (SCM z);
329 SCM_API SCM scm_rational_p (SCM z);
330
331 /* fraction internal functions */
332 SCM_API double scm_i_fraction2double (SCM z);
333 SCM_API SCM scm_i_fraction_equalp (SCM x, SCM y);
334 SCM_API int scm_i_print_fraction (SCM sexp, SCM port, scm_print_state *pstate);
335
336
337 #ifdef GUILE_DEBUG
338 SCM_API SCM scm_sys_check_number_conversions (void);
339 #endif
340
341 /* conversion functions */
342
343 SCM_API int scm_is_integer (SCM val);
344 SCM_API int scm_is_signed_integer (SCM val,
345 scm_t_intmax min, scm_t_intmax max);
346 SCM_API int scm_is_unsigned_integer (SCM val,
347 scm_t_uintmax min, scm_t_uintmax max);
348
349 SCM_API SCM scm_from_signed_integer (scm_t_intmax val);
350 SCM_API SCM scm_from_unsigned_integer (scm_t_uintmax val);
351
352 SCM_API scm_t_intmax scm_to_signed_integer (SCM val,
353 scm_t_intmax min,
354 scm_t_intmax max);
355 SCM_API scm_t_uintmax scm_to_unsigned_integer (SCM val,
356 scm_t_uintmax min,
357 scm_t_uintmax max);
358
359 SCM_API scm_t_int8 scm_to_int8 (SCM x);
360 SCM_API SCM scm_from_int8 (scm_t_int8 x);
361
362 SCM_API scm_t_uint8 scm_to_uint8 (SCM x);
363 SCM_API SCM scm_from_uint8 (scm_t_uint8 x);
364
365 SCM_API scm_t_int16 scm_to_int16 (SCM x);
366 SCM_API SCM scm_from_int16 (scm_t_int16 x);
367
368 SCM_API scm_t_uint16 scm_to_uint16 (SCM x);
369 SCM_API SCM scm_from_uint16 (scm_t_uint16 x);
370
371 SCM_API scm_t_int32 scm_to_int32 (SCM x);
372 SCM_API SCM scm_from_int32 (scm_t_int32 x);
373
374 SCM_API scm_t_uint32 scm_to_uint32 (SCM x);
375 SCM_API SCM scm_from_uint32 (scm_t_uint32 x);
376
377 #if SCM_HAVE_T_INT64
378
379 SCM_API scm_t_int64 scm_to_int64 (SCM x);
380 SCM_API SCM scm_from_int64 (scm_t_int64 x);
381
382 SCM_API scm_t_uint64 scm_to_uint64 (SCM x);
383 SCM_API SCM scm_from_uint64 (scm_t_uint64 x);
384
385 #endif
386
387 #define scm_to_schar(x) \
388 ((signed char)scm_to_signed_integer ((x), SCHAR_MIN, SCHAR_MAX))
389 #define scm_to_uchar(x) \
390 ((unsigned char)scm_to_unsigned_integer ((x), 0, UCHAR_MAX))
391 #if CHAR_MIN == 0
392 #define scm_to_char scm_to_uchar
393 #else
394 #define scm_to_char scm_to_schar
395 #endif
396
397 #define scm_to_short(x) \
398 ((short)scm_to_signed_integer ((x), SHRT_MIN, SHRT_MAX))
399 #define scm_to_ushort(x) \
400 ((unsigned short)scm_to_unsigned_integer ((x), 0, SHRT_MAX))
401
402 #define scm_to_int(x) \
403 ((int)scm_to_signed_integer ((x), INT_MIN, INT_MAX))
404 #define scm_to_uint(x) \
405 ((unsigned int)scm_to_unsigned_integer ((x), 0, UINT_MAX))
406
407 #define scm_to_long(x) \
408 ((long)scm_to_signed_integer ((x), LONG_MIN, LONG_MAX))
409 #define scm_to_ulong(x) \
410 ((unsigned long)scm_to_unsigned_integer ((x), 0, ULONG_MAX))
411
412 #define scm_to_ssize_t(x) \
413 ((ssize_t)scm_to_signed_integer ((x), SCM_I_SSIZE_MIN, SCM_I_SSIZE_MAX))
414 #define scm_to_size_t(x) \
415 ((unsigned long)scm_to_unsigned_integer ((x), 0, SCM_I_SIZE_MAX))
416
417 #if SCM_SIZEOF_LONG_LONG != 0
418 #define scm_to_long_long(x) \
419 ((long long)scm_to_signed_integer ((x), SCM_I_LLONG_MIN, SCM_I_LLONG_MAX))
420 #define scm_to_ulong_long(x) \
421 ((unsigned long long)scm_to_unsigned_integer ((x), 0, SCM_I_ULLONG_MAX))
422 #endif
423
424 #define scm_to_intmax(x) \
425 ((scm_t_intmax)scm_to_signed_integer ((x),SCM_T_INTMAX_MIN,SCM_T_INTMAX_MAX))
426 #define scm_to_uintmax(x) \
427 ((scm_t_uintmax)scm_to_unsigned_integer ((x), 0, SCM_T_UINTMAX_MAX))
428
429 #define scm_from_schar(x) scm_from_signed_integer ((signed char)(x))
430 #define scm_from_uchar(x) scm_from_unsigned_integer ((unsigned char)(x))
431 #if CHAR_MIN == 0
432 #define scm_from_char scm_from_uchar
433 #else
434 #define scm_from_char scm_from_schar
435 #endif
436
437 #define scm_from_short(x) scm_from_signed_integer ((short)(x))
438 #define scm_from_ushort(x) scm_from_unsigned_integer ((unsigned short)(x))
439
440 #define scm_from_int(x) scm_from_signed_integer ((int)(x))
441 #define scm_from_uint(x) scm_from_unsigned_integer ((unsigned int)(x))
442
443 #define scm_from_long(x) scm_from_signed_integer ((long)(x))
444 #define scm_from_ulong(x) scm_from_unsigned_integer ((unsigned long)(x))
445
446 #define scm_from_ssize_t(x) scm_from_signed_integer ((ssize_t)(x))
447 #define scm_from_size_t(x) scm_from_unsigned_integer ((size_t)(x))
448
449 #if SCM_SIZEOF_LONG_LONG != 0
450 #define scm_from_long_long(x) scm_from_signed_integer ((long long)(x))
451 #define scm_from_ulong_long(x) scm_from_unsigned_integer ((unsigned long long)(x))
452 #endif
453
454 #define scm_from_intmax(x) scm_from_signed_integer ((scm_t_intmax)(x))
455 #define scm_from_uintmax(x) scm_from_unsigned_integer ((scm_t_uintmax)(x))
456
457 SCM_API int scm_is_real (SCM val);
458 SCM_API double scm_to_double (SCM val);
459 SCM_API SCM scm_from_double (double val);
460
461 SCM_API void scm_init_numbers (void);
462
463 #endif /* SCM_NUMBERS_H */
464
465 /*
466 Local Variables:
467 c-file-style: "gnu"
468 End:
469 */