*** empty log message ***
[bpt/guile.git] / libguile / numbers.h
CommitLineData
0f2d19dd
JB
1/* classes: h_files */
2
3#ifndef NUMBERSH
4#define NUMBERSH
7a58e59f 5/* Copyright (C) 1995, 1996, 1998, 2000 Free Software Foundation, Inc.
0f2d19dd
JB
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2, or (at your option)
10 * any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this software; see the file COPYING. If not, write to
82892bed
JB
19 * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
20 * Boston, MA 02111-1307 USA
0f2d19dd
JB
21 *
22 * As a special exception, the Free Software Foundation gives permission
23 * for additional uses of the text contained in its release of GUILE.
24 *
25 * The exception is that, if you link the GUILE library with other files
26 * to produce an executable, this does not by itself cause the
27 * resulting executable to be covered by the GNU General Public License.
28 * Your use of that executable is in no way restricted on account of
29 * linking the GUILE library code into it.
30 *
31 * This exception does not however invalidate any other reasons why
32 * the executable file might be covered by the GNU General Public License.
33 *
34 * This exception applies only to the code released by the
35 * Free Software Foundation under the name GUILE. If you copy
36 * code from other Free Software Foundation releases into a copy of
37 * GUILE, as the General Public License permits, the exception does
38 * not apply to the code that you add in this way. To avoid misleading
39 * anyone as to the status of such modified files, you must delete
40 * this exception notice from them.
41 *
42 * If you write modifications of your own for GUILE, it is your choice
43 * whether to permit this exception to apply to your modifications.
82892bed 44 * If you do not wish that, delete this exception notice. */
d3a6bc94
GB
45
46/* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
47 gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
0f2d19dd
JB
48\f
49
b4309c3c 50#include "libguile/__scm.h"
0f2d19dd 51
34f74fe1
MD
52#include "libguile/print.h"
53
0f2d19dd
JB
54\f
55
56
57/* Immediate Numbers
58 *
59 * Inums are exact integer data that fits within an SCM word.
60 *
61 * SCM_INUMP applies only to values known to be Scheme objects.
62 * In particular, SCM_INUMP (SCM_CAR (x)) is valid only if x is known
63 * to be a SCM_CONSP. If x is only known to be a SCM_NIMP,
64 * SCM_INUMP (SCM_CAR (x)) can give wrong answers.
65 */
66
67#define SCM_INUMP(x) (2 & (int)(x))
68#define SCM_NINUMP(x) (!SCM_INUMP(x))
69
70#ifdef __TURBOC__
71/* shifts of more than one are done by a library call, single shifts are
72 * performed in registers
73 */
f1267706 74# define SCM_MAKINUM(x) ((SCM) (((SCM_UNPACK(x)<<1)<<1)+2L))
0f2d19dd 75#else
f1267706 76# define SCM_MAKINUM(x) ((SCM)((SCM_UNPACK(x)<<2)+2L))
0f2d19dd
JB
77#endif /* def __TURBOC__ */
78
79
80/* SCM_SRS is signed right shift */
c209c88e 81/* SCM_INUM makes a C int from an SCM immediate number. */
0f2d19dd
JB
82/* Turbo C++ v1.0 has a bug with right shifts of signed longs!
83 * It is believed to be fixed in Turbo C++ v1.01
84 */
85#if (-1==(((-1)<<2)+2)>>2) && (__TURBOC__ != 0x295)
7a58e59f 86# define SCM_SRS(x, y) ((x) >> y)
0f2d19dd 87# ifdef __TURBOC__
f1267706 88# define SCM_INUM(x) ((SCM_UNPACK (x) >>1) >>1)
0f2d19dd 89# else
f1267706 90# define SCM_INUM(x) SCM_SRS (SCM_UNPACK (x), 2)
0f2d19dd
JB
91# endif /* def __TURBOC__ */
92#else
7a58e59f 93# define SCM_SRS(x, y)\
f1267706
MD
94 ((SCM_UNPACK (x) < 0) ? ~( (~SCM_UNPACK (x)) >> y) : (SCM_UNPACK (x) >> y))
95# define SCM_INUM(x) SCM_SRS (SCM_UNPACK (x), 2)
0f2d19dd
JB
96#endif /* (-1==(((-1)<<2)+2)>>2) && (__TURBOC__ != 0x295) */
97
98
99/* A name for 0.
100 */
101#define SCM_INUM0 ((SCM) 2)
102
103
88eb6852
MD
104/* SCM_MAXEXP is the maximum double precision expontent
105 * SCM_FLTMAX is less than or scm_equal the largest single precision float
106 */
107
108#ifdef STDC_HEADERS
109#ifndef GO32
110#include <float.h>
111#endif /* ndef GO32 */
112#endif /* def STDC_HEADERS */
113#ifdef DBL_MAX_10_EXP
114#define SCM_MAXEXP DBL_MAX_10_EXP
115#else
116#define SCM_MAXEXP 308 /* IEEE doubles */
117#endif /* def DBL_MAX_10_EXP */
118#ifdef FLT_MAX
119#define SCM_FLTMAX FLT_MAX
120#else
121#define SCM_FLTMAX 1e+23
122#endif /* def FLT_MAX */
123
0f2d19dd
JB
124
125/* SCM_FIXABLE is non-0 if its long argument can be encoded in an SCM_INUM.
126 */
08b5b88c
MD
127#define SCM_POSFIXABLE(n) ((n) <= SCM_MOST_POSITIVE_FIXNUM)
128#define SCM_NEGFIXABLE(n) ((n) >= SCM_MOST_NEGATIVE_FIXNUM)
129#define SCM_UNEGFIXABLE(n) ((n) <= -SCM_MOST_NEGATIVE_FIXNUM)
130#define SCM_FIXABLE(n) (SCM_POSFIXABLE(n) && SCM_NEGFIXABLE(n))
0f2d19dd
JB
131
132/* SCM_INTBUFLEN is the maximum number of characters neccessary for the
133 * printed or scm_string representation of an exact immediate.
134 */
135
136#ifndef SCM_CHAR_BIT
137# define SCM_CHAR_BIT 8
138#endif /* ndef SCM_CHAR_BIT */
139#ifndef SCM_LONG_BIT
140# define SCM_LONG_BIT (SCM_CHAR_BIT*sizeof(long)/sizeof(char))
141#endif /* ndef SCM_LONG_BIT */
142#define SCM_INTBUFLEN (5+SCM_LONG_BIT)
143
144/* SCM_FLOBUFLEN is the maximum number of characters neccessary for the
145 * printed or scm_string representation of an inexact number.
146 */
147
148#define SCM_FLOBUFLEN (10+2*(sizeof(double)/sizeof(char)*SCM_CHAR_BIT*3+9)/10)
149
150
151\f
152
153/* Numbers
154 */
155
88eb6852
MD
156#define SCM_NEWREAL(z, x) \
157 do { \
158 SCM_NEWCELL2 (z); \
159 SCM_SETCAR (z, scm_tc16_real); \
160 SCM_REAL_VALUE (z) = (x); \
161 } while (0) \
162
163#define SCM_NEWCOMPLEX(z, x, y) \
164 do { \
165 double __SCM_complex_tmp = (y); \
166 if (__SCM_complex_tmp == 0.0) \
167 SCM_NEWREAL (z, x); \
168 else \
169 { \
170 SCM_NEWSMOB (z, scm_tc16_complex, \
171 scm_must_malloc (2L * sizeof (double), "complex")); \
172 SCM_COMPLEX_REAL (z) = (x); \
173 SCM_COMPLEX_IMAG (z) = __SCM_complex_tmp; \
174 } \
175 } while (0) \
176
177#define SCM_SLOPPY_INEXACTP(x) (SCM_TYP16S (x) == scm_tc16_real)
178#define SCM_SLOPPY_REALP(x) (SCM_TYP16 (x) == scm_tc16_real)
179#define SCM_SLOPPY_COMPLEXP(x) (SCM_TYP16 (x) == scm_tc16_complex)
180#define SCM_INEXACTP(x) (SCM_NIMP (x) && SCM_TYP16S (x) == scm_tc16_real)
181#define SCM_REALP(x) (SCM_NIMP (x) && SCM_TYP16 (x) == scm_tc16_real)
182#define SCM_COMPLEXP(x) (SCM_NIMP (x) && SCM_TYP16 (x) == scm_tc16_complex)
183
184#define SCM_INEXP(x) SCM_INEXACTP(x) /* Deprecated */
185#define SCM_CPLXP(x) SCM_COMPLEXP(x) /* Deprecated */
186
187#define SCM_REAL_VALUE(x) (((scm_double_t *) SCM2PTR (x))->real)
188#define SCM_COMPLEX_REAL(x) (((scm_complex_t *) SCM_CDR (x))->real)
189#define SCM_COMPLEX_IMAG(x) (((scm_complex_t *) SCM_CDR (x))->imag)
190#define SCM_REAL(x) \
191 (SCM_SLOPPY_REALP (x) \
192 ? SCM_REAL_VALUE (x) \
193 : SCM_COMPLEX_REAL (x)) \
194
195#define SCM_IMAG(x) \
196 (SCM_SLOPPY_REALP (x) \
197 ? 0.0 \
198 : SCM_COMPLEX_IMAG (x)) \
199
200#define SCM_REALPART(x) \
201 (SCM_SLOPPY_REALP (x) ? SCM_REAL_VALUE (x) : SCM_COMPLEX_REAL (x))
202
203#define scm_makdbl scm_make_complex /* Deprecated */
204#define SCM_SINGP(x) SCM_BOOL_F /* Deprecated */
0f2d19dd
JB
205
206/* Define SCM_BIGDIG to an integer type whose size is smaller than long if
207 * you want bignums. SCM_BIGRAD is one greater than the biggest SCM_BIGDIG.
208 *
209 * Define SCM_DIGSTOOBIG if the digits equivalent to a long won't fit in a long.
210 */
211#ifdef BIGNUMS
212# ifdef _UNICOS
213# define SCM_DIGSTOOBIG
214# if (1L << 31) <= SCM_USHRT_MAX
215# define SCM_BIGDIG unsigned short
216# else
217# define SCM_BIGDIG unsigned int
218# endif /* (1L << 31) <= USHRT_MAX */
219# define SCM_BITSPERDIG 32
220# else
221# define SCM_BIGDIG unsigned short
222# define SCM_BITSPERDIG (sizeof(SCM_BIGDIG)*SCM_CHAR_BIT)
223# endif /* def _UNICOS */
224
225# define SCM_BIGRAD (1L << SCM_BITSPERDIG)
226# define SCM_DIGSPERLONG ((scm_sizet)((sizeof(long)*SCM_CHAR_BIT+SCM_BITSPERDIG-1)/SCM_BITSPERDIG))
0f2d19dd 227# define SCM_BIGUP(x) ((unsigned long)(x) << SCM_BITSPERDIG)
08b5b88c 228# define SCM_LONGLONGBIGUP(x) ((ulong_long)(x) << SCM_BITSPERDIG)
0f2d19dd
JB
229# define SCM_BIGDN(x) ((x) >> SCM_BITSPERDIG)
230# define SCM_BIGLO(x) ((x) & (SCM_BIGRAD-1))
34f74fe1 231
0f2d19dd
JB
232#endif /* def BIGNUMS */
233
234#ifndef SCM_BIGDIG
235/* Definition is not really used but helps various function
236 * prototypes to compile with conditionalization.
237 */
238# define SCM_BIGDIG unsigned short
08b5b88c 239# define SCM_NO_BIGDIG
0f2d19dd
JB
240#endif /* ndef SCM_BIGDIG */
241
0f2d19dd 242#define SCM_NUMBERP(x) (SCM_INUMP(x) || (SCM_NIMP(x) && SCM_NUMP(x)))
9d0b279f
MD
243#ifdef SCM_BIGDIG
244#define SCM_NUM2DBL(x) (SCM_INUMP (x) \
245 ? (double) SCM_INUM (x) \
246 : (SCM_REALP (x) \
247 ? SCM_REALPART (x) \
248 : scm_big2dbl (x)))
249#else
250#define SCM_NUM2DBL(x) (SCM_INUMP (x) \
251 ? (double) SCM_INUM (x) \
252 : SCM_REALPART (x))
253#endif
88eb6852
MD
254#define SCM_NUMP(x) \
255 (SCM_NIMP(x) && (0xfcff & (int) SCM_CAR(x)) == scm_tc7_smob)
256#define SCM_BIGP(x) SCM_SMOB_PREDICATE (scm_tc16_big, x)
257#define SCM_BIGSIGNFLAG 0x10000L
258#define SCM_BIGSIZEFIELD 17
259#define SCM_BIGSIGN(x) (SCM_UNPACK_CAR (x) & SCM_BIGSIGNFLAG)
260#define SCM_BDIGITS(x) ((SCM_BIGDIG *) (SCM_CDR (x)))
261#define SCM_NUMDIGS(x) ((scm_sizet) (SCM_UNPACK_CAR (x) >> SCM_BIGSIZEFIELD))
262#define SCM_SETNUMDIGS(x, v, sign) \
263 SCM_SETCAR (x, \
264 scm_tc16_big \
265 | ((sign) ? SCM_BIGSIGNFLAG : 0) \
266 | (((v) + 0L) << 17)) \
267
0f2d19dd
JB
268\f
269
0f2d19dd
JB
270typedef struct scm_dblproc
271{
272 char *scm_string;
273 double (*cproc) ();
274} scm_dblproc;
275
88eb6852 276typedef struct scm_double_t
0f2d19dd
JB
277{
278 SCM type;
88eb6852
MD
279 SCM pad;
280 double real;
281} scm_double_t;
0f2d19dd 282
88eb6852 283typedef struct scm_complex_t
0f2d19dd 284{
88eb6852
MD
285 double real;
286 double imag;
287} scm_complex_t;
0f2d19dd
JB
288
289
290\f
0f2d19dd 291
7866a09b
GB
292extern SCM scm_exact_p (SCM x);
293extern SCM scm_odd_p (SCM n);
294extern SCM scm_even_p (SCM n);
295extern SCM scm_abs (SCM x);
296extern SCM scm_quotient (SCM x, SCM y);
297extern SCM scm_remainder (SCM x, SCM y);
298extern SCM scm_modulo (SCM x, SCM y);
299extern SCM scm_gcd (SCM x, SCM y);
300extern SCM scm_lcm (SCM n1, SCM n2);
301extern SCM scm_logand (SCM n1, SCM n2);
302extern SCM scm_logior (SCM n1, SCM n2);
303extern SCM scm_logxor (SCM n1, SCM n2);
304extern SCM scm_logtest (SCM n1, SCM n2);
305extern SCM scm_logbit_p (SCM n1, SCM n2);
306extern SCM scm_lognot (SCM n);
307extern SCM scm_integer_expt (SCM z1, SCM z2);
308extern SCM scm_ash (SCM n, SCM cnt);
309extern SCM scm_bit_extract (SCM n, SCM start, SCM end);
310extern SCM scm_logcount (SCM n);
311extern SCM scm_integer_length (SCM n);
312extern SCM scm_mkbig (scm_sizet nlen, int sign);
313extern SCM scm_big2inum (SCM b, scm_sizet l);
314extern SCM scm_adjbig (SCM b, scm_sizet nlen);
315extern SCM scm_normbig (SCM b);
316extern SCM scm_copybig (SCM b, int sign);
317extern SCM scm_long2big (long n);
318extern SCM scm_long_long2big (long_long n);
319extern SCM scm_2ulong2big (unsigned long * np);
320extern SCM scm_ulong2big (unsigned long n);
321extern int scm_bigcomp (SCM x, SCM y);
322extern long scm_pseudolong (long x);
323extern void scm_longdigs (long x, SCM_BIGDIG digs[]);
324extern SCM scm_addbig (SCM_BIGDIG *x, scm_sizet nx, int xsgn, SCM bigy, int sgny);
325extern SCM scm_mulbig (SCM_BIGDIG *x, scm_sizet nx, SCM_BIGDIG *y, scm_sizet ny, int sgn);
326extern unsigned int scm_divbigdig (SCM_BIGDIG *ds, scm_sizet h, SCM_BIGDIG div);
327extern SCM scm_divbigint (SCM x, long z, int sgn, int mode);
328extern SCM scm_divbigbig (SCM_BIGDIG *x, scm_sizet nx, SCM_BIGDIG *y, scm_sizet ny, int sgn, int modes);
329extern scm_sizet scm_iint2str (long num, int rad, char *p);
330extern SCM scm_number_to_string (SCM x, SCM radix);
88eb6852
MD
331extern int scm_print_real (SCM sexp, SCM port, scm_print_state *pstate);
332extern int scm_print_complex (SCM sexp, SCM port, scm_print_state *pstate);
7866a09b
GB
333extern int scm_bigprint (SCM exp, SCM port, scm_print_state *pstate);
334extern SCM scm_istr2int (char *str, long len, long radix);
335extern SCM scm_istr2flo (char *str, long len, long radix);
336extern SCM scm_istring2number (char *str, long len, long radix);
337extern SCM scm_string_to_number (SCM str, SCM radix);
88eb6852
MD
338extern SCM scm_make_real (double x);
339extern SCM scm_make_complex (double x, double y);
7866a09b
GB
340extern SCM scm_makdbl (double x, double y);
341extern SCM scm_bigequal (SCM x, SCM y);
88eb6852
MD
342extern SCM scm_real_equalp (SCM x, SCM y);
343extern SCM scm_complex_equalp (SCM x, SCM y);
7866a09b
GB
344extern SCM scm_number_p (SCM x);
345extern SCM scm_real_p (SCM x);
346extern SCM scm_integer_p (SCM x);
347extern SCM scm_inexact_p (SCM x);
348extern SCM scm_num_eq_p (SCM x, SCM y);
349extern SCM scm_less_p (SCM x, SCM y);
350extern SCM scm_gr_p (SCM x, SCM y);
351extern SCM scm_leq_p (SCM x, SCM y);
352extern SCM scm_geq_p (SCM x, SCM y);
353extern SCM scm_zero_p (SCM z);
354extern SCM scm_positive_p (SCM x);
355extern SCM scm_negative_p (SCM x);
356extern SCM scm_max (SCM x, SCM y);
357extern SCM scm_min (SCM x, SCM y);
358extern SCM scm_sum (SCM x, SCM y);
359extern SCM scm_difference (SCM x, SCM y);
360extern SCM scm_product (SCM x, SCM y);
361extern double scm_num2dbl (SCM a, const char * why);
362extern SCM scm_divide (SCM x, SCM y);
363extern double scm_asinh (double x);
364extern double scm_acosh (double x);
365extern double scm_atanh (double x);
366extern double scm_truncate (double x);
367extern double scm_round (double x);
368extern double scm_exact_to_inexact (double z);
369extern SCM scm_sys_expt (SCM z1, SCM z2);
370extern SCM scm_sys_atan2 (SCM z1, SCM z2);
371extern SCM scm_make_rectangular (SCM z1, SCM z2);
372extern SCM scm_make_polar (SCM z1, SCM z2);
373extern SCM scm_real_part (SCM z);
374extern SCM scm_imag_part (SCM z);
375extern SCM scm_magnitude (SCM z);
376extern SCM scm_angle (SCM z);
377extern SCM scm_inexact_to_exact (SCM z);
378extern SCM scm_trunc (SCM x);
379extern SCM scm_dbl2big (double d);
380extern double scm_big2dbl (SCM b);
381extern SCM scm_long2num (long sl);
382extern SCM scm_long_long2num (long_long sl);
383extern SCM scm_ulong2num (unsigned long sl);
384extern long scm_num2long (SCM num, char *pos, const char *s_caller);
385extern long_long scm_num2long_long (SCM num, char *pos,
386 const char *s_caller);
387extern unsigned long scm_num2ulong (SCM num, char *pos,
388 const char *s_caller);
389extern void scm_init_numbers (void);
0f2d19dd
JB
390
391#endif /* NUMBERSH */