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

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
9
the Free Software Foundation; either version 2, or (at your option)
Mike Rowan's avatar
Mike Rowan committed
10 11 12 13 14 15 16 17 18
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
Lute Kamstra's avatar
Lute Kamstra committed
19 20
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */
Mike Rowan's avatar
Mike Rowan committed
21 22


23 24 25 26 27 28
/* 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.
29
   Define HAVE_RINT if you have a working rint.
30 31 32 33 34 35 36 37 38 39 40 41
   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
42
   either setting errno, or signaling SIGFPE/SIGILL.  Otherwise, domain and
43 44 45 46 47
   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.)
 */

48
#include <config.h>
49
#include <signal.h>
50 51 52
#include "lisp.h"
#include "syssignal.h"

53 54 55 56
#if STDC_HEADERS
#include <float.h>
#endif

57 58 59 60 61 62 63 64 65 66
/* 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

67 68 69 70 71 72 73 74 75 76
/* 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
77
#include <math.h>
78

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

84 85 86 87 88 89 90
#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
91
#ifdef NO_MATHERR
92 93 94
#undef HAVE_MATHERR
#endif

95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
#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
110

111
#ifndef USE_CRT_DLL
Jim Blandy's avatar
Jim Blandy committed
112
extern int errno;
113
#endif
114
#endif
Jim Blandy's avatar
Jim Blandy committed
115 116 117 118 119 120 121 122 123 124 125

/* 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 */

126
#ifdef FLOAT_CATCH_SIGILL
Jim Blandy's avatar
Jim Blandy committed
127
static SIGTYPE float_error ();
128
#endif
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
      if (FIXNUM_OVERFLOW_P (x))					\
190
	range_error (name, num);					\
191
      XSETINT (i,  (EMACS_INT)(x));					\
192 193 194 195 196
    }									\
  while (0)
#define FLOAT_TO_INT2(x, i, name, num1, num2)				\
  do									\
    {									\
197
      if (FIXNUM_OVERFLOW_P (x))					\
198
	range_error2 (name, num1, num2);				\
199
      XSETINT (i,  (EMACS_INT)(x));					\
200 201 202
    }									\
  while (0)

203 204 205 206
#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)))
207 208 209
#define range_error2(op,a1,a2) \
  Fsignal (Qrange_error, Fcons (build_string ((op)), \
				Fcons ((a1), Fcons ((a2), Qnil))))
210 211 212
#define domain_error(op,arg) \
  Fsignal (Qdomain_error, Fcons (build_string ((op)), Fcons ((arg), Qnil)))
#define domain_error2(op,a1,a2) \
213 214
  Fsignal (Qdomain_error, Fcons (build_string ((op)), \
				 Fcons ((a1), Fcons ((a2), Qnil))))
Mike Rowan's avatar
Mike Rowan committed
215 216 217 218 219 220 221

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

double
extract_float (num)
     Lisp_Object num;
{
222
  CHECK_NUMBER_OR_FLOAT (num);
Mike Rowan's avatar
Mike Rowan committed
223

224
  if (FLOATP (num))
225
    return XFLOAT_DATA (num);
Mike Rowan's avatar
Mike Rowan committed
226 227
  return (double) XINT (num);
}
228 229

/* Trig functions.  */
Mike Rowan's avatar
Mike Rowan committed
230 231

DEFUN ("acos", Facos, Sacos, 1, 1, 0,
232 233
       doc: /* Return the inverse cosine of ARG.  */)
     (arg)
234
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
235
{
236 237 238 239 240 241
  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
242 243 244
  return make_float (d);
}

245
DEFUN ("asin", Fasin, Sasin, 1, 1, 0,
246 247
       doc: /* Return the inverse sine of ARG.  */)
     (arg)
248
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
249
{
250 251 252 253 254 255
  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
256 257 258
  return make_float (d);
}

259 260 261 262 263 264 265 266
DEFUN ("atan", Fatan, Satan, 1, 2, 0,
       doc: /* Return the inverse tangent of the arguments.
If only one argument Y is given, return the inverse tangent of Y.
If two arguments Y and X are given, return the inverse tangent of Y
divided by X, i.e. the angle in radians between the vector (X, Y)
and the x-axis.  */)
     (y, x)
     register Lisp_Object y, x;
