floatfns.c 26.4 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, 2009  Free Software Foundation, Inc.
Mike Rowan's avatar
Mike Rowan committed
4

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

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

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

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


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

49
#include <config.h>
50
#include <signal.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 ();
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>
Jim Blandy's avatar
Jim Blandy committed
101

102
#ifndef USE_CRT_DLL
Jim Blandy's avatar
Jim Blandy committed
103
extern int errno;
104
#endif
105
#endif
Jim Blandy's avatar
Jim Blandy committed
106

107
#ifdef FLOAT_CATCH_SIGILL
Jim Blandy's avatar
Jim Blandy committed
108
static SIGTYPE float_error ();
109
#endif
Mike Rowan's avatar
Mike Rowan committed
110 111 112 113 114 115 116

/* 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
117 118 119
   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
120

121 122 123
static Lisp_Object float_error_arg, float_error_arg2;

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

Jim Blandy's avatar
Jim Blandy committed
125 126 127
/* Evaluate the floating point expression D, recording NUM
   as the original argument for error messages.
   D is normally an assignment expression.
128 129 130 131 132
   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
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 159 160
#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
161
#define IN_FLOAT(d, name, num) (in_float = 1, (d), in_float = 0)
162 163 164
#define IN_FLOAT2(d, name, num, num2) (in_float = 1, (d), in_float = 0)
#endif

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

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

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

double
extract_float (num)
     Lisp_Object num;
{
201
  CHECK_NUMBER_OR_FLOAT (num);
Mike Rowan's avatar
Mike Rowan committed
202

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

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

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

238 239 240 241 242 243 244 245
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
246
{
247 248 249 250 251 252 253 254 255 256
  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
257 258 259
  return make_float (d);
}

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

270
DEFUN ("sin", Fsin, Ssin, 1, 1, 0,
271 272
       doc: /* Return the sine of ARG.  */)
     (arg)
273
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
274
{
275 276
  double d = extract_float (arg);
  IN_FLOAT (d = sin (d), "sin", arg);
Mike Rowan's avatar
Mike Rowan committed
277 278 279
  return make_float (d);
}

280
DEFUN ("tan", Ftan, Stan, 1, 1, 0,
281 282
       doc: /* Return the tangent of ARG.  */)
     (arg)
283 284 285 286 287 288 289 290 291
     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
292 293 294
  return make_float (d);
}

295 296
#if 0 /* Leave these out unless we find there's a reason for them.  */

Mike Rowan's avatar
Mike Rowan committed
297
DEFUN ("bessel-j0", Fbessel_j0, Sbessel_j0, 1, 1, 0,
298 299
       doc: /* Return the bessel function j0 of ARG.  */)
     (arg)
300
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
301
{
302 303
  double d = extract_float (arg);
  IN_FLOAT (d = j0 (d), "bessel-j0", arg);
Mike Rowan's avatar
Mike Rowan committed
304 305 306 307
  return make_float (d);
}

DEFUN ("bessel-j1", Fbessel_j1, Sbessel_j1, 1, 1, 0,
308 309
       doc: /* Return the bessel function j1 of ARG.  */)
     (arg)
310
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
311
{
312 313
  double d = extract_float (arg);
  IN_FLOAT (d = j1 (d), "bessel-j1", arg);
Mike Rowan's avatar
Mike Rowan committed
314 315 316 317
  return make_float (d);
}

DEFUN ("bessel-jn", Fbessel_jn, Sbessel_jn, 2, 2, 0,
318 319 320
       doc: /* Return the order N bessel function output jn of ARG.
The first arg (the order) is truncated to an integer.  */)
     (n, arg)
321
     register Lisp_Object n, arg;
Mike Rowan's avatar
Mike Rowan committed
322
{
323 324
  int i1 = extract_float (n);
  double f2 = extract_float (arg);
Mike Rowan's avatar
Mike Rowan committed
325

326
  IN_FLOAT (f2 = jn (i1, f2), "bessel-jn", n);
Mike Rowan's avatar
Mike Rowan committed
327 328 329 330
  return make_float (f2);
}

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

DEFUN ("bessel-y1", Fbessel_y1, Sbessel_y1, 1, 1, 0,
341 342
       doc: /* Return the bessel function y1 of ARG.  */)
     (arg)
