floatfns.c 27.6 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-2011  Free Software Foundation, Inc.
Mike Rowan's avatar
Mike Rowan committed
3

4 5 6
Author: Wolfgang Rupprecht
(according to ack.texi)

Mike Rowan's avatar
Mike Rowan committed
7 8
This file is part of GNU Emacs.

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

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
20
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
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
#include <setjmp.h>
51 52 53
#include "lisp.h"
#include "syssignal.h"

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

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

Mike Rowan's avatar
Mike Rowan committed
68
#include <math.h>
69

70
/* This declaration is omitted on some systems, like Ultrix.  */
71
#if !defined (HPUX) && defined (HAVE_LOGB) && !defined (logb)
72
extern double logb (double);
73
#endif /* not HPUX and HAVE_LOGB and no logb macro */
74

75 76 77 78 79 80 81
#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
82
#ifdef NO_MATHERR
83 84 85
#undef HAVE_MATHERR
#endif

86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
#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>
101
#endif
Jim Blandy's avatar
Jim Blandy committed
102

103
#ifdef FLOAT_CATCH_SIGILL
Jim Blandy's avatar
Jim Blandy committed
104
static SIGTYPE float_error ();
105
#endif
Mike Rowan's avatar
Mike Rowan committed
106 107 108 109 110 111 112

/* 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
113 114 115
   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
116

117 118
static Lisp_Object float_error_arg, float_error_arg2;

119
static const char *float_error_fn_name;
Mike Rowan's avatar
Mike Rowan committed
120

Jim Blandy's avatar
Jim Blandy committed
121 122 123
/* Evaluate the floating point expression D, recording NUM
   as the original argument for error messages.
   D is normally an assignment expression.
124 125 126 127 128
   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
129

130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
#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
157
#define IN_FLOAT(d, name, num) (in_float = 1, (d), in_float = 0)
158 159 160
#define IN_FLOAT2(d, name, num, num2) (in_float = 1, (d), in_float = 0)
#endif

161 162 163 164 165
/* 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									\
    {									\
166
      if (FIXNUM_OVERFLOW_P (x))					\
167
	range_error (name, num);					\
168
      XSETINT (i,  (EMACS_INT)(x));					\
169 170 171 172 173
    }									\
  while (0)
#define FLOAT_TO_INT2(x, i, name, num1, num2)				\
  do									\
    {									\
174
      if (FIXNUM_OVERFLOW_P (x))					\
175
	range_error2 (name, num1, num2);				\
176
      XSETINT (i,  (EMACS_INT)(x));					\
177 178 179
    }									\
  while (0)

180
#define arith_error(op,arg) \
181
  xsignal2 (Qarith_error, build_string ((op)), (arg))
182
#define range_error(op,arg) \
183
  xsignal2 (Qrange_error, build_string ((op)), (arg))
184
#define range_error2(op,a1,a2) \
185
  xsignal3 (Qrange_error, build_string ((op)), (a1), (a2))
186
#define domain_error(op,arg) \
187
  xsignal2 (Qdomain_error, build_string ((op)), (arg))
188
#define domain_error2(op,a1,a2) \
189
  xsignal3 (Qdomain_error, build_string ((op)), (a1), (a2))
Mike Rowan's avatar
Mike Rowan committed
190 191 192 193

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

double
Andreas Schwab's avatar
Andreas Schwab committed
194
extract_float (Lisp_Object num)
Mike Rowan's avatar
Mike Rowan committed
195
{
196
  CHECK_NUMBER_OR_FLOAT (num);
Mike Rowan's avatar
Mike Rowan committed
197

198
  if (FLOATP (num))
199
    return XFLOAT_DATA (num);
Mike Rowan's avatar
Mike Rowan committed
200 201
  return (double) XINT (num);
}
202 203

/* Trig functions.  */
Mike Rowan's avatar
Mike Rowan committed
204 205