Mike Rowan's avatar
Mike Rowan committed
267
{
268 269 270 271 272 273 274 275 276 277
  double d = extract_float (y);

  if (NILP (x))
    IN_FLOAT (d = atan (d), "atan", y);
  else
    {
      double d2 = extract_float (x);

      IN_FLOAT2 (d = atan2 (d, d2), "atan", y, x);
    }
Mike Rowan's avatar
Mike Rowan committed
278 279 280
  return make_float (d);
}

281
DEFUN ("cos", Fcos, Scos, 1, 1, 0,
282 283
       doc: /* Return the cosine of ARG.  */)
     (arg)
284
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
285
{
286 287
  double d = extract_float (arg);
  IN_FLOAT (d = cos (d), "cos", arg);
Mike Rowan's avatar
Mike Rowan committed
288 289 290
  return make_float (d);
}

291
DEFUN ("sin", Fsin, Ssin, 1, 1, 0,
292 293
       doc: /* Return the sine of ARG.  */)
     (arg)
294
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
295
{
296 297
  double d = extract_float (arg);
  IN_FLOAT (d = sin (d), "sin", arg);
Mike Rowan's avatar
Mike Rowan committed
298 299 300
  return make_float (d);
}

301
DEFUN ("tan", Ftan, Stan, 1, 1, 0,
302 303
       doc: /* Return the tangent of ARG.  */)
     (arg)
304 305 306 307 308 309 310 311 312
     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
313 314 315
  return make_float (d);
}

316 317
#if 0 /* Leave these out unless we find there's a reason for them.  */

Mike Rowan's avatar
Mike Rowan committed
318
DEFUN ("bessel-j0", Fbessel_j0, Sbessel_j0, 1, 1, 0,
319 320
       doc: /* Return the bessel function j0 of ARG.  */)
     (arg)
321
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
322
{
323 324
  double d = extract_float (arg);
  IN_FLOAT (d = j0 (d), "bessel-j0", arg);
Mike Rowan's avatar
Mike Rowan committed
325 326 327 328
  return make_float (d);
}

DEFUN ("bessel-j1", Fbessel_j1, Sbessel_j1, 1, 1, 0,
329 330
       doc: /* Return the bessel function j1 of ARG.  */)
     (arg)
331
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
332
{
333 334
  double d = extract_float (arg);
  IN_FLOAT (d = j1 (d), "bessel-j1", arg);
Mike Rowan's avatar
Mike Rowan committed
335 336 337 338
  return make_float (d);
}

DEFUN ("bessel-jn", Fbessel_jn, Sbessel_jn, 2, 2, 0,
339 340 341
       doc: /* Return the order N bessel function output jn of ARG.
The first arg (the order) is truncated to an integer.  */)
     (n, arg)
342
     register Lisp_Object n, arg;
Mike Rowan's avatar
Mike Rowan committed
343
{
344 345
  int i1 = extract_float (n);
  double f2 = extract_float (arg);
Mike Rowan's avatar
Mike Rowan committed
346

347
  IN_FLOAT (f2 = jn (i1, f2), "bessel-jn", n);
Mike Rowan's avatar
Mike Rowan committed
348 349 350 351
  return make_float (f2);
}

DEFUN ("bessel-y0", Fbessel_y0, Sbessel_y0, 1, 1, 0,
352 353
       doc: /* Return the bessel function y0 of ARG.  */)
     (arg)
354
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
355
{
356 357
  double d = extract_float (arg);
  IN_FLOAT (d = y0 (d), "bessel-y0", arg);
Mike Rowan's avatar
Mike Rowan committed
358 359 360 361
  return make_float (d);
}

DEFUN ("bessel-y1", Fbessel_y1, Sbessel_y1, 1, 1, 0,
362 363
       doc: /* Return the bessel function y1 of ARG.  */)
     (arg)
364
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
365
{
366 367
  double d = extract_float (arg);
  IN_FLOAT (d = y1 (d), "bessel-y0", arg);
Mike Rowan's avatar
Mike Rowan committed
368 369 370 371
  return make_float (d);
}

DEFUN ("bessel-yn", Fbessel_yn, Sbessel_yn, 2, 2, 0,
372 373 374
       doc: /* Return the order N bessel function output yn of ARG.
The first arg (the order) is truncated to an integer.  */)
     (n, arg)
375
     register Lisp_Object n, arg;
Mike Rowan's avatar
Mike Rowan committed
376
{
377 378
  int i1 = extract_float (n);
  double f2 = extract_float (arg);
Mike Rowan's avatar
Mike Rowan committed
379

380
  IN_FLOAT (f2 = yn (i1, f2), "bessel-yn", n);
Mike Rowan's avatar
Mike Rowan committed
381 382 383
  return make_float (f2);
}