343
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
344
{
345 346
  double d = extract_float (arg);
  IN_FLOAT (d = y1 (d), "bessel-y0", arg);
Mike Rowan's avatar
Mike Rowan committed
347 348 349 350
  return make_float (d);
}

DEFUN ("bessel-yn", Fbessel_yn, Sbessel_yn, 2, 2, 0,
351 352 353
       doc: /* Return the order N bessel function output yn of ARG.
The first arg (the order) is truncated to an integer.  */)
     (n, arg)
354
     register Lisp_Object n, arg;
Mike Rowan's avatar
Mike Rowan committed
355
{
356 357
  int i1 = extract_float (n);
  double f2 = extract_float (arg);
Mike Rowan's avatar
Mike Rowan committed
358

359
  IN_FLOAT (f2 = yn (i1, f2), "bessel-yn", n);
Mike Rowan's avatar
Mike Rowan committed
360 361 362
  return make_float (f2);
}

363 364 365
#endif

#if 0 /* Leave these out unless we see they are worth having.  */
Mike Rowan's avatar
Mike Rowan committed
366 367

DEFUN ("erf", Ferf, Serf, 1, 1, 0,
368 369
       doc: /* Return the mathematical error function of ARG.  */)
     (arg)
370
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
371
{
372 373
  double d = extract_float (arg);
  IN_FLOAT (d = erf (d), "erf", arg);
Mike Rowan's avatar
Mike Rowan committed
374 375 376 377
  return make_float (d);
}

DEFUN ("erfc", Ferfc, Serfc, 1, 1, 0,
378 379
       doc: /* Return the complementary error function of ARG.  */)
     (arg)
380
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
381
{
382 383
  double d = extract_float (arg);
  IN_FLOAT (d = erfc (d), "erfc", arg);
Mike Rowan's avatar
Mike Rowan committed
384 385 386 387
  return make_float (d);
}

DEFUN ("log-gamma", Flog_gamma, Slog_gamma, 1, 1, 0,
388 389
       doc: /* Return the log gamma of ARG.  */)
     (arg)
390
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
391
{
392 393
  double d = extract_float (arg);
  IN_FLOAT (d = lgamma (d), "log-gamma", arg);
Mike Rowan's avatar
Mike Rowan committed
394 395 396
  return make_float (d);
}

397
DEFUN ("cube-root", Fcube_root, Scube_root, 1, 1, 0,
398 399
       doc: /* Return the cube root of ARG.  */)
     (arg)
400
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
401
{
402 403 404 405 406 407 408 409 410
  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
411 412 413
  return make_float (d);
}

Richard M. Stallman's avatar
Richard M. Stallman committed
414 415
#endif

416
DEFUN ("exp", Fexp, Sexp, 1, 1, 0,
417 418
       doc: /* Return the exponential base e of ARG.  */)
     (arg)
419 420 421 422 423 424 425 426 427 428 429
     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
430 431 432 433
  return make_float (d);
}

DEFUN ("expt", Fexpt, Sexpt, 2, 2, 0,
434 435
       doc: /* Return the exponential ARG1 ** ARG2.  */)
     (arg1, arg2)
436
     register Lisp_Object arg1, arg2;
