floatfns.c 26.2 KB
Newer Older
Mike Rowan's avatar
Mike Rowan committed
1
/* Primitive operations on floating point for GNU Emacs Lisp interpreter.
Karl Heuer's avatar
Karl Heuer committed
2
   Copyright (C) 1988, 1993, 1994 Free Software Foundation, Inc.
Mike Rowan's avatar
Mike Rowan committed
3 4 5 6 7

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
Jim Blandy's avatar
Jim Blandy committed
8
the Free Software Foundation; either version 2, or (at your option)
Mike Rowan's avatar
Mike Rowan committed
9 10 11 12 13 14 15 16 17
any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
18 19
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Mike Rowan's avatar
Mike Rowan committed
20 21


22 23 24 25 26 27
/* ANSI C requires only these float functions:
   acos, asin, atan, atan2, ceil, cos, cosh, exp, fabs, floor, fmod,
   frexp, ldexp, log, log10, modf, pow, sin, sinh, sqrt, tan, tanh.

   Define HAVE_INVERSE_HYPERBOLIC if you have acosh, asinh, and atanh.
   Define HAVE_CBRT if you have cbrt.
28
   Define HAVE_RINT if you have a working rint.
29 30 31 32 33 34 35 36 37 38 39 40
   If you don't define these, then the appropriate routines will be simulated.

   Define HAVE_MATHERR if on a system supporting the SysV matherr callback.
   (This should happen automatically.)

   Define FLOAT_CHECK_ERRNO if the float library routines set errno.
   This has no effect if HAVE_MATHERR is defined.

   Define FLOAT_CATCH_SIGILL if the float library routines signal SIGILL.
   (What systems actually do this?  Please let us know.)

   Define FLOAT_CHECK_DOMAIN if the float library doesn't handle errors by
Karl Heuer's avatar
Karl Heuer committed
41
   either setting errno, or signaling SIGFPE/SIGILL.  Otherwise, domain and
42 43 44 45 46
   range checking will happen before calling the float routines.  This has
   no effect if HAVE_MATHERR is defined (since matherr will be called when
   a domain error occurs.)
 */

Mike Rowan's avatar
Mike Rowan committed
47 48
#include <signal.h>

49
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
50

51
/* Put this before lisp.h so that lisp.h can define DBL_DIG if not defined.  */
52 53 54 55
#if STDC_HEADERS
#include <float.h>
#endif

56 57 58 59 60
#include "lisp.h"
#include "syssignal.h"

#ifdef LISP_FLOAT_TYPE

61 62 63 64 65 66 67 68 69 70
/* If IEEE_FLOATING_POINT isn't defined, default it from FLT_*. */
#ifndef IEEE_FLOATING_POINT
#if (FLT_RADIX == 2 && FLT_MANT_DIG == 24 \
     && FLT_MIN_EXP == -125 && FLT_MAX_EXP == 128)
#define IEEE_FLOATING_POINT 1
#else
#define IEEE_FLOATING_POINT 0
#endif
#endif

71 72 73 74 75 76 77 78 79 80
/* Work around a problem that happens because math.h on hpux 7
   defines two static variables--which, in Emacs, are not really static,
   because `static' is defined as nothing.  The problem is that they are
   defined both here and in lread.c.
   These macros prevent the name conflict.  */
#if defined (HPUX) && !defined (HPUX8)
#define _MAXLDBL floatfns_maxldbl
#define _NMAXLDBL floatfns_nmaxldbl
#endif

Mike Rowan's avatar
Mike Rowan committed
81
#include <math.h>
82

83
/* This declaration is omitted on some systems, like Ultrix.  */
84
#if !defined (HPUX) && defined (HAVE_LOGB) && !defined (logb)
85
extern double logb ();
86
#endif /* not HPUX and HAVE_LOGB and no logb macro */
87

88 89 90 91 92 93 94
#if defined(DOMAIN) && defined(SING) && defined(OVERFLOW)
    /* If those are defined, then this is probably a `matherr' machine. */
# ifndef HAVE_MATHERR
#  define HAVE_MATHERR
# endif
#endif

Richard M. Stallman's avatar
Richard M. Stallman committed
95
#ifdef NO_MATHERR
96 97 98
#undef HAVE_MATHERR
#endif

99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
#ifdef HAVE_MATHERR
# ifdef FLOAT_CHECK_ERRNO
#  undef FLOAT_CHECK_ERRNO
# endif
# ifdef FLOAT_CHECK_DOMAIN
#  undef FLOAT_CHECK_DOMAIN
# endif
#endif

#ifndef NO_FLOAT_CHECK_ERRNO
#define FLOAT_CHECK_ERRNO
#endif

#ifdef FLOAT_CHECK_ERRNO
# include <errno.h>
Jim Blandy's avatar
Jim Blandy committed
114 115

extern int errno;
116
#endif
Jim Blandy's avatar
Jim Blandy committed
117 118 119 120 121 122 123 124 125 126 127

/* Avoid traps on VMS from sinh and cosh.
   All the other functions set errno instead.  */

#ifdef VMS
#undef cosh
#undef sinh
#define cosh(x) ((exp(x)+exp(-x))*0.5)
#define sinh(x) ((exp(x)-exp(-x))*0.5)
#endif /* VMS */

Jim Blandy's avatar
Jim Blandy committed
128
static SIGTYPE float_error ();
Mike Rowan's avatar
Mike Rowan committed
129 130 131 132 133 134 135

/* Nonzero while executing in floating point.
   This tells float_error what to do.  */