384 385 386
#endif

#if 0 /* Leave these out unless we see they are worth having.  */
Mike Rowan's avatar
Mike Rowan committed
387 388

DEFUN ("erf", Ferf, Serf, 1, 1, 0,
389 390
       doc: /* Return the mathematical error function of ARG.  */)
     (arg)
391
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
392
{
393 394
  double d = extract_float (arg);
  IN_FLOAT (d = erf (d), "erf", arg);
Mike Rowan's avatar
Mike Rowan committed
395 396 397 398
  return make_float (d);
}

DEFUN ("erfc", Ferfc, Serfc, 1, 1, 0,
399 400
       doc: /* Return the complementary error function of ARG.  */)
     (arg)
401
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
402
{
403 404
  double d = extract_float (arg);
  IN_FLOAT (d = erfc (d), "erfc", arg);
Mike Rowan's avatar
Mike Rowan committed
405 406 407 408
  return make_float (d);
}

DEFUN ("log-gamma", Flog_gamma, Slog_gamma, 1, 1, 0,
409 410
       doc: /* Return the log gamma of ARG.  */)
     (arg)
411
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
412
{
413 414
  double d = extract_float (arg);
  IN_FLOAT (d = lgamma (d), "log-gamma", arg);
Mike Rowan's avatar
Mike Rowan committed
415 416 417
  return make_float (d);
}

418
DEFUN ("cube-root", Fcube_root, Scube_root, 1, 1, 0,
419 420
       doc: /* Return the cube root of ARG.  */)
     (arg)
421
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
422
{
423 424 425 426 427 428 429 430 431
  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
432 433 434
  return make_float (d);
}

Richard M. Stallman's avatar
Richard M. Stallman committed
435 436
#endif

437
DEFUN ("exp", Fexp, Sexp, 1, 1, 0,
438 439
       doc: /* Return the exponential base e of ARG.  */)
     (arg)
440 441 442 443 444 445 446 447 448 449 450
     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
451 452 453 454
  return make_float (d);
}

DEFUN ("expt", Fexpt, Sexpt, 2, 2, 0,
455 456
       doc: /* Return the exponential ARG1 ** ARG2.  */)
     (arg1, arg2)
457
     register Lisp_Object arg1, arg2;
Mike Rowan's avatar
Mike Rowan committed
458 459 460
{
  double f1, f2;

461 462
  CHECK_NUMBER_OR_FLOAT (arg1);
  CHECK_NUMBER_OR_FLOAT (arg2);
463
  if (INTEGERP (arg1)     /* common lisp spec */
464 465
      && INTEGERP (arg2)   /* don't promote, if both are ints, and */
      && 0 <= XINT (arg2)) /* we are sure the result is not fractional */
Mike Rowan's avatar
Mike Rowan committed
466
    {				/* this can be improved by pre-calculating */
467
      EMACS_INT acc, x, y;	/* some binary powers of x then accumulating */
468 469
      Lisp_Object val;

470 471
      x = XINT (arg1);
      y = XINT (arg2);
Mike Rowan's avatar
Mike Rowan committed
472
      acc = 1;
473

Mike Rowan's avatar
Mike Rowan committed
474 475
      if (y < 0)
	{
476 477 478 479 480 481
	  if (x == 1)
	    acc = 1;
	  else if (x == -1)
	    acc = (y & 1) ? -1 : 1;
	  else
	    acc = 0;
Mike Rowan's avatar
Mike Rowan committed
482 483 484
	}
      else
	{
485 486 487 488 489 490 491
	  while (y > 0)
	    {
	      if (y & 1)
		acc *= x;
	      x *= x;
	      y = (unsigned)y >> 1;
	    }
Mike Rowan's avatar
Mike Rowan committed
492
	}
493
      XSETINT (val, acc);
494
      return val;
Mike Rowan's avatar
Mike Rowan committed
495
    }
496 497
  f1 = FLOATP (arg1) ? XFLOAT_DATA (arg1) : XINT (arg1);
  f2 = FLOATP (arg2) ? XFLOAT_DATA (arg2) : XINT (arg2);
498 499 500 501 502 503 504
  /* 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
505
  IN_FLOAT2 (f1 = pow (f1, f2), "expt", arg1, arg2);
Mike Rowan's avatar
Mike Rowan committed
506 507
  return make_float (f1);
}
508

509
DEFUN ("log", Flog, Slog, 1, 2, 0,
510 511 512
       doc: /* Return the natural logarithm of ARG.
If second optional argument BASE is given, return log ARG using that base.  */)
     (arg, base)