Mike Rowan's avatar
Mike Rowan committed
437
{
438
  double f1, f2, f3;
Mike Rowan's avatar
Mike Rowan committed
439

440 441
  CHECK_NUMBER_OR_FLOAT (arg1);
  CHECK_NUMBER_OR_FLOAT (arg2);
442
  if (INTEGERP (arg1)     /* common lisp spec */
443 444
      && 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
445
    {				/* this can be improved by pre-calculating */
446
      EMACS_INT acc, x, y;	/* some binary powers of x then accumulating */
447 448
      Lisp_Object val;

449 450
      x = XINT (arg1);
      y = XINT (arg2);
Mike Rowan's avatar
Mike Rowan committed
451
      acc = 1;
452

Mike Rowan's avatar
Mike Rowan committed
453 454
      if (y < 0)
	{
455 456 457 458 459 460
	  if (x == 1)
	    acc = 1;
	  else if (x == -1)
	    acc = (y & 1) ? -1 : 1;
	  else
	    acc = 0;
Mike Rowan's avatar
Mike Rowan committed
461 462 463
	}
      else
	{
464 465 466 467 468 469 470
	  while (y > 0)
	    {
	      if (y & 1)
		acc *= x;
	      x *= x;
	      y = (unsigned)y >> 1;
	    }
Mike Rowan's avatar
Mike Rowan committed
471
	}
472
      XSETINT (val, acc);
473
      return val;
Mike Rowan's avatar
Mike Rowan committed
474
    }
475 476
  f1 = FLOATP (arg1) ? XFLOAT_DATA (arg1) : XINT (arg1);
  f2 = FLOATP (arg2) ? XFLOAT_DATA (arg2) : XINT (arg2);
477 478 479 480 481 482 483
  /* 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
484 485 486 487 488
  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
489
}
490

491
DEFUN ("log", Flog, Slog, 1, 2, 0,
492
       doc: /* Return the natural logarithm of ARG.
Richard M. Stallman's avatar
Richard M. Stallman committed
493
If the optional argument BASE is given, return log ARG using that base.  */)
494
     (arg, base)
495
     register Lisp_Object arg, base;
Mike Rowan's avatar
Mike Rowan committed
496
{
497
  double d = extract_float (arg);
498

499 500 501 502
#ifdef FLOAT_CHECK_DOMAIN
  if (d <= 0.0)
    domain_error2 ("log", arg, base);
#endif
503
  if (NILP (base))
504
    IN_FLOAT (d = log (d), "log", arg);
505 506 507 508
  else
    {
      double b = extract_float (base);

509 510 511 512 513 514 515
#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
516
	IN_FLOAT2 (d = log (d) / log (b), "log", arg, base);
517
    }
Mike Rowan's avatar
Mike Rowan committed
518 519 520
  return make_float (d);
}

521
DEFUN ("log10", Flog10, Slog10, 1, 1, 0,
522 523
       doc: /* Return the logarithm base 10 of ARG.  */)
     (arg)
524
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
525
{
526 527 528 529 530 531
  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);
532 533 534
  return make_float (d);
}

Mike Rowan's avatar
Mike Rowan committed
535
DEFUN ("sqrt", Fsqrt, Ssqrt, 1, 1, 0,
536 537
       doc: /* Return the square root of ARG.  */)
     (arg)
538
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
539
{
540 541 542 543 544 545
  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
546 547
  return make_float (d);
}
548

Richard M. Stallman's avatar
Richard M. Stallman committed
549
#if 0 /* Not clearly worth adding.  */
Mike Rowan's avatar
Mike Rowan committed
550

551
DEFUN ("acosh", Facosh, Sacosh, 1, 1, 0,
552 553
       doc: /* Return the inverse hyperbolic cosine of ARG.  */)
     (arg)
554
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
555
{
556 557 558 559 560 561 562 563 564 565
  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
566 567 568 569
  return make_float (d);
}

DEFUN ("asinh", Fasinh, Sasinh, 1, 1, 0,
570 571
       doc: /* Return the inverse hyperbolic sine of ARG.  */)
     (arg)
572
     register Lisp_Object arg;
573
{
574 575 576 577 578 579
  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
580 581 582 583
  return make_float (d);
}

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

DEFUN ("cosh", Fcosh, Scosh, 1, 1, 0,
602 603
       doc: /* Return the hyperbolic cosine of ARG.  */)
     (arg)
604
     register Lisp_Object arg;
605
{
606 607 608 609 610 611
  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);
612 613 614 615
  return make_float (d);
}

DEFUN ("sinh", Fsinh, Ssinh, 1, 1, 0,
616 617
       doc: /* Return the hyperbolic sine of ARG.  */)
     (arg)
618
     register Lisp_Object arg;
619
{
620 621 622 623 624 625
  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
626 627 628 629
  return make_float (d);
}

DEFUN ("tanh", Ftanh, Stanh, 1, 1, 0,
630 631
       doc: /* Return the hyperbolic tangent of ARG.  */)
     (arg)