static int in_float;

/* If an argument is out of range for a mathematical function,
Richard M. Stallman's avatar
Richard M. Stallman committed
136 137 138
   here is the actual argument value to use in the error message.
   These variables are used only across the floating point library call
   so there is no need to staticpro them.  */
Mike Rowan's avatar
Mike Rowan committed
139

140 141 142
static Lisp_Object float_error_arg, float_error_arg2;

static char *float_error_fn_name;
Mike Rowan's avatar
Mike Rowan committed
143

Jim Blandy's avatar
Jim Blandy committed
144 145 146
/* Evaluate the floating point expression D, recording NUM
   as the original argument for error messages.
   D is normally an assignment expression.
147 148 149 150 151
   Handle errors which may result in signals or may set errno.

   Note that float_error may be declared to return void, so you can't
   just cast the zero after the colon to (SIGTYPE) to make the types
   check properly.  */
Jim Blandy's avatar
Jim Blandy committed
152

153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
#ifdef FLOAT_CHECK_ERRNO
#define IN_FLOAT(d, name, num)				\
  do {							\
    float_error_arg = num;				\
    float_error_fn_name = name;				\
    in_float = 1; errno = 0; (d); in_float = 0;		\
    switch (errno) {					\
    case 0: break;					\
    case EDOM:	 domain_error (float_error_fn_name, float_error_arg);	\
    case ERANGE: range_error (float_error_fn_name, float_error_arg);	\
    default:	 arith_error (float_error_fn_name, float_error_arg);	\
    }							\
  } while (0)
#define IN_FLOAT2(d, name, num, num2)			\
  do {							\
    float_error_arg = num;				\
    float_error_arg2 = num2;				\
    float_error_fn_name = name;				\
    in_float = 1; errno = 0; (d); in_float = 0;		\
    switch (errno) {					\
    case 0: break;					\
    case EDOM:	 domain_error (float_error_fn_name, float_error_arg);	\
    case ERANGE: range_error (float_error_fn_name, float_error_arg);	\
    default:	 arith_error (float_error_fn_name, float_error_arg);	\
    }							\
  } while (0)
#else
180
#define IN_FLOAT(d, name, num) (in_float = 1, (d), in_float = 0)
181 182 183
#define IN_FLOAT2(d, name, num, num2) (in_float = 1, (d), in_float = 0)
#endif

184 185 186 187 188
/* Convert float to Lisp_Int if it fits, else signal a range error
   using the given arguments.  */
#define FLOAT_TO_INT(x, i, name, num)					\
  do									\
    {									\
189 190
      if ((x) >= (((EMACS_INT) 1) << (VALBITS-1)) ||			\
	  (x) <= - (((EMACS_INT) 1) << (VALBITS-1)) - 1)		\
191
	range_error (name, num);					\
192
      XSETINT (i,  (EMACS_INT)(x));					\
193 194 195 196 197
    }									\
  while (0)
#define FLOAT_TO_INT2(x, i, name, num1, num2)				\
  do									\
    {									\
198 199
      if ((x) >= (((EMACS_INT) 1) << (VALBITS-1)) ||			\
	  (x) <= - (((EMACS_INT) 1) << (VALBITS-1)) - 1)		\
200
	range_error2 (name, num1, num2);				\
201
      XSETINT (i,  (EMACS_INT)(x));					\
202 203 204
    }									\
  while (0)

205 206 207 208
#define arith_error(op,arg) \
  Fsignal (Qarith_error, Fcons (build_string ((op)), Fcons ((arg), Qnil)))
#define range_error(op,arg) \
  Fsignal (Qrange_error, Fcons (build_string ((op)), Fcons ((arg), Qnil)))
209 210 211
#define range_error2(op,a1,a2) \
  Fsignal (Qrange_error, Fcons (build_string ((op)), \
				Fcons ((a1), Fcons ((a2), Qnil))))
212 213 214
#define domain_error(op,arg) \
  Fsignal (Qdomain_error, Fcons (build_string ((op)), Fcons ((arg), Qnil)))
#define domain_error2(op,a1,a2) \
215 216
  Fsignal (Qdomain_error, Fcons (build_string ((op)), \
				 Fcons ((a1), Fcons ((a2), Qnil))))
Mike Rowan's avatar
Mike Rowan committed
217 218 219 220 221 222 223 224 225

/* Extract a Lisp number as a `double', or signal an error.  */

double
extract_float (num)
     Lisp_Object num;
{
  CHECK_NUMBER_OR_FLOAT (num, 0);

226
  if (FLOATP (num))
Mike Rowan's avatar
Mike Rowan committed
227 228 229
    return XFLOAT (num)->data;
  return (double) XINT (num);
}
230 231

/* Trig functions.  */
Mike Rowan's avatar
Mike Rowan committed
232 233 234

DEFUN ("acos", Facos, Sacos, 1, 1, 0,
  "Return the inverse cosine of ARG.")
235 236
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
237
{
238 239 240 241 242 243
  double d = extract_float (arg);
#ifdef FLOAT_CHECK_DOMAIN
  if (d > 1.0 || d < -1.0)
    domain_error ("acos", arg);
#endif
  IN_FLOAT (d = acos (d), "acos", arg);
Mike Rowan's avatar
Mike Rowan committed
244 245 246
  return make_float (d);
}

247 248
DEFUN ("asin", Fasin, Sasin, 1, 1, 0,
  "Return the inverse sine of ARG.")
