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 3 4

Copyright (C) 1988, 1993-1994, 1999, 2001-2011
  Free Software Foundation, Inc.
Mike Rowan's avatar
Mike Rowan committed
5

6 7 8
Author: Wolfgang Rupprecht
(according to ack.texi)

Mike Rowan's avatar
Mike Rowan committed
9 10
This file is part of GNU Emacs.

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

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
22
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Mike Rowan's avatar
Mike Rowan committed
23 24


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

50
#include <config.h>
51
#include <signal.h>
52
#include <setjmp.h>
53 54 55
#include "lisp.h"
#include "syssignal.h"

56 57 58 59
#if STDC_HEADERS
#include <float.h>
#endif

60 61 62 63 64 65 66 67 68 69
/* 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
70
#include <math.h>
71

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

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

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

105
#ifdef FLOAT_CATCH_SIGILL
106
static void float_error ();
107
#endif
Mike Rowan's avatar
Mike Rowan committed
108 109 110 111 112 113 114

/* 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
115 116 117
   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
118

119 120
static Lisp_Object float_error_arg, float_error_arg2;

121
static const char *float_error_fn_name;
Mike Rowan's avatar
Mike Rowan committed
122

Jim Blandy's avatar
Jim Blandy committed
123 124 125
/* Evaluate the floating point expression D, recording NUM
   as the original argument for error messages.
   D is normally an assignment expression.
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
129
   just cast the zero after the colon to (void) to make the types
130
   check properly.  */
Jim Blandy's avatar
Jim Blandy committed
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 157 158
#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
159
#define IN_FLOAT(d, name, num) (in_float = 1, (d), in_float = 0)
160 161 162
#define IN_FLOAT2(d, name, num, num2) (in_float = 1, (d), in_float = 0)
#endif

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

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

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

double
Andreas Schwab's avatar
Andreas Schwab committed
198
extract_float (Lisp_Object num)
Mike Rowan's avatar
Mike Rowan committed
199
{
200
  CHECK_NUMBER_OR_FLOAT (num);
Mike Rowan's avatar
Mike Rowan committed
201

202
  if (FLOATP (num))
203
    return XFLOAT_DATA (num);
Mike Rowan's avatar
Mike Rowan committed
204 205
  return (double) XINT (num);
}
206 207

/* Trig functions.  */
Mike Rowan's avatar
Mike Rowan committed
208 209

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

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

235 236 237 238 239 240
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
241
  (register Lisp_Object y, Lisp_Object x)
Mike Rowan's avatar
Mike Rowan committed
242
{
243 244 245 246 247 248 249 250 251 252
  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
253 254 255
  return make_float (d);
}

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

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

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

#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
291
  (Lisp_Object x)
292 293 294 295 296 297 298 299
{
  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
300
  (Lisp_Object x1, Lisp_Object x2)
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
{
  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
323
  (Lisp_Object x)
324 325 326 327 328 329 330
{
  double f = XFLOATINT (x);

  if (f == 0.0)
    return Fcons (make_float (0.0), make_number (0));
  else
    {
331 332 333
      int exponent;
      double sgnfcand = frexp (f, &exponent);
      return Fcons (make_float (sgnfcand), make_number (exponent));
334 335 336 337 338 339 340
    }
}

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).   */)
341
  (Lisp_Object sgnfcand, Lisp_Object exponent)
342
{
343 344
  CHECK_NUMBER (exponent);
  return make_float (ldexp (XFLOATINT (sgnfcand), XINT (exponent)));
345 346
}
#endif
Mike Rowan's avatar
Mike Rowan committed
347

348 349
#if 0 /* Leave these out unless we find there's a reason for them.  */

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

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