513
     register Lisp_Object arg, base;
Mike Rowan's avatar
Mike Rowan committed
514
{
515
  double d = extract_float (arg);
516

517 518 519 520
#ifdef FLOAT_CHECK_DOMAIN
  if (d <= 0.0)
    domain_error2 ("log", arg, base);
#endif
521
  if (NILP (base))
522
    IN_FLOAT (d = log (d), "log", arg);
523 524 525 526
  else
    {
      double b = extract_float (base);

527 528 529 530 531 532 533
#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
534
	IN_FLOAT2 (d = log (d) / log (b), "log", arg, base);
535
    }
Mike Rowan's avatar
Mike Rowan committed
536 537 538
  return make_float (d);
}

539
DEFUN ("log10", Flog10, Slog10, 1, 1, 0,
540 541
       doc: /* Return the logarithm base 10 of ARG.  */)
     (arg)
542
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
543
{
544 545 546 547 548 549
  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);
550 551 552
  return make_float (d);
}

Mike Rowan's avatar
Mike Rowan committed
553
DEFUN ("sqrt", Fsqrt, Ssqrt, 1, 1, 0,
554 555
       doc: /* Return the square root of ARG.  */)
     (arg)
556
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
557
{
558 559 560 561 562 563
  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
564 565
  return make_float (d);
}
566

Richard M. Stallman's avatar
Richard M. Stallman committed
567
#if 0 /* Not clearly worth adding.  */
Mike Rowan's avatar
Mike Rowan committed
568

569
DEFUN ("acosh", Facosh, Sacosh, 1, 1, 0,
570 571
       doc: /* Return the inverse hyperbolic cosine of ARG.  */)
     (arg)
572
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
573
{
574 575 576 577 578 579 580 581 582 583
  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
584 585 586 587
  return make_float (d);
}

DEFUN ("asinh", Fasinh, Sasinh, 1, 1, 0,
588 589
       doc: /* Return the inverse hyperbolic sine of ARG.  */)
     (arg)
590
     register Lisp_Object arg;
591
{
592 593 594 595 596 597
  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
598 599 600 601
  return make_float (d);
}

DEFUN ("atanh", Fatanh, Satanh, 1, 1, 0,
602 603
       doc: /* Return the inverse hyperbolic tangent of ARG.  */)
     (arg)
604
     register Lisp_Object arg;
605
{
606 607 608 609 610 611 612 613 614 615
  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
616 617 618 619
  return make_float (d);
}

DEFUN ("cosh", Fcosh, Scosh, 1, 1, 0,
620 621
       doc: /* Return the hyperbolic cosine of ARG.  */)
     (arg)
622
     register Lisp_Object arg;
623
{
624 625 626 627 628 629
  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);
630 631 632 633
  return make_float (d);
}

DEFUN ("sinh", Fsinh, Ssinh, 1, 1, 0,
634 635
       doc: /* Return the hyperbolic sine of ARG.  */)
     (arg)
636
     register Lisp_Object arg;
637
{
638 639 640 641 642 643
  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
644 645 646 647
  return make_float (d);
}

DEFUN ("tanh", Ftanh, Stanh, 1, 1, 0,
648 649
       doc: /* Return the hyperbolic tangent of ARG.  */)
     (arg)
650
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
651
{
652 653
  double d = extract_float (arg);
  IN_FLOAT (d = tanh (d), "tanh", arg);
Mike Rowan's avatar
Mike Rowan committed
654 655
  return make_float (d);
}
656
#endif
Mike Rowan's avatar
Mike Rowan committed
657 658

DEFUN ("abs", Fabs, Sabs, 1, 1, 0,
659 660
       doc: /* Return the absolute value of ARG.  */)
     (arg)
661
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
662
{
663
  CHECK_NUMBER_OR_FLOAT (arg);
Mike Rowan's avatar
Mike Rowan committed
664

665
  if (FLOATP (arg))
666
    IN_FLOAT (arg = make_float (fabs (XFLOAT_DATA (arg))), "abs", arg);
667
  else if (XINT (arg) < 0)
668
    XSETINT (arg, - XINT (arg));
Mike Rowan's avatar
Mike Rowan committed
669

670
  return arg;
Mike Rowan's avatar
Mike Rowan committed
671 672 673
}

