floatfns.c 26.9 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 Free Software Foundation, Inc.
Mike Rowan's avatar
Mike Rowan committed
3 4 5 6 7

This file is part of GNU Emacs.

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

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
18 19
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Mike Rowan's avatar
Mike Rowan committed
20 21


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

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

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

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

66 67 68 69 70 71 72 73 74 75
/* Work around a problem that happens because math.h on hpux 7
   defines two static variables--which, in Emacs, are not really static,
   because `static' is defined as nothing.  The problem is that they are
   defined both here and in lread.c.
   These macros prevent the name conflict.  */
#if defined (HPUX) && !defined (HPUX8)
#define _MAXLDBL floatfns_maxldbl
#define _NMAXLDBL floatfns_nmaxldbl
#endif

Mike Rowan's avatar
Mike Rowan committed
76
#include <math.h>
77

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

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

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

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

/* Avoid traps on VMS from sinh and cosh.
   All the other functions set errno instead.  */

#ifdef VMS
#undef cosh
#undef sinh
#define cosh(x) ((exp(x)+exp(-x))*0.5)
#define sinh(x) ((exp(x)-exp(-x))*0.5)
#endif /* VMS */

125
#ifdef FLOAT_CATCH_SIGILL
Jim Blandy's avatar
Jim Blandy committed
126
static SIGTYPE float_error ();
127
#endif
Mike Rowan's avatar
Mike Rowan committed
128 129 130 131 132 133 134

/* 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
135 136 137
   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
138

139 140 141
static Lisp_Object float_error_arg, float_error_arg2;

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

Jim Blandy's avatar
Jim Blandy committed
143 144 145
/* Evaluate the floating point expression D, recording NUM
   as the original argument for error messages.
   D is normally an assignment expression.
146 147 148 149 150
   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
151

152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
#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
179
#define IN_FLOAT(d, name, num) (in_float = 1, (d), in_float = 0)
180 181 182
#define IN_FLOAT2(d, name, num, num2) (in_float = 1, (d), in_float = 0)
#endif

183 184 185 186 187
/* 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									\
    {									\
188
      if (FIXNUM_OVERFLOW_P (x))					\
189
	range_error (name, num);					\
190
      XSETINT (i,  (EMACS_INT)(x));					\
191 192 193 194 195
    }									\
  while (0)
#define FLOAT_TO_INT2(x, i, name, num1, num2)				\
  do									\
    {									\
196
      if (FIXNUM_OVERFLOW_P (x))					\
197
	range_error2 (name, num1, num2);				\
198
      XSETINT (i,  (EMACS_INT)(x));					\
199 200 201
    }									\
  while (0)

202 203 204 205
#define arith_error(op,arg) \
  Fsignal (Qarith_error, Fcons (build_string ((op)), Fcons ((arg), Qnil)))
#define range_error(op,arg) \
  Fsignal (Qrange_error, Fcons (build_string ((op)), Fcons ((arg), Qnil)))
206 207 208
#define range_error2(op,a1,a2) \
  Fsignal (Qrange_error, Fcons (build_string ((op)), \
				Fcons ((a1), Fcons ((a2), Qnil))))
209 210 211
#define domain_error(op,arg) \
  Fsignal (Qdomain_error, Fcons (build_string ((op)), Fcons ((arg), Qnil)))
#define domain_error2(op,a1,a2) \
212 213
  Fsignal (Qdomain_error, Fcons (build_string ((op)), \
				 Fcons ((a1), Fcons ((a2), Qnil))))
Mike Rowan's avatar
Mike Rowan committed
214 215 216 217 218 219 220

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

DEFUN ("erf", Ferf, Serf, 1, 1, 0,
388 389
       doc: /* Return the mathematical error function 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 = erf (d), "erf", arg);
Mike Rowan's avatar
Mike Rowan committed
394 395 396 397
  return make_float (d);
}

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

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

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

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

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

460 461
  CHECK_NUMBER_OR_FLOAT (arg1);
  CHECK_NUMBER_OR_FLOAT (arg2);
462 463
  if (INTEGERP (arg1)     /* common lisp spec */
      && INTEGERP (arg2)) /* don't promote, if both are ints */
Mike Rowan's avatar
Mike Rowan committed
464
    {				/* this can be improved by pre-calculating */
465
      EMACS_INT acc, x, y;	/* some binary powers of x then accumulating */
466 467
      Lisp_Object val;

468 469
      x = XINT (arg1);
      y = XINT (arg2);
Mike Rowan's avatar
Mike Rowan committed
470 471 472 473
      acc = 1;
      
      if (y < 0)
	{
474 475 476 477 478 479
	  if (x == 1)
	    acc = 1;
	  else if (x == -1)
	    acc = (y & 1) ? -1 : 1;
	  else
	    acc = 0;
Mike Rowan's avatar
Mike Rowan committed
480 481 482
	}
      else
	{
483 484 485 486 487 488 489
	  while (y > 0)
	    {
	      if (y & 1)
		acc *= x;
	      x *= x;
	      y = (unsigned)y >> 1;
	    }
Mike Rowan's avatar
Mike Rowan committed
490
	}
491
      XSETINT (val, acc);
492
      return val;
Mike Rowan's avatar
Mike Rowan committed
493
    }
