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 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_INUMP(x)    (2 & SCM_UNPACK (x))
  70 #define SCM_NINUMP(x)   (!SCM_INUMP (x))
  71 #define SCM_MAKINUM(x)  (SCM_PACK ((((scm_t_signed_bits) (x)) << 2) + 2))
  72 #define SCM_INUM(x)     (SCM_SRS ((scm_t_signed_bits) SCM_UNPACK (x), 2))
  73
  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_MAKINUM (0))
  83
  84
  85 /* SCM_MAXEXP is the maximum double precision exponent
  86  * SCM_FLTMAX is less than or scm_equal the largest single precision float
  87  */
  88
  89 #if SCM_HAVE_STDC_HEADERS
  90 # ifndef GO32
  91 #   include <float.h>
  92 # endif /* ndef GO32 */
  93 #endif /* def STDC_HEADERS */
  94
  95 #ifdef DBL_MAX_10_EXP
  96 # define SCM_MAXEXP DBL_MAX_10_EXP
  97 #else
  98 # define SCM_MAXEXP 308         /* IEEE doubles */
  99 #endif /* def DBL_MAX_10_EXP */
 100
 101 #ifdef FLT_MAX
 102 # define SCM_FLTMAX FLT_MAX
 103 #else
 104 # define SCM_FLTMAX 1e+23
 105 #endif /* def FLT_MAX */
 106
 107
 108 /* SCM_INTBUFLEN is the maximum number of characters neccessary for the
 109  * printed or scm_string representation of an exact immediate.
 110  */
 111 #define SCM_INTBUFLEN (5 + SCM_LONG_BIT)
 112
 113 \f
 114
 115 /* Numbers
 116  */
 117
 118 #define SCM_SLOPPY_INEXACTP(x) (SCM_TYP16S (x) == scm_tc16_real)
 119 #define SCM_SLOPPY_REALP(x) (SCM_TYP16 (x) == scm_tc16_real)
 120 #define SCM_SLOPPY_COMPLEXP(x) (SCM_TYP16 (x) == scm_tc16_complex)
 121 #define SCM_INEXACTP(x) (!SCM_IMP (x) && SCM_TYP16S (x) == scm_tc16_real)
 122 #define SCM_REALP(x) (!SCM_IMP (x) && SCM_TYP16 (x) == scm_tc16_real)
 123 #define SCM_COMPLEXP(x) (!SCM_IMP (x) && SCM_TYP16 (x) == scm_tc16_complex)
 124
 125 #define SCM_REAL_VALUE(x) (((scm_t_double *) SCM2PTR (x))->real)
 126 #define SCM_COMPLEX_MEM(x) ((scm_t_complex *) SCM_CELL_WORD_1 (x))
 127 #define SCM_COMPLEX_REAL(x) (SCM_COMPLEX_MEM (x)->real)
 128 #define SCM_COMPLEX_IMAG(x) (SCM_COMPLEX_MEM (x)->imag)
 129
 130 /* Each bignum is just an mpz_t stored in a double cell starting at word 1. */
 131 #define SCM_I_BIG_MPZ(x) (*((mpz_t *) (&(SCM_CELL_WORD_1(x)))))
 132 #define SCM_BIGP(x) (!SCM_IMP (x) && SCM_TYP16 (x) == scm_tc16_big)
 133
 134 #define SCM_NUMBERP(x) (SCM_INUMP(x) || SCM_NUMP(x))
 135 #define SCM_NUMP(x) (!SCM_IMP(x) \
 136   && (0xfcff & SCM_CELL_TYPE (x)) == scm_tc7_smob)
 137
 138 \f
 139
 140 typedef struct scm_t_double
 141 {
 142   SCM type;
 143   SCM pad;
 144   double real;
 145 } scm_t_double;
 146
 147 typedef struct scm_t_complex
 148 {
 149   double real;
 150   double imag;
 151 } scm_t_complex;
 152
 153 \f
 154
 155 SCM_API SCM scm_exact_p (SCM x);
 156 SCM_API SCM scm_odd_p (SCM n);
 157 SCM_API SCM scm_even_p (SCM n);
 158 SCM_API SCM scm_inf_p (SCM n);
 159 SCM_API SCM scm_nan_p (SCM n);
 160 SCM_API SCM scm_inf (void);
 161 SCM_API SCM scm_nan (void);
 162 SCM_API SCM scm_abs (SCM x);
 163 SCM_API SCM scm_quotient (SCM x, SCM y);
 164 SCM_API SCM scm_remainder (SCM x, SCM y);
 165 SCM_API SCM scm_modulo (SCM x, SCM y);
 166 SCM_API SCM scm_gcd (SCM x, SCM y);
 167 SCM_API SCM scm_lcm (SCM n1, SCM n2);
 168 SCM_API SCM scm_logand (SCM n1, SCM n2);
 169 SCM_API SCM scm_logior (SCM n1, SCM n2);
 170 SCM_API SCM scm_logxor (SCM n1, SCM n2);
 171 SCM_API SCM scm_logtest (SCM n1, SCM n2);
 172 SCM_API SCM scm_logbit_p (SCM n1, SCM n2);
 173 SCM_API SCM scm_lognot (SCM n);
 174 SCM_API SCM scm_integer_expt (SCM z1, SCM z2);
 175 SCM_API SCM scm_ash (SCM n, SCM cnt);
 176 SCM_API SCM scm_bit_extract (SCM n, SCM start, SCM end);
 177 SCM_API SCM scm_logcount (SCM n);
 178 SCM_API SCM scm_integer_length (SCM n);
 179
 180 SCM_API size_t scm_iint2str (long num, int rad, char *p);
 181 SCM_API SCM scm_number_to_string (SCM x, SCM radix);
 182 SCM_API int scm_print_real (SCM sexp, SCM port, scm_print_state *pstate);
 183 SCM_API int scm_print_complex (SCM sexp, SCM port, scm_print_state *pstate);
 184 SCM_API int scm_bigprint (SCM exp, SCM port, scm_print_state *pstate);
 185 SCM_API SCM scm_i_mem2number (const char *mem, size_t len, unsigned int radix);
 186 SCM_API SCM scm_string_to_number (SCM str, SCM radix);
 187 SCM_API SCM scm_make_real (double x);
 188 SCM_API SCM scm_make_complex (double x, double y);
 189 SCM_API SCM scm_bigequal (SCM x, SCM y);
 190 SCM_API SCM scm_real_equalp (SCM x, SCM y);
 191 SCM_API SCM scm_complex_equalp (SCM x, SCM y);
 192 SCM_API SCM scm_number_p (SCM x);
 193 SCM_API SCM scm_real_p (SCM x);
 194 SCM_API SCM scm_integer_p (SCM x);
 195 SCM_API SCM scm_inexact_p (SCM x);
 196 SCM_API SCM scm_num_eq_p (SCM x, SCM y);
 197 SCM_API SCM scm_less_p (SCM x, SCM y);
 198 SCM_API SCM scm_gr_p (SCM x, SCM y);
 199 SCM_API SCM scm_leq_p (SCM x, SCM y);
 200 SCM_API SCM scm_geq_p (SCM x, SCM y);
 201 SCM_API SCM scm_zero_p (SCM z);
 202 SCM_API SCM scm_positive_p (SCM x);
 203 SCM_API SCM scm_negative_p (SCM x);
 204 SCM_API SCM scm_max (SCM x, SCM y);
 205 SCM_API SCM scm_min (SCM x, SCM y);
 206 SCM_API SCM scm_sum (SCM x, SCM y);
 207 SCM_API SCM scm_difference (SCM x, SCM y);
 208 SCM_API SCM scm_product (SCM x, SCM y);
 209 SCM_API double scm_num2dbl (SCM a, const char * why);
 210 SCM_API SCM scm_divide (SCM x, SCM y);
 211 SCM_API double scm_asinh (double x);
 212 SCM_API double scm_acosh (double x);
 213 SCM_API double scm_atanh (double x);
 214 SCM_API double scm_truncate (double x);
 215 SCM_API double scm_round (double x);
 216 SCM_API SCM scm_sys_expt (SCM z1, SCM z2);
 217 SCM_API SCM scm_sys_atan2 (SCM z1, SCM z2);
 218 SCM_API SCM scm_make_rectangular (SCM z1, SCM z2);
 219 SCM_API SCM scm_make_polar (SCM z1, SCM z2);
 220 SCM_API SCM scm_real_part (SCM z);
 221 SCM_API SCM scm_imag_part (SCM z);
 222 SCM_API SCM scm_magnitude (SCM z);
 223 SCM_API SCM scm_angle (SCM z);
 224 SCM_API SCM scm_exact_to_inexact (SCM z);
 225 SCM_API SCM scm_inexact_to_exact (SCM z);
 226 SCM_API SCM scm_trunc (SCM x);
 227
 228 SCM_API SCM scm_short2num (short n);
 229 SCM_API SCM scm_ushort2num (unsigned short n);
 230 SCM_API SCM scm_int2num (int n);
 231 SCM_API SCM scm_uint2num (unsigned int n);
 232 SCM_API SCM scm_long2num (long n);
 233 SCM_API SCM scm_ulong2num (unsigned long n);
 234 SCM_API SCM scm_size2num (size_t n);
 235 SCM_API SCM scm_ptrdiff2num (scm_t_ptrdiff n);
 236 SCM_API short scm_num2short (SCM num, unsigned long int pos,
 237                              const char *s_caller);
 238 SCM_API unsigned short scm_num2ushort (SCM num, unsigned long int pos,
 239                                        const char *s_caller);
 240 SCM_API int scm_num2int (SCM num, unsigned long int pos,
 241                          const char *s_caller);
 242 SCM_API unsigned int scm_num2uint (SCM num, unsigned long int pos,
 243                                    const char *s_caller);
 244 SCM_API long scm_num2long (SCM num, unsigned long int pos,
 245                            const char *s_caller);
 246 SCM_API unsigned long scm_num2ulong (SCM num, unsigned long int pos,
 247                                      const char *s_caller);
 248 SCM_API scm_t_ptrdiff scm_num2ptrdiff (SCM num, unsigned long int pos,
 249                                        const char *s_caller);
 250 SCM_API size_t scm_num2size (SCM num, unsigned long int pos,
 251                              const char *s_caller);
 252 #if SCM_SIZEOF_LONG_LONG != 0
 253 SCM_API SCM scm_long_long2num (long long sl);
 254 SCM_API SCM scm_ulong_long2num (unsigned long long sl);
 255 SCM_API long long scm_num2long_long (SCM num, unsigned long int pos,
 256                                      const char *s_caller);
 257 SCM_API unsigned long long scm_num2ulong_long (SCM num, unsigned long int pos,
 258                                                const char *s_caller);
 259 #endif
 260
 261 SCM_API SCM scm_float2num (float n);
 262 SCM_API SCM scm_double2num (double n);
 263 SCM_API float scm_num2float (SCM num, unsigned long int pos,
 264                              const char *s_caller);
 265 SCM_API double scm_num2double (SCM num, unsigned long int pos,
 266                                const char *s_caller);
 267
 268
 269 /* bignum internal functions */
 270 SCM_API SCM scm_i_mkbig (void);
 271 SCM_API SCM scm_i_normbig (SCM x);
 272 SCM_API int scm_i_bigcmp (SCM a, SCM b);
 273 SCM_API SCM scm_i_dbl2big (double d);
 274 SCM_API double scm_i_big2dbl (SCM b);
 275 SCM_API SCM scm_i_short2big (short n);
 276 SCM_API SCM scm_i_ushort2big (unsigned short n);
 277 SCM_API SCM scm_i_int2big (int n);
 278 SCM_API SCM scm_i_uint2big (unsigned int n);
 279 SCM_API SCM scm_i_long2big (long n);
 280 SCM_API SCM scm_i_ulong2big (unsigned long n);
 281 SCM_API SCM scm_i_size2big (size_t n);
 282 SCM_API SCM scm_i_ptrdiff2big (scm_t_ptrdiff n);
 283
 284 #if SCM_SIZEOF_LONG_LONG != 0
 285 SCM_API SCM scm_i_long_long2big (long long n);
 286 SCM_API SCM scm_i_ulong_long2big (unsigned long long n);
 287 #endif
 288
 289
 290
 291 #ifdef GUILE_DEBUG
 292 SCM_API SCM scm_sys_check_number_conversions (void);
 293 #endif
 294
 295 SCM_API void scm_init_numbers (void);
 296
 297 #endif  /* SCM_NUMBERS_H */
 298
 299 /*
 300   Local Variables:
 301   c-file-style: "gnu"
 302   End:
 303 */