DEFUN ("bessel-jn", Fbessel_jn, Sbessel_jn, 2, 2, 0,
369 370
       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
371
  (register Lisp_Object n, Lisp_Object arg)
Mike Rowan's avatar
Mike Rowan committed
372
{
373 374
  int i1 = extract_float (n);
  double f2 = extract_float (arg);
Mike Rowan's avatar
Mike Rowan committed
375

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

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

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

DEFUN ("bessel-yn", Fbessel_yn, Sbessel_yn, 2, 2, 0,
399 400
       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
401
  (register Lisp_Object n, Lisp_Object arg)
Mike Rowan's avatar
Mike Rowan committed
402
{
403 404
  int i1 = extract_float (n);
  double f2 = extract_float (arg);
Mike Rowan's avatar
Mike Rowan committed
405

406
  IN_FLOAT (f2 = yn (i1, f2), "bessel-yn", n);
Mike Rowan's avatar
Mike Rowan committed
407 408 409
  return make_float (f2);
}

410 411 412
#endif

#if 0 /* Leave these out unless we see they are worth having.  */
Mike Rowan's avatar
Mike Rowan committed
413 414

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

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

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

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

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

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

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

490 491
      x = XINT (arg1);
      y = XINT (arg2);
Mike Rowan's avatar
Mike Rowan committed
492
      acc = 1;
493

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

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

539 540 541 542
#ifdef FLOAT_CHECK_DOMAIN
  if (d <= 0.0)
    domain_error2 ("log", arg, base);
#endif
543
  if (NILP (base))
544
    IN_FLOAT (d = log (d), "log", arg);
545 546 547 548
  else
    {
      double b = extract_float (base);

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

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

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

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

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

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

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

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

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

678
  if (FLOATP (arg))
679
    IN_FLOAT (arg = make_float (fabs (XFLOAT_DATA (arg))), "abs", arg);
680
  else if (XINT (arg) < 0)
681
    XSETINT (arg, - XINT (arg));
Mike Rowan's avatar
Mike Rowan committed
682

683
  return arg;
Mike Rowan's avatar
Mike Rowan committed
684 685 686
}

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

692
  if (INTEGERP (arg))
693
    return make_float ((double) XINT (arg));
Mike Rowan's avatar
Mike Rowan committed
694
  else				/* give 'em the same float back */
695
    return arg;
Mike Rowan's avatar
Mike Rowan committed
696 697 698
}

DEFUN ("logb", Flogb, Slogb, 1, 1, 0,
699 700
       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
701
  (Lisp_Object arg)
Mike Rowan's avatar
Mike Rowan committed
702
{
703
  Lisp_Object val;
704
  EMACS_INT value;
705
  double f = extract_float (arg);
706

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

745

746 747 748
/* the rounding functions  */

static Lisp_Object
749 750 751
rounding_driver (Lisp_Object arg, Lisp_Object divisor,
		 double (*double_round) (double),
		 EMACS_INT (*int_round2) (EMACS_INT, EMACS_INT),
752
		 const char *name)
Mike Rowan's avatar
Mike Rowan committed
753
{
754
  CHECK_NUMBER_OR_FLOAT (arg);
Mike Rowan's avatar
Mike Rowan committed
755

756 757
  if (! NILP (divisor))
    {
758
      EMACS_INT i1, i2;
759

760
      CHECK_NUMBER_OR_FLOAT (divisor);
761

762
      if (FLOATP (arg) || FLOATP (divisor))
763 764 765
	{
	  double f1, f2;

766 767
	  f1 = FLOATP (arg) ? XFLOAT_DATA (arg) : XINT (arg);
	  f2 = (FLOATP (divisor) ? XFLOAT_DATA (divisor) : XINT (divisor));
768
	  if (! IEEE_FLOATING_POINT && f2 == 0)
769
	    xsignal0 (Qarith_error);
770

771 772
	  IN_FLOAT2 (f1 = (*double_round) (f1 / f2), name, arg, divisor);
	  FLOAT_TO_INT2 (f1, arg, name, arg, divisor);
773 774 775 776 777 778 779
	  return arg;
	}

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

      if (i2 == 0)
780
	xsignal0 (Qarith_error);
781

782
      XSETINT (arg, (*int_round2) (i1, i2));
783 784 785
      return arg;
    }

786
  if (FLOATP (arg))
787 788
    {
      double d;
789

790
      IN_FLOAT (d = (*double_round) (XFLOAT_DATA (arg)), name, arg);
791
      FLOAT_TO_INT (d, arg, name, arg);
792
    }
Mike Rowan's avatar
Mike Rowan committed
793

794
  return arg;
Mike Rowan's avatar
Mike Rowan committed
795 796
}

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

static EMACS_INT
810
floor2 (EMACS_INT i1, EMACS_INT i2)
811 812 813 814 815 816 817
{
  return (i2 < 0
	  ? (i1 <= 0  ?  -i1 / -i2  :  -1 - ((i1 - 1) / -i2))
	  : (i1 < 0  ?  -1 - ((-1 - i1) / i2)  :  i1 / i2));
}

static EMACS_INT
818
truncate2 (EMACS_INT i1, EMACS_INT i2)
819 820 821 822 823 824 825
{
  return (i2 < 0
	  ? (i1 < 0  ?  -i1 / -i2  :  - (i1 / -i2))
	  : (i1 < 0  ?  - (-i1 / i2)  :  i1 / i2));
}

static EMACS_INT
826
round2 (EMACS_INT i1, EMACS_INT i2)
827 828 829 830 831 832 833 834 835 836 837 838 839
{
  /* 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);
}

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

852
static double
853
double_identity (double d)
854 855 856 857 858
{
  return d;
}

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

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

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

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

DEFUN ("truncate", Ftruncate, Struncate, 1, 2, 0,
890 891 892
       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
893
  (Lisp_Object arg, Lisp_Object divisor)
894 895 896 897 898
{
  return rounding_driver (arg, divisor, double_identity, truncate2,
			  "truncate");
}

899