249 250
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
251
{
252 253 254 255 256 257
  double d = extract_float (arg);
#ifdef FLOAT_CHECK_DOMAIN
  if (d > 1.0 || d < -1.0)
    domain_error ("asin", arg);
#endif
  IN_FLOAT (d = asin (d), "asin", arg);
Mike Rowan's avatar
Mike Rowan committed
258 259 260
  return make_float (d);
}

261 262
DEFUN ("atan", Fatan, Satan, 1, 1, 0,
  "Return the inverse tangent of ARG.")
263 264
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
265
{
266 267
  double d = extract_float (arg);
  IN_FLOAT (d = atan (d), "atan", arg);
Mike Rowan's avatar
Mike Rowan committed
268 269 270
  return make_float (d);
}

271 272
DEFUN ("cos", Fcos, Scos, 1, 1, 0,
  "Return the cosine of ARG.")
273 274
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
275
{
276 277
  double d = extract_float (arg);
  IN_FLOAT (d = cos (d), "cos", arg);
Mike Rowan's avatar
Mike Rowan committed
278 279 280
  return make_float (d);
}

281 282
DEFUN ("sin", Fsin, Ssin, 1, 1, 0,
  "Return the sine of ARG.")
283 284
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
285
{
286 287
  double d = extract_float (arg);
  IN_FLOAT (d = sin (d), "sin", arg);
Mike Rowan's avatar
Mike Rowan committed
288 289 290
  return make_float (d);
}

291 292
DEFUN ("tan", Ftan, Stan, 1, 1, 0,
  "Return the tangent of ARG.")
293 294 295 296 297 298 299 300 301 302
  (arg)
     register Lisp_Object arg;
{
  double d = extract_float (arg);
  double c = cos (d);
#ifdef FLOAT_CHECK_DOMAIN
  if (c == 0.0)
    domain_error ("tan", arg);
#endif
  IN_FLOAT (d = sin (d) / c, "tan", arg);
Mike Rowan's avatar
Mike Rowan committed
303 304 305
  return make_float (d);
}

306 307
#if 0 /* Leave these out unless we find there's a reason for them.  */

Mike Rowan's avatar
Mike Rowan committed
308 309
DEFUN ("bessel-j0", Fbessel_j0, Sbessel_j0, 1, 1, 0,
  "Return the bessel function j0 of ARG.")
310 311
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
312
{
313 314
  double d = extract_float (arg);
  IN_FLOAT (d = j0 (d), "bessel-j0", arg);
Mike Rowan's avatar
Mike Rowan committed
315 316 317 318 319
  return make_float (d);
}

DEFUN ("bessel-j1", Fbessel_j1, Sbessel_j1, 1, 1, 0,
  "Return the bessel function j1 of ARG.")
320 321
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
322
{
323 324
  double d = extract_float (arg);
  IN_FLOAT (d = j1 (d), "bessel-j1", arg);
Mike Rowan's avatar
Mike Rowan committed
325 326 327 328 329 330
  return make_float (d);
}

DEFUN ("bessel-jn", Fbessel_jn, Sbessel_jn, 2, 2, 0,
  "Return the order N bessel function output jn of ARG.\n\
The first arg (the order) is truncated to an integer.")
331 332
  (n, arg)
     register Lisp_Object n, arg;
Mike Rowan's avatar
Mike Rowan committed
333
{
334 335
  int i1 = extract_float (n);
  double f2 = extract_float (arg);
Mike Rowan's avatar
Mike Rowan committed
336

337
  IN_FLOAT (f2 = jn (i1, f2), "bessel-jn", n);
Mike Rowan's avatar
Mike Rowan committed
338 339 340 341 342
  return make_float (f2);
}

DEFUN ("bessel-y0", Fbessel_y0, Sbessel_y0, 1, 1, 0,
  "Return the bessel function y0 of ARG.")
343 344
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
345
{
346 347
  double d = extract_float (arg);
  IN_FLOAT (d = y0 (d), "bessel-y0", arg);
Mike Rowan's avatar
Mike Rowan committed
348 349 350 351 352
  return make_float (d);
}

DEFUN ("bessel-y1", Fbessel_y1, Sbessel_y1, 1, 1, 0,
  "Return the bessel function y1 of ARG.")
353 354
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
355
{
356 357
  double d = extract_float (arg);
  IN_FLOAT (d = y1 (d), "bessel-y0", arg);
Mike Rowan's avatar
Mike Rowan committed
358 359 360 361 362 363
  return make_float (d);
}

DEFUN ("bessel-yn", Fbessel_yn, Sbessel_yn, 2, 2, 0,
  "Return the order N bessel function output yn of ARG.\n\
The first arg (the order) is truncated to an integer.")
364 365
  (n, arg)
     register Lisp_Object n, arg;
Mike Rowan's avatar
Mike Rowan committed
366
{
367 368
  int i1 = extract_float (n);
  double f2 = extract_float (arg);
Mike Rowan's avatar
Mike Rowan committed
369

370
  IN_FLOAT (f2 = yn (i1, f2), "bessel-yn", n);
Mike Rowan's avatar
Mike Rowan committed
371 372 373
  return make_float (f2);
}

374 375 376
#endif

#if 0 /* Leave these out unless we see they are worth having.  */
Mike Rowan's avatar
Mike Rowan committed
377 378 379

DEFUN ("erf", Ferf, Serf, 1, 1, 0,
  "Return the mathematical error function of ARG.")
380 381
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
382
{
383 384
  double d = extract_float (arg);
  IN_FLOAT (d = erf (d), "erf", arg);
Mike Rowan's avatar
Mike Rowan committed
385 386 387 388 389
  return make_float (d);
}