494 495
  f1 = FLOATP (arg1) ? XFLOAT_DATA (arg1) : XINT (arg1);
  f2 = FLOATP (arg2) ? XFLOAT_DATA (arg2) : XINT (arg2);
496 497 498 499 500 501 502
  /* Really should check for overflow, too */
  if (f1 == 0.0 && f2 == 0.0)
    f1 = 1.0;
#ifdef FLOAT_CHECK_DOMAIN
  else if ((f1 == 0.0 && f2 < 0.0) || (f1 < 0 && f2 != floor(f2)))
    domain_error2 ("expt", arg1, arg2);
#endif
Richard M. Stallman's avatar
Richard M. Stallman committed
503
  IN_FLOAT2 (f1 = pow (f1, f2), "expt", arg1, arg2);
Mike Rowan's avatar
Mike Rowan committed
504 505
  return make_float (f1);
}
506

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

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

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

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

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

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

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

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

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

DEFUN ("sinh", Fsinh, Ssinh, 1, 1, 0,
632 633
       doc: /* Return the hyperbolic sine of ARG.  */)
     (arg)
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 ("sinh", arg);
#endif
  IN_FLOAT (d = sinh (d), "sinh", arg);
Mike Rowan's avatar
Mike Rowan committed
642 643 644 645
  return make_float (d);
}

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

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

668
  return arg;
Mike Rowan's avatar
Mike Rowan committed
669 670 671
}

DEFUN ("float", Ffloat, Sfloat, 1, 1, 0,
672 673
       doc: /* Return the floating point number equal to ARG.  */)
     (arg)
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 (INTEGERP (arg))
679
    return make_float ((double) XINT (arg));
Mike Rowan's avatar
Mike Rowan committed
680
  else				/* give 'em the same float back */
681
    return arg;
Mike Rowan's avatar
Mike Rowan committed
682 683 684
}

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

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

732

733 734 735 736
/* the rounding functions  */

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

744 745
  if (! NILP (divisor))
    {
746
      EMACS_INT i1, i2;
747

748
      CHECK_NUMBER_OR_FLOAT (divisor);
749

750
      if (FLOATP (arg) || FLOATP (divisor))
751 752 753
	{
	  double f1, f2;

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

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

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

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

770
      XSETINT (arg, (*int_round2) (i1, i2));
771 772 773
      return arg;
    }

774
  if (FLOATP (arg))
775 776
    {
      double d;
777

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

782
  return arg;
Mike Rowan's avatar
Mike Rowan committed
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 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831
/* 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);
}

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

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

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

DEFUN ("floor", Ffloor, Sfloor, 1, 2, 0,
863 864
       doc: /* Return the largest integer no greater than ARG.
This rounds the value towards +inf.
865 866
With optional DIVISOR, return the largest integer no greater than ARG/DIVISOR.  */)
     (arg, divisor)
867 868 869 870 871 872
     Lisp_Object arg, divisor;
{
  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.  */)
880
     (arg, divisor)
881 882
     Lisp_Object arg, divisor;
{
883
  return rounding_driver (arg, divisor, emacs_rint, round2, "round");
884 885 886
}

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

897

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

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

  if (! IEEE_FLOATING_POINT && f2 == 0)
    Fsignal (Qarith_error, Qnil);

  /* If the "remainder" comes out with the wrong sign, fix it.  */
  IN_FLOAT2 ((f1 = fmod (f1, f2),
	      f1 = (f2 < 0 ? f1 > 0 : f1 < 0) ? f1 + f2 : f1),
	     "mod", x, y);
  return make_float (f1);
}
916 917 918 919

/* It's not clear these are worth adding.  */

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

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

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

973
#ifdef BSD_SYSTEM
Mike Rowan's avatar
Mike Rowan committed
974 975 976
#ifdef BSD4_1
  sigrelse (SIGILL);
#else /* not BSD4_1 */
Jim Blandy's avatar
Jim Blandy committed
977
  sigsetmask (SIGEMPTYMASK);
Mike Rowan's avatar
Mike Rowan committed
978
#endif /* not BSD4_1 */
Jim Blandy's avatar
Jim Blandy committed
979 980 981
#else
  /* Must reestablish handler each time it is called.  */
  signal (SIGILL, float_error);
982
#endif /* BSD_SYSTEM */
Mike Rowan's avatar
Mike Rowan committed
983 984 985 986 987 988

  in_float = 0;

  Fsignal (Qarith_error, Fcons (float_error_arg, Qnil));
}