DEFUN ("float", Ffloat, Sfloat, 1, 1, 0,
674 675
       doc: /* Return the floating point number equal to ARG.  */)
     (arg)
676
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
677
{
678
  CHECK_NUMBER_OR_FLOAT (arg);
Mike Rowan's avatar
Mike Rowan committed
679

680
  if (INTEGERP (arg))
681
    return make_float ((double) XINT (arg));
Mike Rowan's avatar
Mike Rowan committed
682
  else				/* give 'em the same float back */
683
    return arg;
Mike Rowan's avatar
Mike Rowan committed
684 685 686
}

DEFUN ("logb", Flogb, Slogb, 1, 1, 0,
687 688
       doc: /* Returns largest integer <= the base 2 log of the magnitude of ARG.
This is the same as the exponent of a float.  */)
689 690
     (arg)
     Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
691
{
692
  Lisp_Object val;
693
  EMACS_INT value;
694
  double f = extract_float (arg);
695

696
  if (f == 0.0)
Stefan Monnier's avatar
Stefan Monnier committed
697
    value = MOST_NEGATIVE_FIXNUM;
698 699
  else
    {
700
#ifdef HAVE_LOGB
701
      IN_FLOAT (value = logb (f), "logb", arg);
702 703
#else
#ifdef HAVE_FREXP
704 705 706
      int ivalue;
      IN_FLOAT (frexp (f, &ivalue), "logb", arg);
      value = ivalue - 1;
707
#else
708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726
      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;
	}
727
#endif
728
#endif
729
    }
730
  XSETINT (val, value);
731
  return val;
Mike Rowan's avatar
Mike Rowan committed
732 733
}

734

735 736 737 738
/* the rounding functions  */

static Lisp_Object
rounding_driver (arg, divisor, double_round, int_round2, name)
739
     register Lisp_Object arg, divisor;
740 741 742
     double (*double_round) ();
     EMACS_INT (*int_round2) ();
     char *name;
Mike Rowan's avatar
Mike Rowan committed
743
{
744
  CHECK_NUMBER_OR_FLOAT (arg);
Mike Rowan's avatar
Mike Rowan committed
745

746 747
  if (! NILP (divisor))
    {
748
      EMACS_INT i1, i2;
749

750
      CHECK_NUMBER_OR_FLOAT (divisor);
751

752
      if (FLOATP (arg) || FLOATP (divisor))
753 754 755
	{
	  double f1, f2;

756 757
	  f1 = FLOATP (arg) ? XFLOAT_DATA (arg) : XINT (arg);
	  f2 = (FLOATP (divisor) ? XFLOAT_DATA (divisor) : XINT (divisor));
758
	  if (! IEEE_FLOATING_POINT && f2 == 0)
759 760
	    Fsignal (Qarith_error, Qnil);

761 762
	  IN_FLOAT2 (f1 = (*double_round) (f1 / f2), name, arg, divisor);
	  FLOAT_TO_INT2 (f1, arg, name, arg, divisor);
763 764 765 766 767 768 769 770 771
	  return arg;
	}

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

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

772
      XSETINT (arg, (*int_round2) (i1, i2));
773 774 775
      return arg;
    }

776
  if (FLOATP (arg))
777 778
    {
      double d;
779

780
      IN_FLOAT (d = (*double_round) (XFLOAT_DATA (arg)), name, arg);
781
      FLOAT_TO_INT (d, arg, name, arg);
782
    }
Mike Rowan's avatar
Mike Rowan committed
783

784
  return arg;
Mike Rowan's avatar
Mike Rowan committed
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 829 830 831 832 833
/* 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);
}

834 835 836 837 838
/* 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
839
static double
840
emacs_rint (d)
841 842
     double d;
{
Richard M. Stallman's avatar
Richard M. Stallman committed
843
  return floor (d + 0.5);
844 845 846
}
#endif

847 848 849 850 851 852 853 854
static double
double_identity (d)
     double d;
{
  return d;
}

DEFUN ("ceiling", Fceiling, Sceiling, 1, 2, 0,
855 856
       doc: /* Return the smallest integer no less than ARG.
This rounds the value towards +inf.
857 858
With optional DIVISOR, return the smallest integer no less than ARG/DIVISOR.  */)
     (arg, divisor)
859 860 861 862 863 864
     Lisp_Object arg, divisor;
{
  return rounding_driver (arg, divisor, ceil, ceiling2, "ceiling");
}