DEFUN ("erfc", Ferfc, Serfc, 1, 1, 0,
  "Return the complementary error function of ARG.")
390 391
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
392
{
393 394
  double d = extract_float (arg);
  IN_FLOAT (d = erfc (d), "erfc", arg);
Mike Rowan's avatar
Mike Rowan committed
395 396 397 398 399
  return make_float (d);
}

DEFUN ("log-gamma", Flog_gamma, Slog_gamma, 1, 1, 0,
  "Return the log gamma of ARG.")
400 401
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
402
{
403 404
  double d = extract_float (arg);
  IN_FLOAT (d = lgamma (d), "log-gamma", arg);
Mike Rowan's avatar
Mike Rowan committed
405 406 407
  return make_float (d);
}

408
DEFUN ("cube-root", Fcube_root, Scube_root, 1, 1, 0,
409
  "Return the cube root of ARG.")
410 411
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
412
{
413 414 415 416 417 418 419 420 421
  double d = extract_float (arg);
#ifdef HAVE_CBRT
  IN_FLOAT (d = cbrt (d), "cube-root", arg);
#else
  if (d >= 0.0)
    IN_FLOAT (d = pow (d, 1.0/3.0), "cube-root", arg);
  else
    IN_FLOAT (d = -pow (-d, 1.0/3.0), "cube-root", arg);
#endif
Mike Rowan's avatar
Mike Rowan committed
422 423 424
  return make_float (d);
}

Richard M. Stallman's avatar
Richard M. Stallman committed
425 426
#endif

427 428
DEFUN ("exp", Fexp, Sexp, 1, 1, 0,
  "Return the exponential base e of ARG.")
429 430 431 432 433 434 435 436 437 438 439 440
  (arg)
     register Lisp_Object arg;
{
  double d = extract_float (arg);
#ifdef FLOAT_CHECK_DOMAIN
  if (d > 709.7827)   /* Assume IEEE doubles here */
    range_error ("exp", arg);
  else if (d < -709.0)
    return make_float (0.0);
  else
#endif
    IN_FLOAT (d = exp (d), "exp", arg);
Mike Rowan's avatar
Mike Rowan committed
441 442 443 444
  return make_float (d);
}

DEFUN ("expt", Fexpt, Sexpt, 2, 2, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
445
  "Return the exponential ARG1 ** ARG2.")
446 447
  (arg1, arg2)
     register Lisp_Object arg1, arg2;
Mike Rowan's avatar
Mike Rowan committed
448 449 450
{
  double f1, f2;

451 452
  CHECK_NUMBER_OR_FLOAT (arg1, 0);
  CHECK_NUMBER_OR_FLOAT (arg2, 0);
453 454
  if (INTEGERP (arg1)     /* common lisp spec */
      && INTEGERP (arg2)) /* don't promote, if both are ints */
Mike Rowan's avatar
Mike Rowan committed
455
    {				/* this can be improved by pre-calculating */
456
      EMACS_INT acc, x, y;	/* some binary powers of x then accumulating */
457 458
      Lisp_Object val;

459 460
      x = XINT (arg1);
      y = XINT (arg2);
Mike Rowan's avatar
Mike Rowan committed
461 462 463 464
      acc = 1;
      
      if (y < 0)
	{
465 466 467 468 469 470
	  if (x == 1)
	    acc = 1;
	  else if (x == -1)
	    acc = (y & 1) ? -1 : 1;
	  else
	    acc = 0;
Mike Rowan's avatar
Mike Rowan committed
471 472 473
	}
      else
	{
474 475 476 477 478 479 480
	  while (y > 0)
	    {
	      if (y & 1)
		acc *= x;
	      x *= x;
	      y = (unsigned)y >> 1;
	    }
Mike Rowan's avatar
Mike Rowan committed
481
	}
482
      XSETINT (val, acc);
483
      return val;
Mike Rowan's avatar
Mike Rowan committed
484
    }
485 486
  f1 = FLOATP (arg1) ? XFLOAT (arg1)->data : XINT (arg1);
  f2 = FLOATP (arg2) ? XFLOAT (arg2)->data : XINT (arg2);
487 488 489 490 491 492 493
  /* Really should check for overflow, too */
  if (f1 == 0.0 && f2 == 0.0)
    f1 = 1.0;
#ifdef FLOAT_CHECK_DOMAIN
  else if ((f1 == 0.0 && f2 < 0.0) || (f1 < 0 && f2 != floor(f2)))
    domain_error2 ("expt", arg1, arg2);
#endif
Richard M. Stallman's avatar
Richard M. Stallman committed
494
  IN_FLOAT2 (f1 = pow (f1, f2), "expt", arg1, arg2);
Mike Rowan's avatar
Mike Rowan committed
495 496
  return make_float (f1);
}
497

498
DEFUN ("log", Flog, Slog, 1, 2, 0,
499 500 501 502
  "Return the natural logarithm of ARG.\n\
If second optional argument BASE is given, return log ARG using that base.")
  (arg, base)
     register Lisp_Object arg, base;
