floatfns.c 27.1 KB
Newer Older
Mike Rowan's avatar
Mike Rowan committed
1
/* Primitive operations on floating point for GNU Emacs Lisp interpreter.
2
   Copyright (C) 1988, 1993, 1994, 1999, 2001, 2002, 2003, 2004,
Glenn Morris's avatar
Glenn Morris committed
3
                 2005, 2006, 2007, 2008  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
9
the Free Software Foundation; either version 3, 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
#define arith_error(op,arg) \
204
  xsignal2 (Qarith_error, build_string ((op)), (arg))
205
#define range_error(op,arg) \
206
  xsignal2 (Qrange_error, build_string ((op)), (arg))
207
#define range_error2(op,a1,a2) \
208
  xsignal3 (Qrange_error, build_string ((op)), (a1), (a2))
209
#define domain_error(op,arg) \
210
  xsignal2 (Qdomain_error, build_string ((op)), (arg))
211
#define domain_error2(op,a1,a2) \
212
  xsignal3 (Qdomain_error, build_string ((op)), (a1), (a2))
Mike Rowan's avatar
Mike Rowan committed
213 214 215 216 217 218 219

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

double
extract_float (num)
     Lisp_Object num;
{
220
  CHECK_NUMBER_OR_FLOAT (num);
Mike Rowan's avatar
Mike Rowan committed
221

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

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

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

257 258 259 260 261 262 263 264
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
265
{
266 267 268 269 270 271 272 273 274 275
  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
276 277 278
  return make_float (d);
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

459 460
  CHECK_NUMBER_OR_FLOAT (arg1);
  CHECK_NUMBER_OR_FLOAT (arg2);
461
  if (INTEGERP (arg1)     /* common lisp spec */
462 463
      && 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
464
    {				/* this can be improved by pre-calculating */
465
      EMACS_INT acc, x, y;	/* some binary powers of x then accumulating */
466 467
      Lisp_Object val;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

735

736 737 738 739
/* the rounding functions  */

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

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

751
      CHECK_NUMBER_OR_FLOAT (divisor);
752

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

757 758
	  f1 = FLOATP (arg) ? XFLOAT_DATA (arg) : XINT (arg);
	  f2 = (FLOATP (divisor) ? XFLOAT_DATA (divisor) : XINT (divisor));
759
	  if (! IEEE_FLOATING_POINT && f2 == 0)
760
	    xsignal0 (Qarith_error);
761

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

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

      if (i2 == 0)
771
	xsignal0 (Qarith_error);
772

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

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

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

785
  return arg;
Mike Rowan's avatar
Mike Rowan committed
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 834
/* 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);
}

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

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

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

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

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

Eli Zaretskii's avatar
Eli Zaretskii committed
879 880 881
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
882
systems, but 2 on others.  */)
883
     (arg, divisor)
884 885
     Lisp_Object arg, divisor;
{
886
  return rounding_driver (arg, divisor, emacs_rint, round2, "round");
887 888 889
}

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

900

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

907 908
  f1 = FLOATP (x) ? XFLOAT_DATA (x) : XINT (x);
  f2 = FLOATP (y) ? XFLOAT_DATA (y) : XINT (y);
909 910

  if (! IEEE_FLOATING_POINT && f2 == 0)
911
    xsignal0 (Qarith_error);
912 913 914 915 916 917 918

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

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

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

DEFUN ("ftruncate", Fftruncate, Sftruncate, 1, 1, 0,
955 956 957
       doc: /* Truncate a floating point number to an integral float value.
Rounds the value toward zero.  */)
     (arg)