libguile/numbers.h

   1 /* classes: h_files */
   2
   3 #ifndef NUMBERSH
   4 #define NUMBERSH
   5 /* Copyright (C) 1995,1996,1998,2000,2001 Free Software Foundation, Inc.
   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
  19  * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  20  * Boston, MA 02111-1307 USA
  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.
  44  * If you do not wish that, delete this exception notice.  */
  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 */
  48 \f
  49
  50 #include "libguile/__scm.h"
  51 #include "libguile/print.h"
  52
  53 \f
  54
  55 /* Immediate Numbers
  56  *
  57  * Inums are exact integer data that fits within an SCM word.
  58  *
  59  * SCM_INUMP applies only to values known to be Scheme objects.
  60  * In particular, SCM_INUMP (SCM_CAR (x)) is valid only if x is known
  61  * to be a SCM_CONSP.  If x is only known to be a SCM_NIMP,
  62  * SCM_INUMP (SCM_CAR (x)) can give wrong answers.
  63  */
  64
  65 #define SCM_I_FIXNUM_BIT (SCM_LONG_BIT - 2)
  66 #define SCM_MOST_POSITIVE_FIXNUM ((1L << (SCM_I_FIXNUM_BIT - 1)) - 1)
  67 #define SCM_MOST_NEGATIVE_FIXNUM (-SCM_MOST_POSITIVE_FIXNUM - 1)
  68
  69
  70 /* SCM_SRS is signed right shift */
  71 #if (-1 == (((-1) << 2) + 2) >> 2)
  72 # define SCM_SRS(x, y) ((scm_t_signed_bits)(x) >> (y))
  73 #else
  74 # define SCM_SRS(x, y) ((SCM_UNPACK (x) < 0) ? ~((~SCM_UNPACK (x)) >> (y)) : (SCM_UNPACK (x) >> (y)))
  75 #endif /* (-1 == (((-1) << 2) + 2) >> 2) */
  76
  77
  78 #define SCM_INUMP(x)    (2 & SCM_UNPACK (x))
  79 #define SCM_NINUMP(x)   (!SCM_INUMP (x))
  80 #define SCM_MAKINUM(x)  (SCM_PACK (((x) << 2) + 2L))
  81 #define SCM_INUM(x)     ((scm_t_signed_bits)(SCM_SRS (SCM_UNPACK (x), 2)))
  82
  83
  84 /* SCM_FIXABLE is true if its long argument can be encoded in an SCM_INUM. */
  85 #define SCM_POSFIXABLE(n) ((n) <= SCM_MOST_POSITIVE_FIXNUM)
  86 #define SCM_NEGFIXABLE(n) ((n) >= SCM_MOST_NEGATIVE_FIXNUM)
  87 #define SCM_FIXABLE(n) (SCM_POSFIXABLE(n) && SCM_NEGFIXABLE(n))
  88
  89
  90 /* A name for 0. */
  91 #define SCM_INUM0 (SCM_MAKINUM (0))
  92
  93
  94 /* SCM_MAXEXP is the maximum double precision expontent
  95  * SCM_FLTMAX is less than or scm_equal the largest single precision float
  96  */
  97
  98 #ifdef STDC_HEADERS
  99 #ifndef GO32
 100 #include <float.h>
 101 #endif /* ndef GO32 */
 102 #endif /* def STDC_HEADERS */
 103 #ifdef DBL_MAX_10_EXP
 104 #define SCM_MAXEXP DBL_MAX_10_EXP
 105 #else
 106 #define SCM_MAXEXP 308          /* IEEE doubles */
 107 #endif /* def DBL_MAX_10_EXP */
 108 #ifdef FLT_MAX
 109 #define SCM_FLTMAX FLT_MAX
 110 #else
 111 #define SCM_FLTMAX 1e+23
 112 #endif /* def FLT_MAX */
 113
 114
 115 /* SCM_INTBUFLEN is the maximum number of characters neccessary for the
 116  * printed or scm_string representation of an exact immediate.
 117  */
 118 #define SCM_INTBUFLEN (5 + SCM_LONG_BIT)
 119
 120 \f
 121
 122 /* Numbers
 123  */
 124
 125 #define SCM_SLOPPY_INEXACTP(x) (SCM_TYP16S (x) == scm_tc16_real)
 126 #define SCM_SLOPPY_REALP(x) (SCM_TYP16 (x) == scm_tc16_real)
 127 #define SCM_SLOPPY_COMPLEXP(x) (SCM_TYP16 (x) == scm_tc16_complex)
 128 #define SCM_INEXACTP(x) (SCM_NIMP (x) && SCM_TYP16S (x) == scm_tc16_real)
 129 #define SCM_REALP(x) (SCM_NIMP (x) && SCM_TYP16 (x) == scm_tc16_real)
 130 #define SCM_COMPLEXP(x) (SCM_NIMP (x) && SCM_TYP16 (x) == scm_tc16_complex)
 131
 132 #define SCM_REAL_VALUE(x) (((scm_t_double *) SCM2PTR (x))->real)
 133 #define SCM_COMPLEX_MEM(x) ((scm_t_complex *) SCM_CELL_WORD_1 (x))
 134 #define SCM_COMPLEX_REAL(x) (SCM_COMPLEX_MEM (x)->real)
 135 #define SCM_COMPLEX_IMAG(x) (SCM_COMPLEX_MEM (x)->imag)
 136
 137 /* Define SCM_BIGDIG to an integer type whose size is smaller than long if
 138  * you want bignums.  SCM_BIGRAD is one greater than the biggest SCM_BIGDIG.
 139  *
 140  * Define SCM_DIGSTOOBIG if the digits equivalent to a long won't fit in a long.
 141  */
 142 #ifdef BIGNUMS
 143 # ifdef _UNICOS
 144 #  define SCM_DIGSTOOBIG
 145 #  if (1L << 31) <= SCM_USHRT_MAX
 146 #   define SCM_BIGDIG unsigned  short
 147 #  else
 148 #   define SCM_BIGDIG unsigned int
 149 #  endif /*  (1L << 31) <= USHRT_MAX */
 150 #  define SCM_BITSPERDIG 32
 151 # else
 152 #  define SCM_BIGDIG unsigned short
 153 #  define SCM_BITSPERDIG (sizeof(SCM_BIGDIG)*SCM_CHAR_BIT)
 154 # endif /* def _UNICOS */
 155
 156 # define SCM_BIGRAD (1L << SCM_BITSPERDIG)
 157 # define SCM_DIGSPERLONG ((size_t)((sizeof(long)*SCM_CHAR_BIT+SCM_BITSPERDIG-1)/SCM_BITSPERDIG))
 158 # define SCM_I_BIGUP(type, x) ((type)(x) << SCM_BITSPERDIG)
 159 # define SCM_BIGUP(x) SCM_I_BIGUP (unsigned long, x)
 160 # define SCM_LONGLONGBIGUP(x) SCM_I_BIGUP (unsigned long long, x)
 161 # define SCM_BIGDN(x) ((x) >> SCM_BITSPERDIG)
 162 # define SCM_BIGLO(x) ((x) & (SCM_BIGRAD-1))
 163 #endif /* def BIGNUMS */
 164
 165 #ifndef SCM_BIGDIG
 166 /* Definition is not really used but helps various function
 167  * prototypes to compile with conditionalization.
 168  */
 169 # define SCM_BIGDIG unsigned short
 170 #endif /* ndef SCM_BIGDIG */
 171
 172 #define SCM_NUMBERP(x) (SCM_INUMP(x) || SCM_NUMP(x))
 173 #define SCM_NUMP(x) (!SCM_IMP(x) && (0xfcff & SCM_CELL_TYPE (x)) == scm_tc7_smob)
 174 #define SCM_BIGP(x) (!SCM_IMP (x) && (SCM_TYP16 (x) == scm_tc16_big))
 175 #define SCM_BIGSIGNFLAG 0x10000L
 176 #define SCM_BIGSIZEFIELD 17
 177 #define SCM_BIGSIGN(x) (SCM_CELL_WORD_0 (x) & SCM_BIGSIGNFLAG)
 178 #define SCM_BDIGITS(x) ((SCM_BIGDIG *) (SCM_CELL_WORD_1 (x)))
 179 #define SCM_SET_BIGNUM_BASE(n, b) (SCM_SET_CELL_WORD_1 ((n), (b)))
 180 #define SCM_NUMDIGS(x) ((size_t) (SCM_CELL_WORD_0 (x) >> SCM_BIGSIZEFIELD))
 181 #define SCM_SETNUMDIGS(x, v, sign) \
 182   SCM_SET_CELL_WORD_0 (x, \
 183               scm_tc16_big \
 184               | ((sign) ? SCM_BIGSIGNFLAG : 0) \
 185               | (((v) + 0L) << SCM_BIGSIZEFIELD))
 186
 187 \f
 188
 189 typedef struct scm_t_double
 190 {
 191   SCM type;
 192   SCM pad;
 193   double real;
 194 } scm_t_double;
 195
 196 typedef struct scm_t_complex
 197 {
 198   double real;
 199   double imag;
 200 } scm_t_complex;
 201
 202 \f
 203
 204 extern SCM scm_exact_p (SCM x);
 205 extern SCM scm_odd_p (SCM n);
 206 extern SCM scm_even_p (SCM n);
 207 extern SCM scm_abs (SCM x);
 208 extern SCM scm_quotient (SCM x, SCM y);
 209 extern SCM scm_remainder (SCM x, SCM y);
 210 extern SCM scm_modulo (SCM x, SCM y);
 211 extern SCM scm_gcd (SCM x, SCM y);
 212 extern SCM scm_lcm (SCM n1, SCM n2);
 213 extern SCM scm_logand (SCM n1, SCM n2);
 214 extern SCM scm_logior (SCM n1, SCM n2);
 215 extern SCM scm_logxor (SCM n1, SCM n2);
 216 extern SCM scm_logtest (SCM n1, SCM n2);
 217 extern SCM scm_logbit_p (SCM n1, SCM n2);
 218 extern SCM scm_lognot (SCM n);
 219 extern SCM scm_integer_expt (SCM z1, SCM z2);
 220 extern SCM scm_ash (SCM n, SCM cnt);
 221 extern SCM scm_bit_extract (SCM n, SCM start, SCM end);
 222 extern SCM scm_logcount (SCM n);
 223 extern SCM scm_integer_length (SCM n);
 224 extern SCM scm_i_mkbig (size_t nlen, int sign);
 225 extern SCM scm_i_big2inum (SCM b, size_t l);
 226 extern SCM scm_i_adjbig (SCM b, size_t nlen);
 227 extern SCM scm_i_normbig (SCM b);
 228 extern SCM scm_i_copybig (SCM b, int sign);
 229 extern SCM scm_i_short2big (short n);
 230 extern SCM scm_i_ushort2big (unsigned short n);
 231 extern SCM scm_i_int2big (int n);
 232 extern SCM scm_i_uint2big (unsigned int n);
 233 extern SCM scm_i_long2big (long n);
 234 extern SCM scm_i_ulong2big (unsigned long n);
 235 extern SCM scm_i_size2big (size_t n);
 236 extern SCM scm_i_ptrdiff2big (ptrdiff_t n);
 237
 238
 239 #if (SCM_DEBUG_DEPRECATED == 0)
 240 extern SCM scm_big2inum (SCM b, size_t l);
 241 extern SCM scm_mkbig (size_t nlen, int sign);
 242 extern SCM scm_adjbig (SCM b, size_t len);
 243 extern SCM scm_normbig (SCM b);
 244 extern SCM scm_copybig (SCM b, int sign);
 245
 246 #define SCM_FIXNUM_BIT SCM_I_FIXNUM_BIT
 247 #endif
 248
 249 #ifdef HAVE_LONG_LONGS
 250 extern SCM scm_i_long_long2big (long long n);
 251 extern SCM scm_i_ulong_long2big (unsigned long long n);
 252 #endif
 253
 254 #if (SCM_DEBUG_DEPRECATED == 0)
 255 extern SCM scm_2ulong2big (unsigned long * np);
 256 #endif
 257
 258 extern int scm_bigcomp (SCM x, SCM y);
 259 extern long scm_pseudolong (long x);
 260 extern void scm_longdigs (long x, SCM_BIGDIG digs[]);
 261 extern SCM scm_addbig (SCM_BIGDIG *x, size_t nx, int xsgn, SCM bigy, int sgny);
 262 extern SCM scm_mulbig (SCM_BIGDIG *x, size_t nx, SCM_BIGDIG *y, size_t ny, int sgn);
 263 extern unsigned int scm_divbigdig (SCM_BIGDIG *ds, size_t h, SCM_BIGDIG div);
 264 extern size_t scm_iint2str (long num, int rad, char *p);
 265 extern SCM scm_number_to_string (SCM x, SCM radix);
 266 extern int scm_print_real (SCM sexp, SCM port, scm_print_state *pstate);
 267 extern int scm_print_complex (SCM sexp, SCM port, scm_print_state *pstate);
 268 extern int scm_bigprint (SCM exp, SCM port, scm_print_state *pstate);
 269 extern SCM scm_istr2int (char *str, long len, long radix);
 270 extern SCM scm_istr2flo (char *str, long len, long radix);
 271 extern SCM scm_istring2number (char *str, long len, long radix);
 272 extern SCM scm_string_to_number (SCM str, SCM radix);
 273 extern SCM scm_make_real (double x);
 274 extern SCM scm_make_complex (double x, double y);
 275 extern SCM scm_bigequal (SCM x, SCM y);
 276 extern SCM scm_real_equalp (SCM x, SCM y);
 277 extern SCM scm_complex_equalp (SCM x, SCM y);
 278 extern SCM scm_number_p (SCM x);
 279 extern SCM scm_real_p (SCM x);
 280 extern SCM scm_integer_p (SCM x);
 281 extern SCM scm_inexact_p (SCM x);
 282 extern SCM scm_num_eq_p (SCM x, SCM y);
 283 extern SCM scm_less_p (SCM x, SCM y);
 284 extern SCM scm_gr_p (SCM x, SCM y);
 285 extern SCM scm_leq_p (SCM x, SCM y);
 286 extern SCM scm_geq_p (SCM x, SCM y);
 287 extern SCM scm_zero_p (SCM z);
 288 extern SCM scm_positive_p (SCM x);
 289 extern SCM scm_negative_p (SCM x);
 290 extern SCM scm_max (SCM x, SCM y);
 291 extern SCM scm_min (SCM x, SCM y);
 292 extern SCM scm_sum (SCM x, SCM y);
 293 extern SCM scm_difference (SCM x, SCM y);
 294 extern SCM scm_product (SCM x, SCM y);
 295 extern double scm_num2dbl (SCM a, const char * why);
 296 extern SCM scm_divide (SCM x, SCM y);
 297 extern double scm_asinh (double x);
 298 extern double scm_acosh (double x);
 299 extern double scm_atanh (double x);
 300 extern double scm_truncate (double x);
 301 extern double scm_round (double x);
 302 extern double scm_exact_to_inexact (double z);
 303 extern SCM scm_sys_expt (SCM z1, SCM z2);
 304 extern SCM scm_sys_atan2 (SCM z1, SCM z2);
 305 extern SCM scm_make_rectangular (SCM z1, SCM z2);
 306 extern SCM scm_make_polar (SCM z1, SCM z2);
 307 extern SCM scm_real_part (SCM z);
 308 extern SCM scm_imag_part (SCM z);
 309 extern SCM scm_magnitude (SCM z);
 310 extern SCM scm_angle (SCM z);
 311 extern SCM scm_inexact_to_exact (SCM z);
 312 extern SCM scm_trunc (SCM x);
 313 extern SCM scm_i_dbl2big (double d);
 314
 315 #if (SCM_DEBUG_DEPRECATED == 0)
 316 extern SCM scm_dbl2big (double d);
 317 #endif
 318
 319 extern double scm_i_big2dbl (SCM b);
 320
 321 #if (SCM_DEBUG_DEPRECATED == 0)
 322 extern double scm_big2dbl (SCM b);
 323 #endif
 324
 325 extern SCM scm_short2num (short n);
 326 extern SCM scm_ushort2num (unsigned short n);
 327 extern SCM scm_int2num (int n);
 328 extern SCM scm_uint2num (unsigned int n);
 329 extern SCM scm_long2num (long n);
 330 extern SCM scm_ulong2num (unsigned long n);
 331 extern SCM scm_size2num (size_t n);
 332 extern SCM scm_ptrdiff2num (ptrdiff_t n);
 333 extern short scm_num2short (SCM num, unsigned long int pos,
 334                             const char *s_caller);
 335 extern unsigned short scm_num2ushort (SCM num, unsigned long int pos,
 336                                       const char *s_caller);
 337 extern int scm_num2int (SCM num, unsigned long int pos,
 338                         const char *s_caller);
 339 extern unsigned int scm_num2uint (SCM num, unsigned long int pos,
 340                                   const char *s_caller);
 341 extern long scm_num2long (SCM num, unsigned long int pos,
 342                           const char *s_caller);
 343 extern unsigned long scm_num2ulong (SCM num, unsigned long int pos,
 344                                     const char *s_caller);
 345 extern ptrdiff_t scm_num2ptrdiff (SCM num, unsigned long int pos,
 346                                   const char *s_caller);
 347 extern size_t scm_num2size (SCM num, unsigned long int pos,
 348                             const char *s_caller);
 349 #ifdef HAVE_LONG_LONGS
 350 extern SCM scm_long_long2num (long long sl);
 351 extern SCM scm_ulong_long2num (unsigned long long sl);
 352 extern long long scm_num2long_long (SCM num, unsigned long int pos,
 353                                     const char *s_caller);
 354 extern unsigned long long scm_num2ulong_long (SCM num, unsigned long int pos,
 355                                       const char *s_caller);
 356 #endif
 357
 358 extern void scm_init_numbers (void);
 359
 360 #endif  /* NUMBERSH */
 361
 362 /*
 363   Local Variables:
 364   c-file-style: "gnu"
 365   End:
 366 */