DEFUN ("acos", Facos, Sacos, 1, 1, 0,
206
       doc: /* Return the inverse cosine of ARG.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
207
  (register Lisp_Object arg)
Mike Rowan's avatar
Mike Rowan committed
208
{
209 210 211 212 213 214
  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
215 216 217
  return make_float (d);
}

218
DEFUN ("asin", Fasin, Sasin, 1, 1, 0,
219
       doc: /* Return the inverse sine of ARG.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
220
  (register Lisp_Object arg)
Mike Rowan's avatar
Mike Rowan committed
221
{
222 223 224 225 226 227
  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
228 229 230
  return make_float (d);
}

231 232 233 234 235 236
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.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
237
  (register Lisp_Object y, Lisp_Object x)
Mike Rowan's avatar
Mike Rowan committed
238
{
239 240 241 242 243 244 245 246 247 248
  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
249 250 251
  return make_float (d);
}

252
DEFUN ("cos", Fcos, Scos, 1, 1, 0,
253
       doc: /* Return the cosine of ARG.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
254
  (register Lisp_Object arg)
Mike Rowan's avatar
Mike Rowan committed
255
{
256 257
  double d = extract_float (arg);
  IN_FLOAT (d = cos (d), "cos", arg);
Mike Rowan's avatar
Mike Rowan committed
258 259 260
  return make_float (d);
}

261
DEFUN ("sin", Fsin, Ssin, 1, 1, 0,
262
       doc: /* Return the sine of ARG.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
263
  (register Lisp_Object arg)
Mike Rowan's avatar
Mike Rowan committed
264
{
265 266
  double d = extract_float (arg);
  IN_FLOAT (d = sin (d), "sin", arg);
Mike Rowan's avatar
Mike Rowan committed
267 268 269
  return make_float (d);
}

270
DEFUN ("tan", Ftan, Stan, 1, 1, 0,
271
       doc: /* Return the tangent of ARG.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
272
  (register Lisp_Object arg)
273 274 275 276 277 278 279 280
{
  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
281 282
  return make_float (d);
}
283 284 285 286

#if defined HAVE_ISNAN && defined HAVE_COPYSIGN
DEFUN ("isnan", Fisnan, Sisnan, 1, 1, 0,
       doc: /* Return non nil iff argument X is a NaN.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
287
  (Lisp_Object x)
288 289 290 291 292 293 294 295
{
  CHECK_FLOAT (x);
  return isnan (XFLOAT_DATA (x)) ? Qt : Qnil;
}

DEFUN ("copysign", Fcopysign, Scopysign, 1, 2, 0,
       doc: /* Copy sign of X2 to value of X1, and return the result.
Cause an error if X1 or X2 is not a float.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
296
  (Lisp_Object x1, Lisp_Object x2)
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
{
  double f1, f2;

  CHECK_FLOAT (x1);
  CHECK_FLOAT (x2);

  f1 = XFLOAT_DATA (x1);
  f2 = XFLOAT_DATA (x2);

  return make_float (copysign (f1, f2));
}

DEFUN ("frexp", Ffrexp, Sfrexp, 1, 1, 0,
       doc: /* Get significand and exponent of a floating point number.
Breaks the floating point number X into its binary significand SGNFCAND
\(a floating point value between 0.5 (included) and 1.0 (excluded))
and an integral exponent EXP for 2, such that:

  X = SGNFCAND * 2^EXP

The function returns the cons cell (SGNFCAND . EXP).
If X is zero, both parts (SGNFCAND and EXP) are zero.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
319
  (Lisp_Object x)
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
{
  double f = XFLOATINT (x);

  if (f == 0.0)
    return Fcons (make_float (0.0), make_number (0));
  else
    {
      int    exp;
      double sgnfcand = frexp (f, &exp);
      return Fcons (make_float (sgnfcand), make_number (exp));
    }
}

DEFUN ("ldexp", Fldexp, Sldexp, 1, 2, 0,
       doc: /* Construct number X from significand SGNFCAND and exponent EXP.
Returns the floating point value resulting from multiplying SGNFCAND
(the significand) by 2 raised to the power of EXP (the exponent).   */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
337
  (Lisp_Object sgnfcand, Lisp_Object exp)
338 339 340 341 342
{
  CHECK_NUMBER (exp);
  return make_float (ldexp (XFLOATINT (sgnfcand), XINT (exp)));
}
#endif
Mike Rowan's avatar
Mike Rowan committed
343

344 345
#if 0 /* Leave these out unless we find there's a reason for them.  */

Mike Rowan's avatar
Mike Rowan committed
346
DEFUN ("bessel-j0", Fbessel_j0, Sbessel_j0, 1, 1, 0,
347
       doc: /* Return the bessel function j0 of ARG.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
348
  (register Lisp_Object arg)
Mike Rowan's avatar
Mike Rowan committed
349
{
350 351
  double d = extract_float (arg);
  IN_FLOAT (d = j0 (d), "bessel-j0", arg);
Mike Rowan's avatar
Mike Rowan committed
352 353 354 355
  return make_float (d);
}

DEFUN ("bessel-j1", Fbessel_j1, Sbessel_j1, 1, 1, 0,
356
       doc: /* Return the bessel function j1 of ARG.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
357
  (register Lisp_Object arg)
Mike Rowan's avatar
Mike Rowan committed
358
{
359 360
  double d = extract_float (arg);
  IN_FLOAT (d = j1 (d), "bessel-j1", arg);
Mike Rowan's avatar
Mike Rowan committed
361 362 363 364
  return make_float (d);
}

DEFUN ("bessel-jn", Fbessel_jn, Sbessel_jn, 2, 2, 0,
365 366
       doc: /* Return the order N bessel function output jn of ARG.
The first arg (the order) is truncated to an integer.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
367
  (register Lisp_Object n, Lisp_Object arg)
Mike Rowan's avatar
Mike Rowan committed
368
{
369 370
  int i1 = extract_float (n);
  double f2 = extract_float (arg);
Mike Rowan's avatar
Mike Rowan committed
371

372
  IN_FLOAT (f2 = jn (i1, f2), "bessel-jn", n);
Mike Rowan's avatar
Mike Rowan committed
373 374 375 376
  return make_float (f2);
}

DEFUN ("bessel-y0", Fbessel_y0, Sbessel_y0, 1, 1, 0,
377
       doc: /* Return the bessel function y0 of ARG.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
378
  (register Lisp_Object arg)
Mike Rowan's avatar
Mike Rowan committed
379
{
380 381
  double d = extract_float (arg);
  IN_FLOAT (d = y0 (d), "bessel-y0", arg);
Mike Rowan's avatar
Mike Rowan committed
382 383 384 385
  return make_float (d);
}

DEFUN ("bessel-y1", Fbessel_y1, Sbessel_y1, 1, 1, 0,
386
       doc: /* Return the bessel function y1 of ARG.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
387
  (register Lisp_Object arg)
Mike Rowan's avatar
Mike Rowan committed
388
{
389 390
  double d = extract_float (arg);
  IN_FLOAT (d = y1 (d), "bessel-y0", arg);
Mike Rowan's avatar
Mike Rowan committed
391 392 393 394
  return make_float (d);
}

DEFUN ("bessel-yn", Fbessel_yn, Sbessel_yn, 2, 2, 0,
395 396
       doc: /* Return the order N bessel function output yn of ARG.
The first arg (the order) is truncated to an integer.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
397
  (register Lisp_Object n, Lisp_Object arg)
Mike Rowan's avatar
Mike Rowan committed
398
{
399 400
  int i1 = extract_float (n);
  double f2 = extract_float (arg);
Mike Rowan's avatar
Mike Rowan committed
401

402
  IN_FLOAT (f2 = yn (i1, f2), "bessel-yn", n);
Mike Rowan's avatar
Mike Rowan committed
403 404 405
  return make_float (f2);
}

406 407 408
#endif

#if 0 /* Leave these out unless we see they are worth having.  */
Mike Rowan's avatar
Mike Rowan committed
409 410

DEFUN ("erf", Ferf, Serf, 1, 1, 0,
411
       doc: /* Return the mathematical error function of ARG.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
412
  (register Lisp_Object arg)
Mike Rowan's avatar
Mike Rowan committed
413
{
414 415
  double d = extract_float (arg);
  IN_FLOAT (d = erf (d), "erf", arg);
Mike Rowan's avatar
Mike Rowan committed
416 417 418 419
  return make_float (d);
}

DEFUN ("erfc", Ferfc, Serfc, 1, 1, 0,
420
       doc: /* Return the complementary error function of ARG.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
421
  (register Lisp_Object arg)
Mike Rowan's avatar
Mike Rowan committed
422
{
423 424
  double d = extract_float (arg);
  IN_FLOAT (d = erfc (d), "erfc", arg);
Mike Rowan's avatar
Mike Rowan committed
425 426 427 428
  return make_float (d);
}

DEFUN ("log-gamma", Flog_gamma, Slog_gamma, 1, 1, 0,
429
       doc: /* Return the log gamma of ARG.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
430
  (register Lisp_Object arg)
Mike Rowan's avatar
Mike Rowan committed
431
{
432 433
  double d = extract_float (arg);
  IN_FLOAT (d = lgamma (d), "log-gamma", arg);
Mike Rowan's avatar
Mike Rowan committed
434 435 436
  return make_float (d);
}

437
DEFUN ("cube-root", Fcube_root, Scube_root, 1, 1, 0,
438
       doc: /* Return the cube root of ARG.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
439
  (register Lisp_Object arg)
Mike Rowan's avatar
Mike Rowan committed
440
{
441 442 443 444 445 446 447 448 449
  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
450 451 452
  return make_float (d);
}

Richard M. Stallman's avatar
Richard M. Stallman committed
453 454
#endif

455
DEFUN ("exp", Fexp, Sexp, 1, 1, 0,
456
       doc: /* Return the exponential base e of ARG.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
457
  (register Lisp_Object arg)
458 459 460 461 462 463 464 465 466 467
{
  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
468 469 470 471
  return make_float (d);
}

DEFUN ("expt", Fexpt, Sexpt, 2, 2, 0,
472
       doc: /* Return the exponential ARG1 ** ARG2.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
473
  (register Lisp_Object arg1, Lisp_Object arg2)
Mike Rowan's avatar
Mike Rowan committed
474
{
475
  double f1, f2, f3;
Mike Rowan's avatar
Mike Rowan committed
476

477 478
  CHECK_NUMBER_OR_FLOAT (arg1);
  CHECK_NUMBER_OR_FLOAT (arg2);
479
  if (INTEGERP (arg1)     /* common lisp spec */
480 481
      && 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
482
    {				/* this can be improved by pre-calculating */
483
      EMACS_INT acc, x, y;	/* some binary powers of x then accumulating */
484 485
      Lisp_Object val;

486 487
      x = XINT (arg1);
      y = XINT (arg2);
Mike Rowan's avatar
Mike Rowan committed
488
      acc = 1;
489

Mike Rowan's avatar
Mike Rowan committed
490 491
      if (y < 0)
	{
492 493 494 495 496 497
	  if (x == 1)
	    acc = 1;
	  else if (x == -1)
	    acc = (y & 1) ? -1 : 1;
	  else
	    acc = 0;
Mike Rowan's avatar
Mike Rowan committed
498 499 500
	}
      else
	{
501 502 503 504 505 506 507
	  while (y > 0)
	    {
	      if (y & 1)
		acc *= x;
	      x *= x;
	      y = (unsigned)y >> 1;
	    }
Mike Rowan's avatar
Mike Rowan committed
508
	}
509
      XSETINT (val, acc);
510
      return val;
Mike Rowan's avatar
Mike Rowan committed
511
    }
512 513
  f1 = FLOATP (arg1) ? XFLOAT_DATA (arg1) : XINT (arg1);
  f2 = FLOATP (arg2) ? XFLOAT_DATA (arg2) : XINT (arg2);
514 515 516 517 518 519 520
  /* 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
521 522 523 524 525
  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
526
}
527

528
DEFUN ("log", Flog, Slog, 1, 2, 0,
529
       doc: /* Return the natural logarithm of ARG.
Richard M. Stallman's avatar
Richard M. Stallman committed
530
If the optional argument BASE is given, return log ARG using that base.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
531
  (register Lisp_Object arg, Lisp_Object base)
Mike Rowan's avatar
Mike Rowan committed
532
{
533
  double d = extract_float (arg);
534

535 536 537 538
#ifdef FLOAT_CHECK_DOMAIN
  if (d <= 0.0)
    domain_error2 ("log", arg, base);
#endif
539
  if (NILP (base))
540
    IN_FLOAT (d = log (d), "log", arg);
541 542 543 544
  else
    {
      double b = extract_float (base);

545 546 547 548 549 550 551
#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
552
	IN_FLOAT2 (d = log (d) / log (b), "log", arg, base);
553
    }
Mike Rowan's avatar
Mike Rowan committed
554 555 556
  return make_float (d);
}

557
DEFUN ("log10", Flog10, Slog10, 1, 1, 0,
558
       doc: /* Return the logarithm base 10 of ARG.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
559
  (register Lisp_Object arg)
Mike Rowan's avatar
Mike Rowan committed
560
{
561 562 563 564 565 566
  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);
567 568 569
  return make_float (d);
}

Mike Rowan's avatar
Mike Rowan committed
570
DEFUN ("sqrt", Fsqrt, Ssqrt, 1, 1, 0,
571
       doc: /* Return the square root of ARG.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
572
  (register Lisp_Object arg)
Mike Rowan's avatar
Mike Rowan committed
573
{
574 575 576 577 578 579
  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
580 581
  return make_float (d);
}
582

Richard M. Stallman's avatar
Richard M. Stallman committed
583
#if 0 /* Not clearly worth adding.  */
Mike Rowan's avatar
Mike Rowan committed
584

585
DEFUN ("acosh", Facosh, Sacosh, 1, 1, 0,
586
       doc: /* Return the inverse hyperbolic cosine of ARG.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
587
  (register Lisp_Object arg)
Mike Rowan's avatar
Mike Rowan committed
588
{
589 590 591 592 593 594 595 596 597 598
  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
599 600 601 602
  return make_float (d);
}

DEFUN ("asinh", Fasinh, Sasinh, 1, 1, 0,
603
       doc: /* Return the inverse hyperbolic sine of ARG.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
604
  (register Lisp_Object arg)
605
{
606 607 608 609 610 611
  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
612 613 614 615
  return make_float (d);
}

DEFUN ("atanh", Fatanh, Satanh, 1, 1, 0,
616
       doc: /* Return the inverse hyperbolic tangent of ARG.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
617
  (register Lisp_Object arg)
618
{
619 620 621 622 623 624 625 626 627 628
  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
629 630 631 632
  return make_float (d);
}

DEFUN ("cosh", Fcosh, Scosh, 1, 1, 0,
633
       doc: /* Return the hyperbolic cosine of ARG.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
634
  (register Lisp_Object arg)
635
{
636 637 638 639 640 641
  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);
642 643 644 645
  return make_float (d);
}

DEFUN ("sinh", Fsinh, Ssinh, 1, 1, 0,
646
       doc: /* Return the hyperbolic sine of ARG.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
647
  (register Lisp_Object arg)
648
{
649 650 651 652 653 654
  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
655 656 657 658
  return make_float (d);
}

DEFUN ("tanh", Ftanh, Stanh, 1, 1, 0,
659
       doc: /* Return the hyperbolic tangent of ARG.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
660
  (register Lisp_Object arg)
Mike Rowan's avatar
Mike Rowan committed
661
{
662 663
  double d = extract_float (arg);
  IN_FLOAT (d = tanh (d), "tanh", arg);
Mike Rowan's avatar
Mike Rowan committed
664 665
  return make_float (d);
}
666
#endif
Mike Rowan's avatar
Mike Rowan committed
667 668

DEFUN ("abs", Fabs, Sabs, 1, 1, 0,
669
       doc: /* Return the absolute value of ARG.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
670
  (register Lisp_Object arg)
Mike Rowan's avatar
Mike Rowan committed
671
{
672
  CHECK_NUMBER_OR_FLOAT (arg);
Mike Rowan's avatar
Mike Rowan committed
673

674
  if (FLOATP (arg))
675
    IN_FLOAT (arg = make_float (fabs (XFLOAT_DATA (arg))), "abs", arg);
676
  else if (XINT (arg) < 0)
677
    XSETINT (arg, - XINT (arg));
Mike Rowan's avatar
Mike Rowan committed
678

679
  return arg;
Mike Rowan's avatar
Mike Rowan committed
680 681 682
}

DEFUN ("float", Ffloat, Sfloat, 1, 1, 0,
683
       doc: /* Return the floating point number equal to ARG.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
684
  (register Lisp_Object arg)
Mike Rowan's avatar
Mike Rowan committed
685
{
686
  CHECK_NUMBER_OR_FLOAT (arg);
Mike Rowan's avatar
Mike Rowan committed
687

688
  if (INTEGERP (arg))
689
    return make_float ((double) XINT (arg));
Mike Rowan's avatar
Mike Rowan committed
690
  else				/* give 'em the same float back */
691
    return arg;
Mike Rowan's avatar
Mike Rowan committed
692 693 694
}

DEFUN ("logb", Flogb, Slogb, 1, 1, 0,
695 696
       doc: /* Returns largest integer <= the base 2 log of the magnitude of ARG.
This is the same as the exponent of a float.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
697
  (Lisp_Object arg)
Mike Rowan's avatar
Mike Rowan committed
698
{
699
  Lisp_Object val;
700
  EMACS_INT value;
701
  double f = extract_float (arg);
702

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

741

742 743 744
/* the rounding functions  */

static Lisp_Object
745 746 747
rounding_driver (Lisp_Object arg, Lisp_Object divisor,
		 double (*double_round) (double),
		 EMACS_INT (*int_round2) (EMACS_INT, EMACS_INT),
748
		 const char *name)
Mike Rowan's avatar
Mike Rowan committed
749
{
750
  CHECK_NUMBER_OR_FLOAT (arg);
Mike Rowan's avatar
Mike Rowan committed
751

752 753
  if (! NILP (divisor))
    {
754
      EMACS_INT i1, i2;
755

756
      CHECK_NUMBER_OR_FLOAT (divisor);
757

758
      if (FLOATP (arg) || FLOATP (divisor))
759 760 761
	{
	  double f1, f2;

762 763
	  f1 = FLOATP (arg) ? XFLOAT_DATA (arg) : XINT (arg);
	  f2 = (FLOATP (divisor) ? XFLOAT_DATA (divisor) : XINT (divisor));
764
	  if (! IEEE_FLOATING_POINT && f2 == 0)
765
	    xsignal0 (Qarith_error);
766

767 768
	  IN_FLOAT2 (f1 = (*double_round) (f1 / f2), name, arg, divisor);
	  FLOAT_TO_INT2 (f1, arg, name, arg, divisor);
769 770 771 772 773 774 775
	  return arg;
	}

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

      if (i2 == 0)
776
	xsignal0 (Qarith_error);
777

778
      XSETINT (arg, (*int_round2) (i1, i2));
779 780 781
      return arg;
    }

782
  if (FLOATP (arg))
783 784
    {
      double d;
785

786
      IN_FLOAT (d = (*double_round) (XFLOAT_DATA (arg)), name, arg);
787
      FLOAT_TO_INT (d, arg, name, arg);
788
    }
Mike Rowan's avatar
Mike Rowan committed
789

790
  return arg;
Mike Rowan's avatar
Mike Rowan committed
791 792
}

793 794 795 796 797
/* 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
798
ceiling2 (EMACS_INT i1, EMACS_INT i2)
799 800 801 802 803 804 805
{
  return (i2 < 0
	  ? (i1 < 0  ?  ((-1 - i1) / -i2) + 1  :  - (i1 / -i2))
	  : (i1 <= 0  ?  - (-i1 / i2)  :  ((i1 - 1) / i2) + 1));
}

static EMACS_INT
806
floor2 (EMACS_INT i1, EMACS_INT i2)
807 808 809 810 811 812 813
{
  return (i2 < 0
	  ? (i1 <= 0  ?  -i1 / -i2  :  -1 - ((i1 - 1) / -i2))
	  : (i1 < 0  ?  -1 - ((-1 - i1) / i2)  :  i1 / i2));
}

static EMACS_INT
814
truncate2 (EMACS_INT i1, EMACS_INT i2)
815 816 817 818 819 820 821
{
  return (i2 < 0
	  ? (i1 < 0  ?  -i1 / -i2  :  - (i1 / -i2))
	  : (i1 < 0  ?  - (-i1 / i2)  :  i1 / i2));
}

static EMACS_INT
822
round2 (EMACS_INT i1, EMACS_INT i2)
823 824 825 826 827 828 829 830 831 832 833 834 835
{
  /* 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);
}

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

848
static double
849
double_identity (double d)
850 851 852 853 854
{
  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
With optional DIVISOR, return the smallest integer no less than ARG/DIVISOR.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
858
  (Lisp_Object arg, Lisp_Object divisor)
859 860 861 862 863
{
  return rounding_driver (arg, divisor, ceil, ceiling2, "ceiling");
}

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

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

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

DEFUN ("truncate", Ftruncate, Struncate, 1, 2, 0,
886 887 888
       doc: /* Truncate a floating point number to an int.
Rounds ARG toward zero.
With optional DIVISOR, truncate ARG/DIVISOR.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
889
  (Lisp_Object arg, Lisp_Object divisor)
890 891 892 893 894
{
  return rounding_driver (arg, divisor, double_identity, truncate2,
			  "truncate");
}

895

896
Lisp_Object
897
fmod_float (Lisp_Object x, Lisp_Object y)
898 899 900
{
  double f1, f2;

901 902
  f1 = FLOATP (x) ? XFLOAT_DATA (x) : XINT (x);
  f2 = FLOATP (y) ? XFLOAT_DATA (y) : XINT (y);
903 904

  if (! IEEE_FLOATING_POINT && f2 == 0)