DEFUN ("floor", Ffloor, Sfloor, 1, 2, 0,
865
       doc: /* Return the largest integer no greater than ARG.
Lute Kamstra's avatar
Lute Kamstra committed
866
This rounds the value towards -inf.
867 868
With optional DIVISOR, return the largest integer no greater than ARG/DIVISOR.  */)
     (arg, divisor)
869 870 871 872 873 874
     Lisp_Object arg, divisor;
{
  return rounding_driver (arg, divisor, floor, floor2, "floor");
}

DEFUN ("round", Fround, Sround, 1, 2, 0,
875
       doc: /* Return the nearest integer to ARG.
Eli Zaretskii's avatar
Eli Zaretskii committed
876 877
With optional DIVISOR, return the nearest integer to ARG/DIVISOR.

Eli Zaretskii's avatar
Eli Zaretskii committed
878 879 880
Rounding a value equidistant between two integers may choose the
integer closer to zero, or it may prefer an even integer, depending on
your machine.  For example, \(round 2.5\) can return 3 on some
Eli Zaretskii's avatar
Eli Zaretskii committed
881
systems, but 2 on others.  */)
882
     (arg, divisor)
883 884
     Lisp_Object arg, divisor;
{
885
  return rounding_driver (arg, divisor, emacs_rint, round2, "round");
886 887 888
}

DEFUN ("truncate", Ftruncate, Struncate, 1, 2, 0,
889 890 891 892
       doc: /* Truncate a floating point number to an int.
Rounds ARG toward zero.
With optional DIVISOR, truncate ARG/DIVISOR.  */)
     (arg, divisor)
893 894 895 896 897 898
     Lisp_Object arg, divisor;
{
  return rounding_driver (arg, divisor, double_identity, truncate2,
			  "truncate");
}

899

900 901 902 903 904 905
Lisp_Object
fmod_float (x, y)
     register Lisp_Object x, y;
{
  double f1, f2;

906 907
  f1 = FLOATP (x) ? XFLOAT_DATA (x) : XINT (x);
  f2 = FLOATP (y) ? XFLOAT_DATA (y) : XINT (y);
908 909 910 911 912 913 914 915 916 917

  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);
}
918 919 920 921

/* It's not clear these are worth adding.  */

DEFUN ("fceiling", Ffceiling, Sfceiling, 1, 1, 0,
922 923 924
       doc: /* Return the smallest integer no less than ARG, as a float.
\(Round toward +inf.\)  */)
     (arg)
925 926 927 928 929 930 931 932
     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,
933 934 935
       doc: /* Return the largest integer no greater than ARG, as a float.
\(Round towards -inf.\)  */)
     (arg)
936 937 938 939 940 941
     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
942

943
DEFUN ("fround", Ffround, Sfround, 1, 1, 0,
944 945
       doc: /* Return the nearest integer to ARG, as a float.  */)
     (arg)
946 947 948
     register Lisp_Object arg;
{
  double d = extract_float (arg);
949
  IN_FLOAT (d = emacs_rint (d), "fround", arg);
950 951 952 953
  return make_float (d);
}

DEFUN ("ftruncate", Fftruncate, Sftruncate, 1, 1, 0,
954 955 956
       doc: /* Truncate a floating point number to an integral float value.
Rounds the value toward zero.  */)
     (arg)
957 958 959 960 961 962
     register Lisp_Object arg;
{
  double d = extract_float (arg);
  if (d >= 0.0)
    IN_FLOAT (d = floor (d), "ftruncate", arg);
  else
963
    IN_FLOAT (d = ceil (d), "ftruncate", arg);
964
  return make_float (d);
Mike Rowan's avatar
Mike Rowan committed
965 966
}

967
#ifdef FLOAT_CATCH_SIGILL
Jim Blandy's avatar
Jim Blandy committed
968
static SIGTYPE
Mike Rowan's avatar
Mike Rowan committed
969 970 971 972 973 974
float_error (signo)
     int signo;
{
  if (! in_float)
    fatal_error_signal (signo);

975
#ifdef BSD_SYSTEM
Mike Rowan's avatar
Mike Rowan committed
976 977 978
#ifdef BSD4_1
  sigrelse (SIGILL);
#else /* not BSD4_1 */
Jim Blandy's avatar
Jim Blandy committed
979
  sigsetmask (SIGEMPTYMASK);
Mike Rowan's avatar
Mike Rowan committed