632
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
633
{
634 635
  double d = extract_float (arg);
  IN_FLOAT (d = tanh (d), "tanh", arg);
Mike Rowan's avatar
Mike Rowan committed
636 637
  return make_float (d);
}
638
#endif
Mike Rowan's avatar
Mike Rowan committed
639 640

DEFUN ("abs", Fabs, Sabs, 1, 1, 0,
641 642
       doc: /* Return the absolute value of ARG.  */)
     (arg)
643
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
644
{
645
  CHECK_NUMBER_OR_FLOAT (arg);
Mike Rowan's avatar
Mike Rowan committed
646

647
  if (FLOATP (arg))
648
    IN_FLOAT (arg = make_float (fabs (XFLOAT_DATA (arg))), "abs", arg);
649
  else if (XINT (arg) < 0)
650
    XSETINT (arg, - XINT (arg));
Mike Rowan's avatar
Mike Rowan committed
651

652
  return arg;
Mike Rowan's avatar
Mike Rowan committed
653 654 655
}

DEFUN ("float", Ffloat, Sfloat, 1, 1, 0,
656 657
       doc: /* Return the floating point number equal to ARG.  */)
     (arg)
658
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
659
{
660
  CHECK_NUMBER_OR_FLOAT (arg);
Mike Rowan's avatar
Mike Rowan committed
661

662
  if (INTEGERP (arg))
663
    return make_float ((double) XINT (arg));
Mike Rowan's avatar
Mike Rowan committed
664
  else				/* give 'em the same float back */
665
    return arg;
Mike Rowan's avatar
Mike Rowan committed
666 667 668
}

DEFUN ("logb", Flogb, Slogb, 1, 1, 0,
669 670
       doc: /* Returns largest integer <= the base 2 log of the magnitude of ARG.
This is the same as the exponent of a float.  */)
671 672
     (arg)
     Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
673
{
674
  Lisp_Object val;
675
  EMACS_INT value;
676
  double f = extract_float (arg);
677

678
  if (f == 0.0)
Stefan Monnier's avatar
Stefan Monnier committed
679
    value = MOST_NEGATIVE_FIXNUM;
680 681
  else
    {
682
#ifdef HAVE_LOGB
683
      IN_FLOAT (value = logb (f), "logb", arg);
684 685
#else
#ifdef HAVE_FREXP
686 687 688
      int ivalue;
      IN_FLOAT (frexp (f, &ivalue), "logb", arg);
      value = ivalue - 1;
689
#else
690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708
      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;
	}
709
#endif
710
#endif
711
    }
712
  XSETINT (val, value);
713
  return val;
Mike Rowan's avatar
Mike Rowan committed
714 715
}

716

717 718 719 720
/* the rounding functions  */

static Lisp_Object
rounding_driver (arg, divisor, double_round, int_round2, name)
721
     register Lisp_Object arg, divisor;
722 723 724
     double (*double_round) ();
     EMACS_INT (*int_round2) ();
     char *name;
Mike Rowan's avatar
Mike Rowan committed
725
{
726
  CHECK_NUMBER_OR_FLOAT (arg);
Mike Rowan's avatar
Mike Rowan committed
727

728 729
  if (! NILP (divisor))
    {
730
      EMACS_INT i1, i2;
731

732
      CHECK_NUMBER_OR_FLOAT (divisor);
733

734
      if (FLOATP (arg) || FLOATP (divisor))
735 736 737
	{
	  double f1, f2;

738 739
	  f1 = FLOATP (arg) ? XFLOAT_DATA (arg) : XINT (arg);
	  f2 = (FLOATP (divisor) ? XFLOAT_DATA (divisor) : XINT (divisor));
740
	  if (! IEEE_FLOATING_POINT && f2 == 0)
741
	    xsignal0 (Qarith_error);
742

743 744
	  IN_FLOAT2 (f1 = (*double_round) (f1 / f2), name, arg, divisor);
	  FLOAT_TO_INT2 (f1, arg, name, arg, divisor);
745 746 747 748 749 750 751
	  return arg;
	}

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

      if (i2 == 0)
752
	xsignal0 (Qarith_error);
753

754
      XSETINT (arg, (*int_round2) (i1, i2));
755 756 757
      return arg;
    }

758
  if (FLOATP (arg))
759 760
    {
      double d;
761

762
      IN_FLOAT (d = (*double_round) (XFLOAT_DATA (arg)), name, arg);
763
      FLOAT_TO_INT (d, arg, name, arg);
764
    }
Mike Rowan's avatar
Mike Rowan committed
765

766
  return arg;
Mike Rowan's avatar
Mike Rowan committed
767 768
}

