740dc80ffa5389cc01639b1af6fe776c04d03a14
6 /* Copyright (C) 1995,1996,1998,2000,2001,2002,2003,2004,2005, 2006, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
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.
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.
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
28 #include "libguile/__scm.h"
29 #include "libguile/print.h"
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 */
38 /* Immediate Numbers, also known as fixnums
40 * Inums are exact integer data that fits within an SCM word. */
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)
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)
51 /* SCM_SRS is signed right shift */
52 #if (-1 == (((-1) << 2) + 2) >> 2)
53 # define SCM_SRS(x, y) ((x) >> (y))
55 # define SCM_SRS(x, y) ((x) < 0 ? ~((~(x)) >> (y)) : ((x) >> (y)))
56 #endif /* (-1 == (((-1) << 2) + 2) >> 2) */
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))
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))
71 #define SCM_INUM0 (SCM_I_MAKINUM (0)) /* A name for 0 */
72 #define SCM_INUM1 (SCM_I_MAKINUM (1)) /* A name for 1 */
75 /* SCM_MAXEXP is the maximum double precision exponent
76 * SCM_FLTMAX is less than or scm_equal the largest single precision float
79 #if SCM_HAVE_STDC_HEADERS
83 # define copysign _copysign
84 # define finite _finite
85 # endif /* __MINGW32__ */
86 # endif /* ndef GO32 */
87 #endif /* def STDC_HEADERS */
90 # define SCM_MAXEXP DBL_MAX_10_EXP
92 # define SCM_MAXEXP 308 /* IEEE doubles */
93 #endif /* def DBL_MAX_10_EXP */
96 # define SCM_FLTMAX FLT_MAX
98 # define SCM_FLTMAX 1e+23
99 #endif /* def FLT_MAX */
102 /* SCM_INTBUFLEN is the maximum number of characters neccessary for
103 * the printed or scm_string representation of an scm_t_intmax in
104 * radix 2. The buffer passed to scm_iint2str and scm_iuint2str must
105 * be of this size, for example.
107 #define SCM_INTBUFLEN (5 + SCM_CHAR_BIT*sizeof(scm_t_intmax))
115 /* Note that scm_tc16_real and scm_tc16_complex are given tc16-codes that only
116 * differ in one bit: This way, checking if an object is an inexact number can
117 * be done quickly (using the TYP16S macro). */
119 /* Number subtype 1 to 3 (note the dependency on the predicates SCM_INEXACTP
121 #define scm_tc16_big (scm_tc7_number + 1 * 256L)
122 #define scm_tc16_real (scm_tc7_number + 2 * 256L)
123 #define scm_tc16_complex (scm_tc7_number + 3 * 256L)
124 #define scm_tc16_fraction (scm_tc7_number + 4 * 256L)
126 #define SCM_INEXACTP(x) \
127 (!SCM_IMP (x) && (0xfeff & SCM_CELL_TYPE (x)) == scm_tc16_real)
128 #define SCM_REALP(x) (!SCM_IMP (x) && SCM_TYP16 (x) == scm_tc16_real)
129 #define SCM_COMPLEXP(x) (!SCM_IMP (x) && SCM_TYP16 (x) == scm_tc16_complex)
131 #define SCM_REAL_VALUE(x) (((scm_t_double *) SCM2PTR (x))->real)
132 #define SCM_COMPLEX_REAL(x) (((scm_t_complex *) SCM2PTR (x))->real)
133 #define SCM_COMPLEX_IMAG(x) (((scm_t_complex *) SCM2PTR (x))->imag)
135 /* Each bignum is just an mpz_t stored in a double cell starting at word 1. */
136 #define SCM_I_BIG_MPZ(x) (*((mpz_t *) (SCM_CELL_OBJECT_LOC((x),1))))
137 #define SCM_BIGP(x) (!SCM_IMP (x) && SCM_TYP16 (x) == scm_tc16_big)
139 #define SCM_NUMBERP(x) (SCM_I_INUMP(x) || SCM_NUMP(x))
140 #define SCM_NUMP(x) (!SCM_IMP(x) \
141 && (((0xfcff & SCM_CELL_TYPE (x)) == scm_tc7_number) \
142 || ((0xfbff & SCM_CELL_TYPE (x)) == scm_tc7_number)))
143 /* 0xfcff (#b1100) for 0 free, 1 big, 2 real, 3 complex, then 0xfbff (#b1011) for 4 fraction */
145 #define SCM_FRACTIONP(x) (!SCM_IMP (x) && SCM_TYP16 (x) == scm_tc16_fraction)
146 #define SCM_FRACTION_NUMERATOR(x) (SCM_CELL_OBJECT_1 (x))
147 #define SCM_FRACTION_DENOMINATOR(x) (SCM_CELL_OBJECT_2 (x))
151 typedef struct scm_t_double
158 typedef struct scm_t_complex
169 SCM_API SCM
scm_exact_p (SCM x
);
170 SCM_API SCM
scm_odd_p (SCM n
);
171 SCM_API SCM
scm_even_p (SCM n
);
172 SCM_API SCM
scm_inf_p (SCM n
);
173 SCM_API SCM
scm_nan_p (SCM n
);
174 SCM_API SCM
scm_inf (void);
175 SCM_API SCM
scm_nan (void);
176 SCM_API SCM
scm_abs (SCM x
);
177 SCM_API SCM
scm_quotient (SCM x
, SCM y
);
178 SCM_API SCM
scm_remainder (SCM x
, SCM y
);
179 SCM_API SCM
scm_modulo (SCM x
, SCM y
);
180 SCM_API SCM
scm_gcd (SCM x
, SCM y
);
181 SCM_API SCM
scm_lcm (SCM n1
, SCM n2
);
182 SCM_API SCM
scm_logand (SCM n1
, SCM n2
);
183 SCM_API SCM
scm_logior (SCM n1
, SCM n2
);
184 SCM_API SCM
scm_logxor (SCM n1
, SCM n2
);
185 SCM_API SCM
scm_logtest (SCM n1
, SCM n2
);
186 SCM_API SCM
scm_logbit_p (SCM n1
, SCM n2
);
187 SCM_API SCM
scm_lognot (SCM n
);
188 SCM_API SCM
scm_modulo_expt (SCM n
, SCM k
, SCM m
);
189 SCM_API SCM
scm_integer_expt (SCM z1
, SCM z2
);
190 SCM_API SCM
scm_ash (SCM n
, SCM cnt
);
191 SCM_API SCM
scm_bit_extract (SCM n
, SCM start
, SCM end
);
192 SCM_API SCM
scm_logcount (SCM n
);
193 SCM_API SCM
scm_integer_length (SCM n
);
195 SCM_INTERNAL SCM
scm_i_gcd (SCM x
, SCM y
, SCM rest
);
196 SCM_INTERNAL SCM
scm_i_lcm (SCM x
, SCM y
, SCM rest
);
197 SCM_INTERNAL SCM
scm_i_logand (SCM x
, SCM y
, SCM rest
);
198 SCM_INTERNAL SCM
scm_i_logior (SCM x
, SCM y
, SCM rest
);
199 SCM_INTERNAL SCM
scm_i_logxor (SCM x
, SCM y
, SCM rest
);
201 SCM_API
size_t scm_iint2str (scm_t_intmax num
, int rad
, char *p
);
202 SCM_API
size_t scm_iuint2str (scm_t_uintmax num
, int rad
, char *p
);
203 SCM_API SCM
scm_number_to_string (SCM x
, SCM radix
);
204 SCM_API
int scm_print_real (SCM sexp
, SCM port
, scm_print_state
*pstate
);
205 SCM_API
int scm_print_complex (SCM sexp
, SCM port
, scm_print_state
*pstate
);
206 SCM_API
int scm_bigprint (SCM exp
, SCM port
, scm_print_state
*pstate
);
207 SCM_API SCM
scm_c_locale_stringn_to_number (const char *mem
, size_t len
,
209 SCM_INTERNAL SCM
scm_i_string_to_number (SCM str
, unsigned int radix
);
210 SCM_API SCM
scm_string_to_number (SCM str
, SCM radix
);
211 SCM_API SCM
scm_bigequal (SCM x
, SCM y
);
212 SCM_API SCM
scm_real_equalp (SCM x
, SCM y
);
213 SCM_API SCM
scm_complex_equalp (SCM x
, SCM y
);
214 SCM_API SCM
scm_number_p (SCM x
);
215 SCM_API SCM
scm_complex_p (SCM x
);
216 SCM_API SCM
scm_real_p (SCM x
);
217 SCM_API SCM
scm_rational_p (SCM z
);
218 SCM_API SCM
scm_integer_p (SCM x
);
219 SCM_API SCM
scm_inexact_p (SCM x
);
220 SCM_API SCM
scm_num_eq_p (SCM x
, SCM y
);
221 SCM_API SCM
scm_less_p (SCM x
, SCM y
);
222 SCM_API SCM
scm_gr_p (SCM x
, SCM y
);
223 SCM_API SCM
scm_leq_p (SCM x
, SCM y
);
224 SCM_API SCM
scm_geq_p (SCM x
, SCM y
);
225 SCM_API SCM
scm_zero_p (SCM z
);
226 SCM_API SCM
scm_positive_p (SCM x
);
227 SCM_API SCM
scm_negative_p (SCM x
);
228 SCM_API SCM
scm_max (SCM x
, SCM y
);
229 SCM_API SCM
scm_min (SCM x
, SCM y
);
230 SCM_API SCM
scm_sum (SCM x
, SCM y
);
231 SCM_API SCM
scm_oneplus (SCM x
);
232 SCM_API SCM
scm_difference (SCM x
, SCM y
);
233 SCM_API SCM
scm_oneminus (SCM x
);
234 SCM_API SCM
scm_product (SCM x
, SCM y
);
235 SCM_API SCM
scm_divide (SCM x
, SCM y
);
236 SCM_API SCM
scm_floor (SCM x
);
237 SCM_API SCM
scm_ceiling (SCM x
);
238 SCM_API
double scm_c_truncate (double x
);
239 SCM_API
double scm_c_round (double x
);
240 SCM_API SCM
scm_truncate_number (SCM x
);
241 SCM_API SCM
scm_round_number (SCM x
);
242 SCM_API SCM
scm_expt (SCM z1
, SCM z2
);
243 SCM_API SCM
scm_sin (SCM z
);
244 SCM_API SCM
scm_cos (SCM z
);
245 SCM_API SCM
scm_tan (SCM z
);
246 SCM_API SCM
scm_sinh (SCM z
);
247 SCM_API SCM
scm_cosh (SCM z
);
248 SCM_API SCM
scm_tanh (SCM z
);
249 SCM_API SCM
scm_asin (SCM z
);
250 SCM_API SCM
scm_acos (SCM z
);
251 SCM_API SCM
scm_atan (SCM x
, SCM y
);
252 SCM_API SCM
scm_sys_asinh (SCM z
);
253 SCM_API SCM
scm_sys_acosh (SCM z
);
254 SCM_API SCM
scm_sys_atanh (SCM z
);
255 SCM_API SCM
scm_make_rectangular (SCM z1
, SCM z2
);
256 SCM_API SCM
scm_make_polar (SCM z1
, SCM z2
);
257 SCM_API SCM
scm_real_part (SCM z
);
258 SCM_API SCM
scm_imag_part (SCM z
);
259 SCM_API SCM
scm_magnitude (SCM z
);
260 SCM_API SCM
scm_angle (SCM z
);
261 SCM_API SCM
scm_exact_to_inexact (SCM z
);
262 SCM_API SCM
scm_inexact_to_exact (SCM z
);
263 SCM_API SCM
scm_trunc (SCM x
);
264 SCM_API SCM
scm_log (SCM z
);
265 SCM_API SCM
scm_log10 (SCM z
);
266 SCM_API SCM
scm_exp (SCM z
);
267 SCM_API SCM
scm_sqrt (SCM z
);
269 SCM_INTERNAL SCM
scm_i_min (SCM x
, SCM y
, SCM rest
);
270 SCM_INTERNAL SCM
scm_i_max (SCM x
, SCM y
, SCM rest
);
271 SCM_INTERNAL SCM
scm_i_sum (SCM x
, SCM y
, SCM rest
);
272 SCM_INTERNAL SCM
scm_i_difference (SCM x
, SCM y
, SCM rest
);
273 SCM_INTERNAL SCM
scm_i_product (SCM x
, SCM y
, SCM rest
);
274 SCM_INTERNAL SCM
scm_i_divide (SCM x
, SCM y
, SCM rest
);
276 /* bignum internal functions */
277 SCM_INTERNAL SCM
scm_i_mkbig (void);
278 SCM_API
/* FIXME: not internal */ SCM
scm_i_normbig (SCM x
);
279 SCM_INTERNAL
int scm_i_bigcmp (SCM a
, SCM b
);
280 SCM_INTERNAL SCM
scm_i_dbl2big (double d
);
281 SCM_INTERNAL SCM
scm_i_dbl2num (double d
);
282 SCM_API
/* FIXME: not internal */ double scm_i_big2dbl (SCM b
);
283 SCM_API
/* FIXME: not internal */ SCM
scm_i_long2big (long n
);
284 SCM_API
/* FIXME: not internal */ SCM
scm_i_ulong2big (unsigned long n
);
285 SCM_API
/* FIXME: not internal */ SCM
scm_i_clonebig (SCM src_big
, int same_sign_p
);
287 /* ratio functions */
288 SCM_API SCM
scm_rationalize (SCM x
, SCM err
);
289 SCM_API SCM
scm_numerator (SCM z
);
290 SCM_API SCM
scm_denominator (SCM z
);
292 /* fraction internal functions */
293 SCM_INTERNAL
double scm_i_fraction2double (SCM z
);
294 SCM_INTERNAL SCM
scm_i_fraction_equalp (SCM x
, SCM y
);
295 SCM_INTERNAL
int scm_i_print_fraction (SCM sexp
, SCM port
, scm_print_state
*pstate
);
297 /* general internal functions */
298 SCM_INTERNAL
void scm_i_print_double (double val
, SCM port
);
299 SCM_INTERNAL
void scm_i_print_complex (double real
, double imag
, SCM port
);
301 /* conversion functions for integers */
303 SCM_API
int scm_is_integer (SCM val
);
304 SCM_API
int scm_is_signed_integer (SCM val
,
305 scm_t_intmax min
, scm_t_intmax max
);
306 SCM_API
int scm_is_unsigned_integer (SCM val
,
307 scm_t_uintmax min
, scm_t_uintmax max
);
309 SCM_API SCM
scm_from_signed_integer (scm_t_intmax val
);
310 SCM_API SCM
scm_from_unsigned_integer (scm_t_uintmax val
);
312 SCM_API scm_t_intmax
scm_to_signed_integer (SCM val
,
315 SCM_API scm_t_uintmax
scm_to_unsigned_integer (SCM val
,
319 SCM_API scm_t_int8
scm_to_int8 (SCM x
);
320 SCM_API SCM
scm_from_int8 (scm_t_int8 x
);
322 SCM_API scm_t_uint8
scm_to_uint8 (SCM x
);
323 SCM_API SCM
scm_from_uint8 (scm_t_uint8 x
);
325 SCM_API scm_t_int16
scm_to_int16 (SCM x
);
326 SCM_API SCM
scm_from_int16 (scm_t_int16 x
);
328 SCM_API scm_t_uint16
scm_to_uint16 (SCM x
);
329 SCM_API SCM
scm_from_uint16 (scm_t_uint16 x
);
331 SCM_API scm_t_int32
scm_to_int32 (SCM x
);
332 SCM_API SCM
scm_from_int32 (scm_t_int32 x
);
334 SCM_API scm_t_uint32
scm_to_uint32 (SCM x
);
335 SCM_API SCM
scm_from_uint32 (scm_t_uint32 x
);
337 SCM_API scm_t_wchar
scm_to_wchar (SCM x
);
338 SCM_API SCM
scm_from_wchar (scm_t_wchar x
);
340 SCM_API scm_t_int64
scm_to_int64 (SCM x
);
341 SCM_API SCM
scm_from_int64 (scm_t_int64 x
);
343 SCM_API scm_t_uint64
scm_to_uint64 (SCM x
);
344 SCM_API SCM
scm_from_uint64 (scm_t_uint64 x
);
346 SCM_API
void scm_to_mpz (SCM x
, mpz_t rop
);
347 SCM_API SCM
scm_from_mpz (mpz_t rop
);
350 /* The conversion functions for other types are aliased to the
351 appropriate ones from above. We pick the right one based on the
354 Not each and every possibility is covered by the code below, and
355 while it is trivial to complete the tests, it might be better to
356 just test for the 'sane' possibilities. When one of the tests
357 below fails, chances are good that some silent assumption somewhere
361 #if SCM_SIZEOF_CHAR == 1
362 #define scm_to_schar scm_to_int8
363 #define scm_from_schar scm_from_int8
364 #define scm_to_uchar scm_to_uint8
365 #define scm_from_uchar scm_from_uint8
367 #define scm_to_char scm_to_uint8
368 #define scm_from_char scm_from_uint8
370 #define scm_to_char scm_to_int8
371 #define scm_from_char scm_from_int8
374 #error sizeof(char) is not 1.
377 #if SCM_SIZEOF_SHORT == 1
378 #define scm_to_short scm_to_int8
379 #define scm_from_short scm_from_int8
380 #define scm_to_ushort scm_to_uint8
381 #define scm_from_ushort scm_from_uint8
383 #if SCM_SIZEOF_SHORT == 2
384 #define scm_to_short scm_to_int16
385 #define scm_from_short scm_from_int16
386 #define scm_to_ushort scm_to_uint16
387 #define scm_from_ushort scm_from_uint16
389 #if SCM_SIZEOF_SHORT == 4
390 #define scm_to_short scm_to_int32
391 #define scm_from_short scm_from_int32
392 #define scm_to_ushort scm_to_uint32
393 #define scm_from_ushort scm_from_uint32
395 #error sizeof(short) is not 1, 2, or 4.
400 #if SCM_SIZEOF_INT == 4
401 #define scm_to_int scm_to_int32
402 #define scm_from_int scm_from_int32
403 #define scm_to_uint scm_to_uint32
404 #define scm_from_uint scm_from_uint32
406 #if SCM_SIZEOF_INT == 8
407 #define scm_to_int scm_to_int64
408 #define scm_from_int scm_from_int64
409 #define scm_to_uint scm_to_uint64
410 #define scm_from_uint scm_from_uint64
412 #error sizeof(int) is not 4 or 8.
416 #if SCM_SIZEOF_LONG == 4
417 #define scm_to_long scm_to_int32
418 #define scm_from_long scm_from_int32
419 #define scm_to_ulong scm_to_uint32
420 #define scm_from_ulong scm_from_uint32
422 #if SCM_SIZEOF_LONG == 8
423 #define scm_to_long scm_to_int64
424 #define scm_from_long scm_from_int64
425 #define scm_to_ulong scm_to_uint64
426 #define scm_from_ulong scm_from_uint64
428 #error sizeof(long) is not 4 or 8.
432 #if SCM_SIZEOF_INTMAX == 4
433 #define scm_to_intmax scm_to_int32
434 #define scm_from_intmax scm_from_int32
435 #define scm_to_uintmax scm_to_uint32
436 #define scm_from_uintmax scm_from_uint32
438 #if SCM_SIZEOF_INTMAX == 8
439 #define scm_to_intmax scm_to_int64
440 #define scm_from_intmax scm_from_int64
441 #define scm_to_uintmax scm_to_uint64
442 #define scm_from_uintmax scm_from_uint64
444 #error sizeof(scm_t_intmax) is not 4 or 8.
448 #if SCM_SIZEOF_LONG_LONG == 0
450 #if SCM_SIZEOF_LONG_LONG == 8
451 #define scm_to_long_long scm_to_int64
452 #define scm_from_long_long scm_from_int64
453 #define scm_to_ulong_long scm_to_uint64
454 #define scm_from_ulong_long scm_from_uint64
456 #error sizeof(long long) is not 8.
460 #if SCM_SIZEOF_SIZE_T == 4
461 #define scm_to_ssize_t scm_to_int32
462 #define scm_from_ssize_t scm_from_int32
463 #define scm_to_size_t scm_to_uint32
464 #define scm_from_size_t scm_from_uint32
466 #if SCM_SIZEOF_SIZE_T == 8
467 #define scm_to_ssize_t scm_to_int64
468 #define scm_from_ssize_t scm_from_int64
469 #define scm_to_size_t scm_to_uint64
470 #define scm_from_size_t scm_from_uint64
472 #error sizeof(size_t) is not 4 or 8.
476 /* conversion functions for double */
478 SCM_API
int scm_is_real (SCM val
);
479 SCM_API
int scm_is_rational (SCM val
);
480 SCM_API
double scm_to_double (SCM val
);
481 SCM_API SCM
scm_from_double (double val
);
483 /* conversion functions for complex */
485 SCM_API
int scm_is_complex (SCM val
);
486 SCM_API SCM
scm_c_make_rectangular (double re
, double im
);
487 SCM_API SCM
scm_c_make_polar (double mag
, double ang
);
488 SCM_API
double scm_c_real_part (SCM z
);
489 SCM_API
double scm_c_imag_part (SCM z
);
490 SCM_API
double scm_c_magnitude (SCM z
);
491 SCM_API
double scm_c_angle (SCM z
);
493 SCM_API
int scm_is_number (SCM val
);
495 SCM_INTERNAL
void scm_init_numbers (void);
497 #endif /* SCM_NUMBERS_H */