HCoop / bpt / guile.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Changed license terms to the plain LGPL thru-out.
[bpt/guile.git] / libguile / numbers.h
CommitLineData
0f2d19dd
JB		 1/* classes: h_files */
2
3c9a524f
DH		 3#ifndef SCM_NUMBERS_H
4#define SCM_NUMBERS_H
dee01b01 5
e4b265d8 6/* Copyright (C) 1995,1996,1998,2000,2001 Free Software Foundation, Inc.
dee01b01 7 *
73be1d9e
MV		 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.
dee01b01 12 *
73be1d9e 13 * This library is distributed in the hope that it will be useful,
0f2d19dd 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
73be1d9e
MV		 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
dee01b01 17 *
73be1d9e
MV		 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 */
d3a6bc94 22
0f2d19dd
JB		 23\f
24
b4309c3c 25#include "libguile/__scm.h"
34f74fe1
MD		 26#include "libguile/print.h"
27
f0ad7455
RB		 28#if SCM_HAVE_FLOATINGPOINT_H
29# include <floatingpoint.h>
232898d9
MV		 30#endif
31
f0ad7455
RB		 32#if SCM_HAVE_IEEEFP_H
33# include <ieeefp.h>
232898d9
MV		 34#endif
35
f0ad7455
RB		 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 */
232898d9 45
d3e7e88d
RB		 46#include <gmp.h>
47
0f2d19dd
JB		 48\f
49
14282d0f 50/* Immediate Numbers, also known as fixnums
0f2d19dd 51 *
14282d0f 52 * Inums are exact integer data that fits within an SCM word. */
0f2d19dd 53
c0060c95
MV		 54/* SCM_T_SIGNED_MAX is (- (expt 2 n) 1),
55 * SCM_MOST_POSITIVE_FIXNUM should be (- (expt 2 (- n 2)) 1)
56 * which is the same as (/ (- (expt 2 n) 4) 4)
57 */
58
004c0902 59#define SCM_I_FIXNUM_BIT (SCM_LONG_BIT - 2)
c0060c95 60#define SCM_MOST_POSITIVE_FIXNUM ((SCM_T_SIGNED_BITS_MAX-3)/4)
004c0902 61#define SCM_MOST_NEGATIVE_FIXNUM (-SCM_MOST_POSITIVE_FIXNUM-1)
5c75b29f 62
56100716
DH		 63/* SCM_SRS is signed right shift */
64#if (-1 == (((-1) << 2) + 2) >> 2)
14282d0f 65# define SCM_SRS(x, y) ((x) >> (y))
0f2d19dd 66#else
14282d0f 67# define SCM_SRS(x, y) ((x) < 0 ? ~((~(x)) >> (y)) : ((x) >> (y)))
56100716 68#endif /* (-1 == (((-1) << 2) + 2) >> 2) */
0f2d19dd
JB		 69
70
56100716
DH		 71#define SCM_INUMP(x) (2 & SCM_UNPACK (x))
72#define SCM_NINUMP(x) (!SCM_INUMP (x))
14282d0f
DH		 73#define SCM_MAKINUM(x) (SCM_PACK ((((scm_t_signed_bits) (x)) << 2) + 2))
74#define SCM_INUM(x) (SCM_SRS ((scm_t_signed_bits) SCM_UNPACK (x), 2))
0f2d19dd
JB		 75
76
894a712b
DH		 77/* SCM_FIXABLE is true if its long argument can be encoded in an SCM_INUM. */
78#define SCM_POSFIXABLE(n) ((n) <= SCM_MOST_POSITIVE_FIXNUM)
79#define SCM_NEGFIXABLE(n) ((n) >= SCM_MOST_NEGATIVE_FIXNUM)
14282d0f 80#define SCM_FIXABLE(n) (SCM_POSFIXABLE (n) && SCM_NEGFIXABLE (n))
894a712b
DH		 81
82
56100716 83/* A name for 0. */
b82c6ce0 84#define SCM_INUM0 (SCM_MAKINUM (0))
0f2d19dd
JB		 85
86
c0060c95 87/* SCM_MAXEXP is the maximum double precision exponent
88eb6852
MD		 88 * SCM_FLTMAX is less than or scm_equal the largest single precision float
89 */
90
f0ad7455
RB		 91#if SCM_HAVE_STDC_HEADERS
92# ifndef GO32
93# include <float.h>
94# endif /* ndef GO32 */
88eb6852 95#endif /* def STDC_HEADERS */
f0ad7455 96
88eb6852 97#ifdef DBL_MAX_10_EXP
f0ad7455 98# define SCM_MAXEXP DBL_MAX_10_EXP
88eb6852 99#else
f0ad7455 100# define SCM_MAXEXP 308 /* IEEE doubles */
88eb6852 101#endif /* def DBL_MAX_10_EXP */
f0ad7455 102
88eb6852 103#ifdef FLT_MAX
f0ad7455 104# define SCM_FLTMAX FLT_MAX
88eb6852 105#else
f0ad7455 106# define SCM_FLTMAX 1e+23
88eb6852
MD		 107#endif /* def FLT_MAX */
108
0f2d19dd 109
0f2d19dd
JB		 110/* SCM_INTBUFLEN is the maximum number of characters neccessary for the
111 * printed or scm_string representation of an exact immediate.
112 */
c014a02e 113#define SCM_INTBUFLEN (5 + SCM_LONG_BIT)
0f2d19dd
JB		 114
115\f
116
117/* Numbers
118 */
119
88eb6852
MD		 120#define SCM_SLOPPY_INEXACTP(x) (SCM_TYP16S (x) == scm_tc16_real)
121#define SCM_SLOPPY_REALP(x) (SCM_TYP16 (x) == scm_tc16_real)
122#define SCM_SLOPPY_COMPLEXP(x) (SCM_TYP16 (x) == scm_tc16_complex)
3c9a524f
DH		 123#define SCM_INEXACTP(x) (!SCM_IMP (x) && SCM_TYP16S (x) == scm_tc16_real)
124#define SCM_REALP(x) (!SCM_IMP (x) && SCM_TYP16 (x) == scm_tc16_real)
125#define SCM_COMPLEXP(x) (!SCM_IMP (x) && SCM_TYP16 (x) == scm_tc16_complex)
88eb6852 126
92c2555f
MV		 127#define SCM_REAL_VALUE(x) (((scm_t_double *) SCM2PTR (x))->real)
128#define SCM_COMPLEX_MEM(x) ((scm_t_complex *) SCM_CELL_WORD_1 (x))
405aaef9
DH		 129#define SCM_COMPLEX_REAL(x) (SCM_COMPLEX_MEM (x)->real)
130#define SCM_COMPLEX_IMAG(x) (SCM_COMPLEX_MEM (x)->imag)
0f2d19dd 131
d3e7e88d
RB		 132/* Each bignum is just an mpz_t stored in a double cell starting at word 1. */
133#define SCM_I_BIG_MPZ(x) (*((mpz_t *) (&(SCM_CELL_WORD_1(x)))))
134#define SCM_BIGP(x) (!SCM_IMP (x) && SCM_TYP16 (x) == scm_tc16_big)
0f2d19dd 135
7a710745 136#define SCM_NUMBERP(x) (SCM_INUMP(x) || SCM_NUMP(x))
d3e7e88d
RB		 137#define SCM_NUMP(x) (!SCM_IMP(x) \
138 && (0xfcff & SCM_CELL_TYPE (x)) == scm_tc7_smob)
88eb6852 139
0f2d19dd
JB		 140\f
141
92c2555f 142typedef struct scm_t_double
0f2d19dd
JB		 143{
144 SCM type;
88eb6852
MD		 145 SCM pad;
146 double real;
92c2555f 147} scm_t_double;
0f2d19dd 148
92c2555f 149typedef struct scm_t_complex
0f2d19dd 150{
88eb6852
MD		 151 double real;
152 double imag;
92c2555f 153} scm_t_complex;
0f2d19dd 154
0f2d19dd 155\f
0f2d19dd 156
33b001fd
MV		 157SCM_API SCM scm_exact_p (SCM x);
158SCM_API SCM scm_odd_p (SCM n);
159SCM_API SCM scm_even_p (SCM n);
232898d9
MV		 160SCM_API SCM scm_inf_p (SCM n);
161SCM_API SCM scm_nan_p (SCM n);
162SCM_API SCM scm_inf (void);
163SCM_API SCM scm_nan (void);
33b001fd
MV		 164SCM_API SCM scm_abs (SCM x);
165SCM_API SCM scm_quotient (SCM x, SCM y);
166SCM_API SCM scm_remainder (SCM x, SCM y);
167SCM_API SCM scm_modulo (SCM x, SCM y);
168SCM_API SCM scm_gcd (SCM x, SCM y);
169SCM_API SCM scm_lcm (SCM n1, SCM n2);
170SCM_API SCM scm_logand (SCM n1, SCM n2);
171SCM_API SCM scm_logior (SCM n1, SCM n2);
172SCM_API SCM scm_logxor (SCM n1, SCM n2);
173SCM_API SCM scm_logtest (SCM n1, SCM n2);
174SCM_API SCM scm_logbit_p (SCM n1, SCM n2);
175SCM_API SCM scm_lognot (SCM n);
176SCM_API SCM scm_integer_expt (SCM z1, SCM z2);
177SCM_API SCM scm_ash (SCM n, SCM cnt);
178SCM_API SCM scm_bit_extract (SCM n, SCM start, SCM end);
179SCM_API SCM scm_logcount (SCM n);
180SCM_API SCM scm_integer_length (SCM n);
1be6b49c 181
33b001fd
MV		 182SCM_API size_t scm_iint2str (long num, int rad, char *p);
183SCM_API SCM scm_number_to_string (SCM x, SCM radix);
184SCM_API int scm_print_real (SCM sexp, SCM port, scm_print_state *pstate);
185SCM_API int scm_print_complex (SCM sexp, SCM port, scm_print_state *pstate);
186SCM_API int scm_bigprint (SCM exp, SCM port, scm_print_state *pstate);
187SCM_API SCM scm_i_mem2number (const char *mem, size_t len, unsigned int radix);
188SCM_API SCM scm_string_to_number (SCM str, SCM radix);
189SCM_API SCM scm_make_real (double x);
190SCM_API SCM scm_make_complex (double x, double y);
191SCM_API SCM scm_bigequal (SCM x, SCM y);
192SCM_API SCM scm_real_equalp (SCM x, SCM y);
193SCM_API SCM scm_complex_equalp (SCM x, SCM y);
194SCM_API SCM scm_number_p (SCM x);
195SCM_API SCM scm_real_p (SCM x);
196SCM_API SCM scm_integer_p (SCM x);
197SCM_API SCM scm_inexact_p (SCM x);
198SCM_API SCM scm_num_eq_p (SCM x, SCM y);
199SCM_API SCM scm_less_p (SCM x, SCM y);
200SCM_API SCM scm_gr_p (SCM x, SCM y);
201SCM_API SCM scm_leq_p (SCM x, SCM y);
202SCM_API SCM scm_geq_p (SCM x, SCM y);
203SCM_API SCM scm_zero_p (SCM z);
204SCM_API SCM scm_positive_p (SCM x);
205SCM_API SCM scm_negative_p (SCM x);
206SCM_API SCM scm_max (SCM x, SCM y);
207SCM_API SCM scm_min (SCM x, SCM y);
208SCM_API SCM scm_sum (SCM x, SCM y);
209SCM_API SCM scm_difference (SCM x, SCM y);
210SCM_API SCM scm_product (SCM x, SCM y);
211SCM_API double scm_num2dbl (SCM a, const char * why);
212SCM_API SCM scm_divide (SCM x, SCM y);
213SCM_API double scm_asinh (double x);
214SCM_API double scm_acosh (double x);
215SCM_API double scm_atanh (double x);
216SCM_API double scm_truncate (double x);
217SCM_API double scm_round (double x);
218SCM_API SCM scm_sys_expt (SCM z1, SCM z2);
219SCM_API SCM scm_sys_atan2 (SCM z1, SCM z2);
220SCM_API SCM scm_make_rectangular (SCM z1, SCM z2);
221SCM_API SCM scm_make_polar (SCM z1, SCM z2);
222SCM_API SCM scm_real_part (SCM z);
223SCM_API SCM scm_imag_part (SCM z);
224SCM_API SCM scm_magnitude (SCM z);
225SCM_API SCM scm_angle (SCM z);
226SCM_API SCM scm_exact_to_inexact (SCM z);
227SCM_API SCM scm_inexact_to_exact (SCM z);
228SCM_API SCM scm_trunc (SCM x);
33b001fd
MV		 229
230SCM_API SCM scm_short2num (short n);
231SCM_API SCM scm_ushort2num (unsigned short n);
232SCM_API SCM scm_int2num (int n);
233SCM_API SCM scm_uint2num (unsigned int n);
234SCM_API SCM scm_long2num (long n);
235SCM_API SCM scm_ulong2num (unsigned long n);
236SCM_API SCM scm_size2num (size_t n);
22185d5f 237SCM_API SCM scm_ptrdiff2num (scm_t_ptrdiff n);
33b001fd
MV		 238SCM_API short scm_num2short (SCM num, unsigned long int pos,
239 const char *s_caller);
240SCM_API unsigned short scm_num2ushort (SCM num, unsigned long int pos,
241 const char *s_caller);
242SCM_API int scm_num2int (SCM num, unsigned long int pos,
243 const char *s_caller);
244SCM_API unsigned int scm_num2uint (SCM num, unsigned long int pos,
245 const char *s_caller);
246SCM_API long scm_num2long (SCM num, unsigned long int pos,
247 const char *s_caller);
248SCM_API unsigned long scm_num2ulong (SCM num, unsigned long int pos,
249 const char *s_caller);
22185d5f
RB		 250SCM_API scm_t_ptrdiff scm_num2ptrdiff (SCM num, unsigned long int pos,
251 const char *s_caller);
33b001fd
MV		 252SCM_API size_t scm_num2size (SCM num, unsigned long int pos,
253 const char *s_caller);
22185d5f 254#if SCM_SIZEOF_LONG_LONG != 0
33b001fd
MV		 255SCM_API SCM scm_long_long2num (long long sl);
256SCM_API SCM scm_ulong_long2num (unsigned long long sl);
257SCM_API long long scm_num2long_long (SCM num, unsigned long int pos,
258 const char *s_caller);
259SCM_API unsigned long long scm_num2ulong_long (SCM num, unsigned long int pos,
260 const char *s_caller);
9ea8cdcb 261#endif
1be6b49c 262
33b001fd
MV		 263SCM_API SCM scm_float2num (float n);
264SCM_API SCM scm_double2num (double n);
265SCM_API float scm_num2float (SCM num, unsigned long int pos,
266 const char *s_caller);
267SCM_API double scm_num2double (SCM num, unsigned long int pos,
268 const char *s_caller);
581ded70 269
d3e7e88d
RB		 270
271/* bignum internal functions */
272SCM_API SCM scm_i_mkbig (void);
273SCM_API SCM scm_i_normbig (SCM x);
274SCM_API int scm_i_bigcmp (SCM a, SCM b);
275SCM_API SCM scm_i_dbl2big (double d);
276SCM_API double scm_i_big2dbl (SCM b);
277SCM_API SCM scm_i_short2big (short n);
278SCM_API SCM scm_i_ushort2big (unsigned short n);
279SCM_API SCM scm_i_int2big (int n);
280SCM_API SCM scm_i_uint2big (unsigned int n);
281SCM_API SCM scm_i_long2big (long n);
282SCM_API SCM scm_i_ulong2big (unsigned long n);
283SCM_API SCM scm_i_size2big (size_t n);
284SCM_API SCM scm_i_ptrdiff2big (scm_t_ptrdiff n);
285
286#if SCM_SIZEOF_LONG_LONG != 0
287SCM_API SCM scm_i_long_long2big (long long n);
288SCM_API SCM scm_i_ulong_long2big (unsigned long long n);
289#endif
290
291
292
b4e15479
SJ		 293#ifdef GUILE_DEBUG
294SCM_API SCM scm_sys_check_number_conversions (void);
295#endif
296
33b001fd 297SCM_API void scm_init_numbers (void);
0f2d19dd 298
3c9a524f 299#endif /* SCM_NUMBERS_H */
89e00824
ML		 300
301/*
302 Local Variables:
303 c-file-style: "gnu"
304 End:
305*/
Unnamed repository; edit this file 'description' to name the repository.