Mike Rowan's avatar
Mike Rowan committed
503
{
504
  double d = extract_float (arg);
505

506 507 508 509
#ifdef FLOAT_CHECK_DOMAIN
  if (d <= 0.0)
    domain_error2 ("log", arg, base);
#endif
510
  if (NILP (base))
511
    IN_FLOAT (d = log (d), "log", arg);
512 513 514 515
  else
    {
      double b = extract_float (base);

516 517 518 519 520 521 522
#ifdef FLOAT_CHECK_DOMAIN
      if (b <= 0.0 || b == 1.0)
	domain_error2 ("log", arg, base);
#endif
      if (b == 10.0)
	IN_FLOAT2 (d = log10 (d), "log", arg, base);
      else
523
	IN_FLOAT2 (d = log (d) / log (b), "log", arg, base);
524
    }
Mike Rowan's avatar
Mike Rowan committed
525 526 527
  return make_float (d);
}

528 529
DEFUN ("log10", Flog10, Slog10, 1, 1, 0,
  "Return the logarithm base 10 of ARG.")
530 531
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
532
{
533 534 535 536 537 538
  double d = extract_float (arg);
#ifdef FLOAT_CHECK_DOMAIN
  if (d <= 0.0)
    domain_error ("log10", arg);
#endif
  IN_FLOAT (d = log10 (d), "log10", arg);
539 540 541
  return make_float (d);
}

Mike Rowan's avatar
Mike Rowan committed
542 543
DEFUN ("sqrt", Fsqrt, Ssqrt, 1, 1, 0,
  "Return the square root of ARG.")
544 545
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
546
{
547 548 549 550 551 552
  double d = extract_float (arg);
#ifdef FLOAT_CHECK_DOMAIN
  if (d < 0.0)
    domain_error ("sqrt", arg);
#endif
  IN_FLOAT (d = sqrt (d), "sqrt", arg);
Mike Rowan's avatar
Mike Rowan committed
553 554
  return make_float (d);
}
555

Richard M. Stallman's avatar
Richard M. Stallman committed
556
#if 0 /* Not clearly worth adding.  */
Mike Rowan's avatar
Mike Rowan committed
557

558 559
DEFUN ("acosh", Facosh, Sacosh, 1, 1, 0,
  "Return the inverse hyperbolic cosine of ARG.")
560 561
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
562
{
563 564 565 566 567 568 569 570 571 572
  double d = extract_float (arg);
#ifdef FLOAT_CHECK_DOMAIN
  if (d < 1.0)
    domain_error ("acosh", arg);
#endif
#ifdef HAVE_INVERSE_HYPERBOLIC
  IN_FLOAT (d = acosh (d), "acosh", arg);
#else
  IN_FLOAT (d = log (d + sqrt (d*d - 1.0)), "acosh", arg);
#endif
573 574 575 576 577
  return make_float (d);
}

DEFUN ("asinh", Fasinh, Sasinh, 1, 1, 0,
  "Return the inverse hyperbolic sine of ARG.")
578 579
  (arg)
     register Lisp_Object arg;
580
{
581 582 583 584 585 586
  double d = extract_float (arg);
#ifdef HAVE_INVERSE_HYPERBOLIC
  IN_FLOAT (d = asinh (d), "asinh", arg);
#else
  IN_FLOAT (d = log (d + sqrt (d*d + 1.0)), "asinh", arg);
#endif
587 588 589 590 591
  return make_float (d);
}

DEFUN ("atanh", Fatanh, Satanh, 1, 1, 0,
  "Return the inverse hyperbolic tangent of ARG.")
592 593
  (arg)
     register Lisp_Object arg;
594
{
595 596 597 598 599 600 601 602 603 604
  double d = extract_float (arg);
#ifdef FLOAT_CHECK_DOMAIN
  if (d >= 1.0 || d <= -1.0)
    domain_error ("atanh", arg);
#endif
#ifdef HAVE_INVERSE_HYPERBOLIC
  IN_FLOAT (d = atanh (d), "atanh", arg);
#else
  IN_FLOAT (d = 0.5 * log ((1.0 + d) / (1.0 - d)), "atanh", arg);
#endif
605 606 607 608 609
  return make_float (d);
}

DEFUN ("cosh", Fcosh, Scosh, 1, 1, 0,
  "Return the hyperbolic cosine of ARG.")
610 611
  (arg)
     register Lisp_Object arg;
612
{
613 614 615 616 617 618
  double d = extract_float (arg);
#ifdef FLOAT_CHECK_DOMAIN
  if (d > 710.0 || d < -710.0)
    range_error ("cosh", arg);
#endif
  IN_FLOAT (d = cosh (d), "cosh", arg);
619 620 621 622 623
  return make_float (d);
}

DEFUN ("sinh", Fsinh, Ssinh, 1, 1, 0,
  "Return the hyperbolic sine of ARG.")
624 625
  (arg)
     register Lisp_Object arg;
626
{
627 628 629 630 631 632
  double d = extract_float (arg);
#ifdef FLOAT_CHECK_DOMAIN
  if (d > 710.0 || d < -710.0)
    range_error ("sinh", arg);
#endif
  IN_FLOAT (d = sinh (d), "sinh", arg);
Mike Rowan's avatar
Mike Rowan committed
633 634 635 636 637
  return make_float (d);
}

DEFUN ("tanh", Ftanh, Stanh, 1, 1, 0,
  "Return the hyperbolic tangent of ARG.")
638 639
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
640
{
641 642
  double d = extract_float (arg);
  IN_FLOAT (d = tanh (d), "tanh", arg);
Mike Rowan's avatar
Mike Rowan committed
643 644
  return make_float (d);
}
645
#endif
Mike Rowan's avatar
Mike Rowan committed
646 647 648

DEFUN ("abs", Fabs, Sabs, 1, 1, 0,
  "Return the absolute value of ARG.")
