libguile/numbers.h

   1 /* classes: h_files */
   2
   3 #ifndef NUMBERSH
   4 #define NUMBERSH
   5 /*      Copyright (C) 1995,1996 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, 675 Mass Ave, Cambridge, MA 02139, USA.
  20  *
  21  * As a special exception, the Free Software Foundation gives permission
  22  * for additional uses of the text contained in its release of GUILE.
  23  *
  24  * The exception is that, if you link the GUILE library with other files
  25  * to produce an executable, this does not by itself cause the
  26  * resulting executable to be covered by the GNU General Public License.
  27  * Your use of that executable is in no way restricted on account of
  28  * linking the GUILE library code into it.
  29  *
  30  * This exception does not however invalidate any other reasons why
  31  * the executable file might be covered by the GNU General Public License.
  32  *
  33  * This exception applies only to the code released by the
  34  * Free Software Foundation under the name GUILE.  If you copy
  35  * code from other Free Software Foundation releases into a copy of
  36  * GUILE, as the General Public License permits, the exception does
  37  * not apply to the code that you add in this way.  To avoid misleading
  38  * anyone as to the status of such modified files, you must delete
  39  * this exception notice from them.
  40  *
  41  * If you write modifications of your own for GUILE, it is your choice
  42  * whether to permit this exception to apply to your modifications.
  43  * If you do not wish that, delete this exception notice.
  44  */
  45 \f
  46
  47 #include "libguile/__scm.h"
  48
  49 \f
  50
  51
  52 /* Immediate Numbers
  53  *
  54  * Inums are exact integer data that fits within an SCM word.
  55  *
  56  * SCM_INUMP applies only to values known to be Scheme objects.
  57  * In particular, SCM_INUMP (SCM_CAR (x)) is valid only if x is known
  58  * to be a SCM_CONSP.  If x is only known to be a SCM_NIMP,
  59  * SCM_INUMP (SCM_CAR (x)) can give wrong answers.
  60  */
  61
  62 #define SCM_INUMP(x)    (2 & (int)(x))
  63 #define SCM_NINUMP(x)   (!SCM_INUMP(x))
  64
  65 #ifdef __TURBOC__
  66 /* shifts of more than one are done by a library call, single shifts are
  67  * performed in registers
  68  */
  69 # define SCM_MAKINUM(x) ((((x)<<1)<<1)+2L)
  70 #else
  71 # define SCM_MAKINUM(x) (((x)<<2)+2L)
  72 #endif /* def __TURBOC__ */
  73
  74
  75 /* SCM_SRS is signed right shift */
  76 /* Turbo C++ v1.0 has a bug with right shifts of signed longs!
  77  * It is believed to be fixed in Turbo C++ v1.01
  78  */
  79 #if (-1==(((-1)<<2)+2)>>2) && (__TURBOC__ != 0x295)
  80 # define SCM_SRS(x, y) ((x)>>y)
  81 # ifdef __TURBOC__
  82 #  define SCM_INUM(x) (((x)>>1)>>1)
  83 # else
  84 #  define SCM_INUM(x) SCM_SRS(x, 2)
  85 # endif /* def __TURBOC__ */
  86 #else
  87 # define SCM_SRS(x, y) (((x)<0) ? ~((~(x))>>y) : (x)>>y)
  88 # define SCM_INUM(x) SCM_SRS(x, 2)
  89 #endif /*  (-1==(((-1)<<2)+2)>>2) && (__TURBOC__ != 0x295) */
  90
  91
  92 /* A name for 0.
  93  */
  94 #define SCM_INUM0 ((SCM) 2)
  95
  96
  97
  98 /* SCM_FIXABLE is non-0 if its long argument can be encoded in an SCM_INUM.
  99  */
 100 #define SCM_POSFIXABLE(n) ((n) <= SCM_MOST_POSITIVE_FIXNUM)
 101 #define SCM_NEGFIXABLE(n) ((n) >= SCM_MOST_NEGATIVE_FIXNUM)
 102 #define SCM_UNEGFIXABLE(n) ((n) <= -SCM_MOST_NEGATIVE_FIXNUM)
 103 #define SCM_FIXABLE(n) (SCM_POSFIXABLE(n) && SCM_NEGFIXABLE(n))
 104
 105 /* SCM_INTBUFLEN is the maximum number of characters neccessary for the
 106  * printed or scm_string representation of an exact immediate.
 107  */
 108
 109 #ifndef SCM_CHAR_BIT
 110 # define SCM_CHAR_BIT 8
 111 #endif /* ndef SCM_CHAR_BIT */
 112 #ifndef SCM_LONG_BIT
 113 # define SCM_LONG_BIT (SCM_CHAR_BIT*sizeof(long)/sizeof(char))
 114 #endif /* ndef SCM_LONG_BIT */
 115 #define SCM_INTBUFLEN (5+SCM_LONG_BIT)
 116
 117 /* SCM_FLOBUFLEN is the maximum number of characters neccessary for the
 118  * printed or scm_string representation of an inexact number.
 119  */
 120
 121 #define SCM_FLOBUFLEN (10+2*(sizeof(double)/sizeof(char)*SCM_CHAR_BIT*3+9)/10)
 122
 123
 124 \f
 125
 126 /* Numbers
 127  */
 128
 129 #define SCM_INEXP(x) (SCM_TYP16(x)==scm_tc16_flo)
 130 #define SCM_CPLXP(x) (SCM_CAR(x)==scm_tc_dblc)
 131 #define SCM_REAL(x) (*(((scm_dbl *) (SCM2PTR(x)))->real))
 132 #define SCM_IMAG(x) (*((double *)(SCM_CHARS(x)+sizeof(double))))
 133 /* ((&SCM_REAL(x))[1]) */
 134
 135
 136 #ifdef SCM_SINGLES
 137 #define SCM_REALP(x) ((~SCM_REAL_PART & SCM_CAR(x))==scm_tc_flo)
 138 #define SCM_SINGP(x) (SCM_CAR(x)==scm_tc_flo)
 139 #define SCM_FLO(x) (((scm_flo *)(SCM2PTR(x)))->num)
 140 #define SCM_REALPART(x) (SCM_SINGP(x)?0.0+SCM_FLO(x):SCM_REAL(x))
 141 #else /* SCM_SINGLES */
 142 #define SCM_REALP(x) (SCM_CAR(x)==scm_tc_dblr)
 143 #define SCM_REALPART SCM_REAL
 144 #endif /* SCM_SINGLES */
 145
 146
 147 /* Define SCM_BIGDIG to an integer type whose size is smaller than long if
 148  * you want bignums.  SCM_BIGRAD is one greater than the biggest SCM_BIGDIG.
 149  *
 150  * Define SCM_DIGSTOOBIG if the digits equivalent to a long won't fit in a long.
 151  */
 152 #ifdef BIGNUMS
 153 # ifdef _UNICOS
 154 #  define SCM_DIGSTOOBIG
 155 #  if (1L << 31) <= SCM_USHRT_MAX
 156 #   define SCM_BIGDIG unsigned  short
 157 #  else
 158 #   define SCM_BIGDIG unsigned int
 159 #  endif /*  (1L << 31) <= USHRT_MAX */
 160 #  define SCM_BITSPERDIG 32
 161 # else
 162 #  define SCM_BIGDIG unsigned short
 163 #  define SCM_BITSPERDIG (sizeof(SCM_BIGDIG)*SCM_CHAR_BIT)
 164 # endif /* def _UNICOS */
 165
 166 # define SCM_BIGRAD (1L << SCM_BITSPERDIG)
 167 # define SCM_DIGSPERLONG ((scm_sizet)((sizeof(long)*SCM_CHAR_BIT+SCM_BITSPERDIG-1)/SCM_BITSPERDIG))
 168 # define SCM_DIGSPERLONGLONG ((scm_sizet)((sizeof(long long)*SCM_CHAR_BIT+SCM_BITSPERDIG-1)/SCM_BITSPERDIG))
 169 # define SCM_BIGUP(x) ((unsigned long)(x) << SCM_BITSPERDIG)
 170 # define SCM_LONGLONGBIGUP(x) ((ulong_long)(x) << SCM_BITSPERDIG)
 171 # define SCM_BIGDN(x) ((x) >> SCM_BITSPERDIG)
 172 # define SCM_BIGLO(x) ((x) & (SCM_BIGRAD-1))
 173 #endif /* def BIGNUMS */
 174
 175 #ifndef SCM_BIGDIG
 176 /* Definition is not really used but helps various function
 177  * prototypes to compile with conditionalization.
 178  */
 179 # define SCM_BIGDIG unsigned short
 180 # define SCM_NO_BIGDIG
 181 # ifndef SCM_FLOATS
 182 #  define SCM_INUMS_ONLY
 183 # endif /* ndef SCM_FLOATS */
 184 #endif /* ndef SCM_BIGDIG */
 185
 186 #ifdef SCM_FLOATS
 187 #define SCM_NUMBERP(x) (SCM_INUMP(x) || (SCM_NIMP(x) && SCM_NUMP(x)))
 188 #else
 189 #ifdef SCM_BIGDIG
 190 #define SCM_NUMBERP(x) (SCM_INUMP(x) || (SCM_NIMP(x) && SCM_NUMP(x)))
 191 #else
 192 #define SCM_NUMBERP SCM_INUMP
 193 #endif
 194 #endif
 195 #define SCM_NUMP(x) ((0xfcff & (int)SCM_CAR(x))==scm_tc7_smob)
 196 #define SCM_BIGP(x) (SCM_TYP16S(x)==scm_tc16_bigpos)
 197 #define SCM_BIGSIGN(x) (0x0100 & (int)SCM_CAR(x))
 198 #define SCM_BDIGITS(x) ((SCM_BIGDIG *)(SCM_CDR(x)))
 199 #define SCM_NUMDIGS(x) ((scm_sizet)(SCM_CAR(x)>>16))
 200 #define SCM_SETNUMDIGS(x, v, t) SCM_SETCAR(x, (((v)+0L)<<16)+(t))
 201 \f
 202
 203 #ifdef SCM_FLOATS
 204 typedef struct scm_dblproc
 205 {
 206   char *scm_string;
 207   double (*cproc) ();
 208 } scm_dblproc;
 209
 210 #ifdef SCM_SINGLES
 211 typedef struct scm_flo
 212 {
 213   SCM type;
 214   float num;
 215 } scm_flo;
 216 #endif
 217
 218 typedef struct scm_dbl
 219 {
 220   SCM type;
 221   double *real;
 222 } scm_dbl;
 223 #endif
 224
 225
 226
 227 \f
 228
 229 extern SCM scm_exact_p SCM_P ((SCM x));
 230 extern SCM scm_odd_p SCM_P ((SCM n));
 231 extern SCM scm_even_p SCM_P ((SCM n));
 232 extern SCM scm_abs SCM_P ((SCM x));
 233 extern SCM scm_quotient SCM_P ((SCM x, SCM y));
 234 extern SCM scm_remainder SCM_P ((SCM x, SCM y));
 235 extern SCM scm_modulo SCM_P ((SCM x, SCM y));
 236 extern SCM scm_gcd SCM_P ((SCM x, SCM y));
 237 extern SCM scm_lcm SCM_P ((SCM n1, SCM n2));
 238 extern SCM scm_logand SCM_P ((SCM n1, SCM n2));
 239 extern SCM scm_logior SCM_P ((SCM n1, SCM n2));
 240 extern SCM scm_logxor SCM_P ((SCM n1, SCM n2));
 241 extern SCM scm_logtest SCM_P ((SCM n1, SCM n2));
 242 extern SCM scm_logbit_p SCM_P ((SCM n1, SCM n2));
 243 extern SCM scm_lognot SCM_P ((SCM n));
 244 extern SCM scm_integer_expt SCM_P ((SCM z1, SCM z2));
 245 extern SCM scm_ash SCM_P ((SCM n, SCM cnt));
 246 extern SCM scm_bit_extract SCM_P ((SCM n, SCM start, SCM end));
 247 extern SCM scm_logcount SCM_P ((SCM n));
 248 extern SCM scm_integer_length SCM_P ((SCM n));
 249 extern SCM scm_mkbig SCM_P ((scm_sizet nlen, int sign));
 250 extern SCM scm_big2inum SCM_P ((SCM b, scm_sizet l));
 251 extern SCM scm_adjbig SCM_P ((SCM b, scm_sizet nlen));
 252 extern SCM scm_normbig SCM_P ((SCM b));
 253 extern SCM scm_copybig SCM_P ((SCM b, int sign));
 254 extern SCM scm_long2big SCM_P ((long n));
 255 extern SCM scm_long_long2big SCM_P ((long_long n));
 256 extern SCM scm_2ulong2big SCM_P ((unsigned long * np));
 257 extern SCM scm_ulong2big SCM_P ((unsigned long n));
 258 extern int scm_bigcomp SCM_P ((SCM x, SCM y));
 259 extern long scm_pseudolong SCM_P ((long x));
 260 extern void scm_longdigs SCM_P ((long x, SCM_BIGDIG digs[]));
 261 extern SCM scm_addbig SCM_P ((SCM_BIGDIG *x, scm_sizet nx, int xsgn, SCM bigy, int sgny));
 262 extern SCM scm_mulbig SCM_P ((SCM_BIGDIG *x, scm_sizet nx, SCM_BIGDIG *y, scm_sizet ny, int sgn));
 263 extern unsigned int scm_divbigdig SCM_P ((SCM_BIGDIG *ds, scm_sizet h, SCM_BIGDIG div));
 264 extern SCM scm_divbigint SCM_P ((SCM x, long z, int sgn, int mode));
 265 extern SCM scm_divbigbig SCM_P ((SCM_BIGDIG *x, scm_sizet nx, SCM_BIGDIG *y, scm_sizet ny, int sgn, int modes));
 266 extern scm_sizet scm_iint2str SCM_P ((long num, int rad, char *p));
 267 extern SCM scm_number_to_string SCM_P ((SCM x, SCM radix));
 268 extern int scm_floprint SCM_P ((SCM sexp, SCM port, scm_print_state *pstate));
 269 extern int scm_bigprint SCM_P ((SCM exp, SCM port, scm_print_state *pstate));
 270 extern SCM scm_istr2int SCM_P ((char *str, long len, long radix));
 271 extern SCM scm_istr2flo SCM_P ((char *str, long len, long radix));
 272 extern SCM scm_istring2number SCM_P ((char *str, long len, long radix));
 273 extern SCM scm_string_to_number SCM_P ((SCM str, SCM radix));
 274 extern SCM scm_makdbl SCM_P ((double x, double y));
 275 extern SCM scm_bigequal SCM_P ((SCM x, SCM y));
 276 extern SCM scm_floequal SCM_P ((SCM x, SCM y));
 277 extern SCM scm_number_p SCM_P ((SCM x));
 278 extern SCM scm_real_p SCM_P ((SCM x));
 279 extern SCM scm_int_p SCM_P ((SCM x));
 280 extern SCM scm_inexact_p SCM_P ((SCM x));
 281 extern SCM scm_num_eq_p SCM_P ((SCM x, SCM y));
 282 extern SCM scm_less_p SCM_P ((SCM x, SCM y));
 283 extern SCM scm_gr_p SCM_P ((SCM x, SCM y));
 284 extern SCM scm_leq_p SCM_P ((SCM x, SCM y));
 285 extern SCM scm_geq_p SCM_P ((SCM x, SCM y));
 286 extern SCM scm_zero_p SCM_P ((SCM z));
 287 extern SCM scm_positive_p SCM_P ((SCM x));
 288 extern SCM scm_negative_p SCM_P ((SCM x));
 289 extern SCM scm_max SCM_P ((SCM x, SCM y));
 290 extern SCM scm_min SCM_P ((SCM x, SCM y));
 291 extern SCM scm_sum SCM_P ((SCM x, SCM y));
 292 extern SCM scm_difference SCM_P ((SCM x, SCM y));
 293 extern SCM scm_product SCM_P ((SCM x, SCM y));
 294 extern double scm_num2dbl SCM_P ((SCM a, char * why));
 295 extern SCM scm_fuck SCM_P ((SCM a));
 296 extern SCM scm_divide SCM_P ((SCM x, SCM y));
 297 extern double scm_asinh SCM_P ((double x));
 298 extern double scm_acosh SCM_P ((double x));
 299 extern double scm_atanh SCM_P ((double x));
 300 extern double scm_truncate SCM_P ((double x));
 301 extern double scm_round SCM_P ((double x));
 302 extern double scm_exact_to_inexact SCM_P ((double z));
 303 extern SCM scm_sys_expt SCM_P ((SCM z1, SCM z2));
 304 extern SCM scm_sys_atan2 SCM_P ((SCM z1, SCM z2));
 305 extern SCM scm_make_rectangular SCM_P ((SCM z1, SCM z2));
 306 extern SCM scm_make_polar SCM_P ((SCM z1, SCM z2));
 307 extern SCM scm_real_part SCM_P ((SCM z));
 308 extern SCM scm_imag_part SCM_P ((SCM z));
 309 extern SCM scm_magnitude SCM_P ((SCM z));
 310 extern SCM scm_angle SCM_P ((SCM z));
 311 extern SCM scm_inexact_to_exact SCM_P ((SCM z));
 312 extern SCM scm_trunc SCM_P ((SCM x));
 313 extern SCM scm_dbl2big SCM_P ((double d));
 314 extern double scm_big2dbl SCM_P ((SCM b));
 315 extern SCM scm_long2num SCM_P ((long sl));
 316 extern SCM scm_long_long2num SCM_P ((long_long sl));
 317 extern SCM scm_ulong2num SCM_P ((unsigned long sl));
 318 extern long scm_num2long SCM_P ((SCM num, char *pos, char *s_caller));
 319 extern long num2long SCM_P ((SCM num, char *pos, char *s_caller));
 320 extern long_long scm_num2long_long SCM_P ((SCM num, char *pos, char *s_caller));
 321 extern unsigned long scm_num2ulong SCM_P ((SCM num, char *pos, char *s_caller));
 322 extern void scm_init_numbers SCM_P ((void));
 323
 324 #endif  /* NUMBERSH */