769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815
/* 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);
}

816 817 818 819 820
/* 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
821
static double
822
emacs_rint (d)
823 824
     double d;
{
Richard M. Stallman's avatar
Richard M. Stallman committed
825
  return floor (d + 0.5);
826 827 828
}
#endif

829 830 831 832 833 834 835 836
static double
double_identity (d)
     double d;
{
  return d;
}

DEFUN ("ceiling", Fceiling, Sceiling, 1, 2, 0,
837 838
       doc: /* Return the smallest integer no less than ARG.
This rounds the value towards +inf.
839 840
With optional DIVISOR, return the smallest integer no less than ARG/DIVISOR.  */)
     (arg, divisor)
841 842 843 844 845 846
     Lisp_Object arg, divisor;
{
  return rounding_driver (arg, divisor, ceil, ceiling2, "ceiling");
}

DEFUN ("floor", Ffloor, Sfloor, 1, 2, 0,
847
       doc: /* Return the largest integer no greater than ARG.
Lute Kamstra's avatar
Lute Kamstra committed
848
This rounds the value towards -inf.
849 850
With optional DIVISOR, return the largest integer no greater than ARG/DIVISOR.  */)
     (arg, divisor)
851 852 853 854 855 856
     Lisp_Object arg, divisor;
{
  return rounding_driver (arg, divisor, floor, floor2, "floor");
}

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

Eli Zaretskii's avatar
Eli Zaretskii committed
860 861 862
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
863
systems, but 2 on others.  */)
864
     (arg, divisor)
865 866
     Lisp_Object arg, divisor;
{
867
  return rounding_driver (arg, divisor, emacs_rint, round2, "round");
868 869 870
}

DEFUN ("truncate", Ftruncate, Struncate, 1, 2, 0,
871 872 873 874
       doc: /* Truncate a floating point number to an int.
Rounds ARG toward zero.
With optional DIVISOR, truncate ARG/DIVISOR.  */)
     (arg, divisor)
875 876 877 878 879 880
     Lisp_Object arg, divisor;
{
  return rounding_driver (arg, divisor, double_identity, truncate2,
			  "truncate");
}

881

882 883 884 885 886 887
Lisp_Object
fmod_float (x, y)
     register Lisp_Object x, y;
{
  double f1, f2;

888 889
  f1 = FLOATP (x) ? XFLOAT_DATA (x) : XINT (x);
  f2 = FLOATP (y) ? XFLOAT_DATA (y) : XINT (y);
890 891

  if (! IEEE_FLOATING_POINT && f2 == 0)
892
    xsignal0 (Qarith_error);
893 894 895 896 897 898 899

  /* 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);
}
900 901 902 903

/* It's not clear these are worth adding.  */

DEFUN ("fceiling", Ffceiling, Sfceiling, 1, 1, 0,
904 905 906
       doc: /* Return the smallest integer no less than ARG, as a float.
\(Round toward +inf.\)  */)
     (arg)
907 908 909 910 911 912 913 914
     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,
915 916 917
       doc: /* Return the largest integer no greater than ARG, as a float.
\(Round towards -inf.\)  */)
     (arg)
918 919 920 921 922 923
     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
924

925
DEFUN ("fround", Ffround, Sfround, 1, 1, 0,
926 927
       doc: /* Return the nearest integer to ARG, as a float.  */)
     (arg)
928 929 930
     register Lisp_Object arg;
{
  double d = extract_float (arg);
931
  IN_FLOAT (d = emacs_rint (d), "fround", arg);
932 933 934 935
  return make_float (d);
}

DEFUN ("ftruncate", Fftruncate, Sftruncate, 1, 1, 0,
936 937 938
       doc: /* Truncate a floating point number to an integral float value.
Rounds the value toward zero.  */)
     (arg)
939 940 941 942 943 944
     register Lisp_Object arg;
{
  double d = extract_float (arg);
  if (d >= 0.0)