649 650
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
651
{
652
  CHECK_NUMBER_OR_FLOAT (arg, 0);
Mike Rowan's avatar
Mike Rowan committed
653

654
  if (FLOATP (arg))
655 656
    IN_FLOAT (arg = make_float (fabs (XFLOAT (arg)->data)), "abs", arg);
  else if (XINT (arg) < 0)
657
    XSETINT (arg, - XINT (arg));
Mike Rowan's avatar
Mike Rowan committed
658

659
  return arg;
Mike Rowan's avatar
Mike Rowan committed
660 661 662 663
}

DEFUN ("float", Ffloat, Sfloat, 1, 1, 0,
  "Return the floating point number equal to ARG.")
664 665
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
666
{
667
  CHECK_NUMBER_OR_FLOAT (arg, 0);
Mike Rowan's avatar
Mike Rowan committed
668

669
  if (INTEGERP (arg))
670
    return make_float ((double) XINT (arg));
Mike Rowan's avatar
Mike Rowan committed
671
  else				/* give 'em the same float back */
672
    return arg;
Mike Rowan's avatar
Mike Rowan committed
673 674 675
}

DEFUN ("logb", Flogb, Slogb, 1, 1, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
676
  "Returns largest integer <= the base 2 log of the magnitude of ARG.\n\
Mike Rowan's avatar
Mike Rowan committed
677
This is the same as the exponent of a float.")
678 679
     (arg)
     Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
680
{
681
  Lisp_Object val;
682
  EMACS_INT value;
683
  double f = extract_float (arg);
684

685 686 687 688
  if (f == 0.0)
    value = -(VALMASK >> 1);
  else
    {
689
#ifdef HAVE_LOGB
690
      IN_FLOAT (value = logb (f), "logb", arg);
691 692
#else
#ifdef HAVE_FREXP
693 694 695
      int ivalue;
      IN_FLOAT (frexp (f, &ivalue), "logb", arg);
      value = ivalue - 1;
696
#else
697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715
      int i;
      double d;
      if (f < 0.0)
	f = -f;
      value = -1;
      while (f < 0.5)
	{
	  for (i = 1, d = 0.5; d * d >= f; i += i)
	    d *= d;
	  f /= d;
	  value -= i;
	}
      while (f >= 1.0)
	{
	  for (i = 1, d = 2.0; d * d <= f; i += i)
	    d *= d;
	  f /= d;
	  value += i;
	}
716
#endif
717
#endif
718
    }
719
  XSETINT (val, value);
720
  return val;
Mike Rowan's avatar
Mike Rowan committed
721 722
}

723 724 725
#endif /* LISP_FLOAT_TYPE */


726 727 728 729
/* the rounding functions  */

static Lisp_Object
rounding_driver (arg, divisor, double_round, int_round2, name)
730
     register Lisp_Object arg, divisor;
731 732 733
     double (*double_round) ();
     EMACS_INT (*int_round2) ();
     char *name;
Mike Rowan's avatar
Mike Rowan committed
734
{
735
  CHECK_NUMBER_OR_FLOAT (arg, 0);
Mike Rowan's avatar
Mike Rowan committed
736

737 738
  if (! NILP (divisor))
    {
739
      EMACS_INT i1, i2;
740 741 742 743

      CHECK_NUMBER_OR_FLOAT (divisor, 1);

#ifdef LISP_FLOAT_TYPE
744
      if (FLOATP (arg) || FLOATP (divisor))
745 746 747
	{
	  double f1, f2;

748 749
	  f1 = FLOATP (arg) ? XFLOAT (arg)->data : XINT (arg);
	  f2 = (FLOATP (divisor) ? XFLOAT (divisor)->data : XINT (divisor));
750
	  if (! IEEE_FLOATING_POINT && f2 == 0)
751 752
	    Fsignal (Qarith_error, Qnil);

753 754
	  IN_FLOAT2 (f1 = (*double_round) (f1 / f2), name, arg, divisor);
	  FLOAT_TO_INT2 (f1, arg, name, arg, divisor);
755 756 757 758 759 760 761 762 763 764
	  return arg;
	}
#endif

      i1 = XINT (arg);
      i2 = XINT (divisor);

      if (i2 == 0)
	Fsignal (Qarith_error, Qnil);

765
      XSETINT (arg, (*int_round2) (i1, i2));
766 767 768 769
      return arg;
    }

#ifdef LISP_FLOAT_TYPE
770
  if (FLOATP (arg))
771 772
    {
      double d;
773 774 775

      IN_FLOAT (d = (*double_round) (XFLOAT (arg)->data), name, arg);
      FLOAT_TO_INT (d, arg, name, arg);
776
    }
777
#endif
Mike Rowan's avatar
Mike Rowan committed
778

779
  return arg;
Mike Rowan's avatar
Mike Rowan committed
780 781
}

782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828
/* With C's /, the result is implementation-defined if either operand
   is negative, so take care with negative operands in the following
   integer functions.  */

static EMACS_INT
ceiling2 (i1, i2)
     EMACS_INT i1, i2;
{
  return (i2 < 0
	  ? (i1 < 0  ?  ((-1 - i1) / -i2) + 1  :  - (i1 / -i2))
	  : (i1 <= 0  ?  - (-i1 / i2)  :  ((i1 - 1) / i2) + 1));
}

static EMACS_INT
floor2 (i1, i2)
     EMACS_INT i1, i2;
{
  return (i2 < 0
	  ? (i1 <= 0  ?  -i1 / -i2  :  -1 - ((i1 - 1) / -i2))
	  : (i1 < 0  ?  -1 - ((-1 - i1) / i2)  :  i1 / i2));
}

static EMACS_INT
truncate2 (i1, i2)
     EMACS_INT i1, i2;
{
  return (i2 < 0
	  ? (i1 < 0  ?  -i1 / -i2  :  - (i1 / -i2))
	  : (i1 < 0  ?  - (-i1 / i2)  :  i1 / i2));
}

static EMACS_INT
round2 (i1, i2)
     EMACS_INT i1, i2;
{
  /* The C language's division operator gives us one remainder R, but
     we want the remainder R1 on the other side of 0 if R1 is closer
     to 0 than R is; because we want to round to even, we also want R1
     if R and R1 are the same distance from 0 and if C's quotient is
     odd.  */
  EMACS_INT q = i1 / i2;
  EMACS_INT r = i1 % i2;
  EMACS_INT abs_r = r < 0 ? -r : r;
  EMACS_INT abs_r1 = (i2 < 0 ? -i2 : i2) - abs_r;
  return q + (abs_r + (q & 1) <= abs_r1 ? 0 : (i2 ^ r) < 0 ? -1 : 1);
}

829 830 831 832 833
/* The code uses emacs_rint, so that it works to undefine HAVE_RINT
   if `rint' exists but does not work right.  */
#ifdef HAVE_RINT
#define emacs_rint rint
#else
834
static double
835
emacs_rint (d)
836 837
     double d;
{
Richard M. Stallman's avatar
Richard M. Stallman committed
838
  return floor (d + 0.5);
839 840 841
}
#endif

842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872
static double
double_identity (d)
     double d;
{
  return d;
}

DEFUN ("ceiling", Fceiling, Sceiling, 1, 2, 0,
  "Return the smallest integer no less than ARG.  (Round toward +inf.)\n\
With optional DIVISOR, return the smallest integer no less than ARG/DIVISOR.")
  (arg, divisor)
     Lisp_Object arg, divisor;
{
  return rounding_driver (arg, divisor, ceil, ceiling2, "ceiling");
}

DEFUN ("floor", Ffloor, Sfloor, 1, 2, 0,
  "Return the largest integer no greater than ARG.  (Round towards -inf.)\n\
With optional DIVISOR, return the largest integer no greater than ARG/DIVISOR.")
  (arg, divisor)
     Lisp_Object arg, divisor;
{
  return rounding_driver (arg, divisor, floor, floor2, "floor");
}

DEFUN ("round", Fround, Sround, 1, 2, 0,
  "Return the nearest integer to ARG.\n\
With optional DIVISOR, return the nearest integer to ARG/DIVISOR.")
  (arg, divisor)
     Lisp_Object arg, divisor;
{
873
  return rounding_driver (arg, divisor, emacs_rint, round2, "round");
874 875 876 877 878 879 880 881 882 883 884 885 886
}

DEFUN ("truncate", Ftruncate, Struncate, 1, 2, 0,
       "Truncate a floating point number to an int.\n\
Rounds ARG toward zero.\n\
With optional DIVISOR, truncate ARG/DIVISOR.")
  (arg, divisor)
     Lisp_Object arg, divisor;
{
  return rounding_driver (arg, divisor, double_identity, truncate2,
			  "truncate");
}

887 888
#ifdef LISP_FLOAT_TYPE

889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906
Lisp_Object
fmod_float (x, y)
     register Lisp_Object x, y;
{
  double f1, f2;

  f1 = FLOATP (x) ? XFLOAT (x)->data : XINT (x);
  f2 = FLOATP (y) ? XFLOAT (y)->data : XINT (y);

  if (! IEEE_FLOATING_POINT && f2 == 0)
    Fsignal (Qarith_error, Qnil);

  /* If the "remainder" comes out with the wrong sign, fix it.  */
  IN_FLOAT2 ((f1 = fmod (f1, f2),
	      f1 = (f2 < 0 ? f1 > 0 : f1 < 0) ? f1 + f2 : f1),
	     "mod", x, y);
  return make_float (f1);
}
907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930

/* It's not clear these are worth adding.  */

DEFUN ("fceiling", Ffceiling, Sfceiling, 1, 1, 0,
  "Return the smallest integer no less than ARG, as a float.\n\
\(Round toward +inf.\)")
  (arg)
     register Lisp_Object arg;
{
  double d = extract_float (arg);
  IN_FLOAT (d = ceil (d), "fceiling", arg);
  return make_float (d);
}

DEFUN ("ffloor", Fffloor, Sffloor, 1, 1, 0,
  "Return the largest integer no greater than ARG, as a float.\n\
\(Round towards -inf.\)")
  (arg)
     register Lisp_Object arg;
{
  double d = extract_float (arg);
  IN_FLOAT (d = floor (d), "ffloor", arg);
  return make_float (d);
}
Mike Rowan's avatar
Mike Rowan committed
931

932 933 934 935 936 937
DEFUN ("fround", Ffround, Sfround, 1, 1, 0,
  "Return the nearest integer to ARG, as a float.")
  (arg)
     register Lisp_Object arg;
{
  double d = extract_float (arg);
938
  IN_FLOAT (d = emacs_rint (d), "fround", arg);
939 940 941 942
  return make_float (d);
}

DEFUN ("ftruncate", Fftruncate, Sftruncate, 1, 1, 0,
943
  "Truncate a floating point number to an integral float value.\n\
944 945 946 947 948 949 950 951
Rounds the value toward zero.")
  (arg)
     register Lisp_Object arg;
{
  double d = extract_float (arg);
  if (d >= 0.0)
    IN_FLOAT (d = floor (d), "ftruncate", arg);
  else
952
    IN_FLOAT (d = ceil (d), "ftruncate", arg);
953
  return make_float (d);
Mike Rowan's avatar
Mike Rowan committed
954 955
}

956
#ifdef FLOAT_CATCH_SIGILL
Jim Blandy's avatar
Jim Blandy committed
957
static SIGTYPE
Mike Rowan's avatar
Mike Rowan committed
958 959 960 961 962 963
float_error (signo)
     int signo;
{
  if (! in_float)
    fatal_error_signal (signo);

964
#ifdef BSD_SYSTEM
Mike Rowan's avatar
Mike Rowan committed
965 966 967
#ifdef BSD4_1
  sigrelse (SIGILL);
#else /* not BSD4_1 */
Jim Blandy's avatar
Jim Blandy committed
968
  sigsetmask (SIGEMPTYMASK);
Mike Rowan's avatar
Mike Rowan committed
969
#endif /* not BSD4_1 */
Jim Blandy's avatar
Jim Blandy committed
970 971 972
#else
  /* Must reestablish handler each time it is called.  */
  signal (SIGILL, float_error);
973
#endif /* BSD_SYSTEM */
Mike Rowan's avatar
Mike Rowan committed
974 975 976 977 978 979

  in_float = 0;

  Fsignal (Qarith_error, Fcons (float_error_arg, Qnil));
}

980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
/* Another idea was to replace the library function `infnan'
   where SIGILL is signaled.  */

#endif /* FLOAT_CATCH_SIGILL */

#ifdef HAVE_MATHERR
int 
matherr (x)
     struct exception *x;
{
  Lisp_Object args;
  if (! in_float)
    /* Not called from emacs-lisp float routines; do the default thing. */
    return 0;
  if (!strcmp (x->name, "pow"))
    x->name = "expt";

  args
    = Fcons (build_string (x->name),
	     Fcons (make_float (x->arg1),
		    ((!strcmp (x->name, "log") || !strcmp (x->name, "pow"))
		     ? Fcons (make_float (x->arg2), Qnil)
		     : Qnil)));
  switch (x->type)
    {
    case DOMAIN:	Fsignal (Qdomain_error, args);		break;
    case SING:		Fsignal (Qsingularity_error, args);	break;
    case OVERFLOW:	Fsignal (Qoverflow_error, args);	break;
    case UNDERFLOW:	Fsignal (Qunderflow_error, args);	break;
    default:		Fsignal (Qarith_error, args);		break;
    }
  return (1);	/* don't set errno or print a message */
}
#endif /* HAVE_MATHERR */

Mike Rowan's avatar
Mike Rowan committed
1015 1016
init_floatfns ()
{
1017
#ifdef FLOAT_CATCH_SIGILL
Mike Rowan's avatar
Mike Rowan committed
1018
  signal (SIGILL, float_error);
1019
#endif 
Mike Rowan's avatar
Mike Rowan committed
1020 1021 1022
  in_float = 0;
}

1023 1024 1025 1026 1027 1028 1029
#else /* not LISP_FLOAT_TYPE */

init_floatfns ()
{}

#endif /* not LISP_FLOAT_TYPE */

Mike Rowan's avatar
Mike Rowan committed
1030 1031
syms_of_floatfns ()
{
1032
#ifdef LISP_FLOAT_TYPE
Mike Rowan's avatar
Mike Rowan committed
1033 1034 1035
  defsubr (&Sacos);
  defsubr (&Sasin);
  defsubr (&Satan);
1036 1037 1038 1039 1040 1041
  defsubr (&Scos);
  defsubr (&Ssin);
  defsubr (&Stan);
#if 0
  defsubr (&Sacosh);
  defsubr (&Sasinh);
Mike Rowan's avatar
Mike Rowan committed
1042
  defsubr (&Satanh);
1043 1044 1045
  defsubr (&Scosh);
  defsubr (&Ssinh);
  defsubr (&Stanh);
Mike Rowan's avatar
Mike Rowan committed
1046 1047 1048 1049 1050 1051 1052 1053
  defsubr (&Sbessel_y0);
  defsubr (&Sbessel_y1);
  defsubr (&Sbessel_yn);
  defsubr (&Sbessel_j0);
  defsubr (&Sbessel_j1);
  defsubr (&Sbessel_jn);
  defsubr (&Serf);
  defsubr (&Serfc);
1054
  defsubr (&Slog_gamma);
1055
  defsubr (&Scube_root);
1056
#endif
1057 1058 1059 1060
  defsubr (&Sfceiling);
  defsubr (&Sffloor);
  defsubr (&Sfround);
  defsubr (&Sftruncate);
Mike Rowan's avatar
Mike Rowan committed
1061
  defsubr (&Sexp);
1062
  defsubr (&Sexpt);
Mike Rowan's avatar
Mike Rowan committed
1063 1064 1065 1066 1067 1068 1069
  defsubr (&Slog);
  defsubr (&Slog10);
  defsubr (&Ssqrt);

  defsubr (&Sabs);
  defsubr (&Sfloat);
  defsubr (&Slogb);
1070
#endif /* LISP_FLOAT_TYPE */
Mike Rowan's avatar
Mike Rowan committed
1071
  defsubr (&Sceiling);
1072
  defsubr (&Sfloor);
Mike Rowan's avatar
Mike Rowan committed
1073 1074 1075
  defsubr (&Sround);
  defsubr (&Struncate);
}