floatfns.c 25.8 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 */

Jim Blandy's avatar
Jim Blandy committed
125
static SIGTYPE float_error ();
Mike Rowan's avatar
Mike Rowan committed
126 127 128 129 130 131 132

/* 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
133 134 135
   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
136

137 138 139
static Lisp_Object float_error_arg, float_error_arg2;

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

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

150 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
#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
177
#define IN_FLOAT(d, name, num) (in_float = 1, (d), in_float = 0)
178 179 180
#define IN_FLOAT2(d, name, num, num2) (in_float = 1, (d), in_float = 0)
#endif

181 182 183 184 185
/* 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									\
    {									\
186 187
      if ((x) >= (((EMACS_INT) 1) << (VALBITS-1)) ||			\
	  (x) <= - (((EMACS_INT) 1) << (VALBITS-1)) - 1)		\
188
	range_error (name, num);					\
189
      XSETINT (i,  (EMACS_INT)(x));					\
190 191 192 193 194
    }									\
  while (0)
#define FLOAT_TO_INT2(x, i, name, num1, num2)				\
  do									\
    {									\
195 196
      if ((x) >= (((EMACS_INT) 1) << (VALBITS-1)) ||			\
	  (x) <= - (((EMACS_INT) 1) << (VALBITS-1)) - 1)		\
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 221 222

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

double
extract_float (num)
     Lisp_Object num;
{
  CHECK_NUMBER_OR_FLOAT (num, 0);

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 231

DEFUN ("acos", Facos, Sacos, 1, 1, 0,
  "Return the inverse cosine of ARG.")
232 233
  (arg)
     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 245
DEFUN ("asin", Fasin, Sasin, 1, 1, 0,
  "Return the inverse sine of ARG.")
246 247
  (arg)
     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
DEFUN ("atan", Fatan, Satan, 1, 1, 0,
  "Return the inverse tangent of ARG.")
260 261
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
262
{
263 264
  double d = extract_float (arg);
  IN_FLOAT (d = atan (d), "atan", arg);
Mike Rowan's avatar
Mike Rowan committed
265 266 267
  return make_float (d);
}

268 269
DEFUN ("cos", Fcos, Scos, 1, 1, 0,
  "Return the cosine of ARG.")
270 271
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
272
{
273 274
  double d = extract_float (arg);
  IN_FLOAT (d = cos (d), "cos", arg);
Mike Rowan's avatar
Mike Rowan committed
275 276 277
  return make_float (d);
}

278 279
DEFUN ("sin", Fsin, Ssin, 1, 1, 0,
  "Return the sine of ARG.")
280 281
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
282
{
283 284
  double d = extract_float (arg);
  IN_FLOAT (d = sin (d), "sin", arg);
Mike Rowan's avatar
Mike Rowan committed
285 286 287
  return make_float (d);
}

288 289
DEFUN ("tan", Ftan, Stan, 1, 1, 0,
  "Return the tangent of ARG.")
290 291 292 293 294 295 296 297 298 299
  (arg)
     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
300 301 302
  return make_float (d);
}

303 304
#if 0 /* Leave these out unless we find there's a reason for them.  */

Mike Rowan's avatar
Mike Rowan committed
305 306
DEFUN ("bessel-j0", Fbessel_j0, Sbessel_j0, 1, 1, 0,
  "Return the bessel function j0 of ARG.")
307 308
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
309
{
310 311
  double d = extract_float (arg);
  IN_FLOAT (d = j0 (d), "bessel-j0", arg);
Mike Rowan's avatar
Mike Rowan committed
312 313 314 315 316
  return make_float (d);
}

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

DEFUN ("bessel-jn", Fbessel_jn, Sbessel_jn, 2, 2, 0,
  "Return the order N bessel function output jn of ARG.\n\
The first arg (the order) is truncated to an integer.")
328 329
  (n, arg)
     register Lisp_Object n, arg;
Mike Rowan's avatar
Mike Rowan committed
330
{
331 332
  int i1 = extract_float (n);
  double f2 = extract_float (arg);
Mike Rowan's avatar
Mike Rowan committed
333

334
  IN_FLOAT (f2 = jn (i1, f2), "bessel-jn", n);
Mike Rowan's avatar
Mike Rowan committed
335 336 337 338 339
  return make_float (f2);
}

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

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

DEFUN ("bessel-yn", Fbessel_yn, Sbessel_yn, 2, 2, 0,
  "Return the order N bessel function output yn of ARG.\n\
The first arg (the order) is truncated to an integer.")
361 362
  (n, arg)
     register Lisp_Object n, arg;
Mike Rowan's avatar
Mike Rowan committed
363
{
364 365
  int i1 = extract_float (n);
  double f2 = extract_float (arg);
Mike Rowan's avatar
Mike Rowan committed
366

367
  IN_FLOAT (f2 = yn (i1, f2), "bessel-yn", n);
Mike Rowan's avatar
Mike Rowan committed
368 369 370
  return make_float (f2);
}

371 372 373
#endif

#if 0 /* Leave these out unless we see they are worth having.  */
Mike Rowan's avatar
Mike Rowan committed
374 375 376

DEFUN ("erf", Ferf, Serf, 1, 1, 0,
  "Return the mathematical error function of ARG.")
377 378
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
379
{
380 381
  double d = extract_float (arg);
  IN_FLOAT (d = erf (d), "erf", arg);
Mike Rowan's avatar
Mike Rowan committed
382 383 384 385 386
  return make_float (d);
}

DEFUN ("erfc", Ferfc, Serfc, 1, 1, 0,
  "Return the complementary error function of ARG.")
387 388
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
389
{
390 391
  double d = extract_float (arg);
  IN_FLOAT (d = erfc (d), "erfc", arg);
Mike Rowan's avatar
Mike Rowan committed
392 393 394 395 396
  return make_float (d);
}

DEFUN ("log-gamma", Flog_gamma, Slog_gamma, 1, 1, 0,
  "Return the log gamma of ARG.")
397 398
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
399
{
400 401
  double d = extract_float (arg);
  IN_FLOAT (d = lgamma (d), "log-gamma", arg);
Mike Rowan's avatar
Mike Rowan committed
402 403 404
  return make_float (d);
}

405
DEFUN ("cube-root", Fcube_root, Scube_root, 1, 1, 0,
406
  "Return the cube root of ARG.")
407 408
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
409
{
410 411 412 413 414 415 416 417 418
  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
419 420 421
  return make_float (d);
}

Richard M. Stallman's avatar
Richard M. Stallman committed
422 423
#endif

424 425
DEFUN ("exp", Fexp, Sexp, 1, 1, 0,
  "Return the exponential base e of ARG.")
426 427 428 429 430 431 432 433 434 435 436 437
  (arg)
     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
438 439 440 441
  return make_float (d);
}

DEFUN ("expt", Fexpt, Sexpt, 2, 2, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
442
  "Return the exponential ARG1 ** ARG2.")
443 444
  (arg1, arg2)
     register Lisp_Object arg1, arg2;
Mike Rowan's avatar
Mike Rowan committed
445 446 447
{
  double f1, f2;

448 449
  CHECK_NUMBER_OR_FLOAT (arg1, 0);
  CHECK_NUMBER_OR_FLOAT (arg2, 0);
450 451
  if (INTEGERP (arg1)     /* common lisp spec */
      && INTEGERP (arg2)) /* don't promote, if both are ints */
Mike Rowan's avatar
Mike Rowan committed
452
    {				/* this can be improved by pre-calculating */
453
      EMACS_INT acc, x, y;	/* some binary powers of x then accumulating */
454 455
      Lisp_Object val;

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

495
DEFUN ("log", Flog, Slog, 1, 2, 0,
496 497 498 499
  "Return the natural logarithm of ARG.\n\
If second optional argument BASE is given, return log ARG using that base.")
  (arg, base)
     register Lisp_Object arg, base;
Mike Rowan's avatar
Mike Rowan committed
500
{
501
  double d = extract_float (arg);
502

503 504 505 506
#ifdef FLOAT_CHECK_DOMAIN
  if (d <= 0.0)
    domain_error2 ("log", arg, base);
#endif
507
  if (NILP (base))
508
    IN_FLOAT (d = log (d), "log", arg);
509 510 511 512
  else
    {
      double b = extract_float (base);

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

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

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

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

DEFUN ("asinh", Fasinh, Sasinh, 1, 1, 0,
  "Return the inverse hyperbolic sine of ARG.")
575 576
  (arg)
     register Lisp_Object arg;
577
{
578 579 580 581 582 583
  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
584 585 586 587 588
  return make_float (d);
}

DEFUN ("atanh", Fatanh, Satanh, 1, 1, 0,
  "Return the inverse hyperbolic tangent of ARG.")
589 590
  (arg)
     register Lisp_Object arg;
591
{
592 593 594 595 596 597 598 599 600 601
  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
602 603 604 605 606
  return make_float (d);
}

DEFUN ("cosh", Fcosh, Scosh, 1, 1, 0,
  "Return the hyperbolic cosine of ARG.")
607 608
  (arg)
     register Lisp_Object arg;
609
{
610 611 612 613 614 615
  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);
616 617 618 619 620
  return make_float (d);
}

DEFUN ("sinh", Fsinh, Ssinh, 1, 1, 0,
  "Return the hyperbolic sine of ARG.")
621 622
  (arg)
     register Lisp_Object arg;
623
{
624 625 626 627 628 629
  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
630 631 632 633 634
  return make_float (d);
}

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

651
  if (FLOATP (arg))
652
    IN_FLOAT (arg = make_float (fabs (XFLOAT_DATA (arg))), "abs", arg);
653
  else if (XINT (arg) < 0)
654
    XSETINT (arg, - XINT (arg));
Mike Rowan's avatar
Mike Rowan committed
655

656
  return arg;
Mike Rowan's avatar
Mike Rowan committed
657 658 659 660
}

DEFUN ("float", Ffloat, Sfloat, 1, 1, 0,
  "Return the floating point number equal to ARG.")
661 662
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
663
{
664
  CHECK_NUMBER_OR_FLOAT (arg, 0);
Mike Rowan's avatar
Mike Rowan committed
665

666
  if (INTEGERP (arg))
667
    return make_float ((double) XINT (arg));
Mike Rowan's avatar
Mike Rowan committed
668
  else				/* give 'em the same float back */
669
    return arg;
Mike Rowan's avatar
Mike Rowan committed
670 671 672
}

DEFUN ("logb", Flogb, Slogb, 1, 1, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
673
  "Returns largest integer <= the base 2 log of the magnitude of ARG.\n\
Mike Rowan's avatar
Mike Rowan committed
674
This is the same as the exponent of a float.")
675 676
     (arg)
     Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
677
{
678
  Lisp_Object val;
679
  EMACS_INT value;
680
  double f = extract_float (arg);
681

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

720

721 722 723 724
/* the rounding functions  */

static Lisp_Object
rounding_driver (arg, divisor, double_round, int_round2, name)
725
     register Lisp_Object arg, divisor;
726 727 728
     double (*double_round) ();
     EMACS_INT (*int_round2) ();
     char *name;
Mike Rowan's avatar
Mike Rowan committed
729
{
730
  CHECK_NUMBER_OR_FLOAT (arg, 0);
Mike Rowan's avatar
Mike Rowan committed
731

732 733
  if (! NILP (divisor))
    {
734
      EMACS_INT i1, i2;
735 736 737

      CHECK_NUMBER_OR_FLOAT (divisor, 1);

738
      if (FLOATP (arg) || FLOATP (divisor))
739 740 741
	{
	  double f1, f2;

742 743
	  f1 = FLOATP (arg) ? XFLOAT_DATA (arg) : XINT (arg);
	  f2 = (FLOATP (divisor) ? XFLOAT_DATA (divisor) : XINT (divisor));
744
	  if (! IEEE_FLOATING_POINT && f2 == 0)
745 746
	    Fsignal (Qarith_error, Qnil);

747 748
	  IN_FLOAT2 (f1 = (*double_round) (f1 / f2), name, arg, divisor);
	  FLOAT_TO_INT2 (f1, arg, name, arg, divisor);
749 750 751 752 753 754 755 756 757
	  return arg;
	}

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

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

758
      XSETINT (arg, (*int_round2) (i1, i2));
759 760 761
      return arg;
    }

762
  if (FLOATP (arg))
763 764
    {
      double d;
765

766
      IN_FLOAT (d = (*double_round) (XFLOAT_DATA (arg)), name, arg);
767
      FLOAT_TO_INT (d, arg, name, arg);
768
    }
Mike Rowan's avatar
Mike Rowan committed
769

770
  return arg;
Mike Rowan's avatar
Mike Rowan committed
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 816 817 818 819
/* 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);
}

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

833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863
static double
double_identity (d)
     double d;
{
  return d;
}

DEFUN ("ceiling", Fceiling, Sceiling, 1, 2, 0,
  "Return the smallest integer no less than ARG.  (Round toward +inf.)\n\
With optional DIVISOR, return the smallest integer no less than ARG/DIVISOR.")
  (arg, divisor)
     Lisp_Object arg, divisor;
{
  return rounding_driver (arg, divisor, ceil, ceiling2, "ceiling");
}

DEFUN ("floor", Ffloor, Sfloor, 1, 2, 0,
  "Return the largest integer no greater than ARG.  (Round towards -inf.)\n\
With optional DIVISOR, return the largest integer no greater than ARG/DIVISOR.")
  (arg, divisor)
     Lisp_Object arg, divisor;
{
  return rounding_driver (arg, divisor, floor, floor2, "floor");
}

DEFUN ("round", Fround, Sround, 1, 2, 0,
  "Return the nearest integer to ARG.\n\
With optional DIVISOR, return the nearest integer to ARG/DIVISOR.")
  (arg, divisor)
     Lisp_Object arg, divisor;
{
864
  return rounding_driver (arg, divisor, emacs_rint, round2, "round");
865 866 867 868 869 870 871 872 873 874 875 876 877
}

DEFUN ("truncate", Ftruncate, Struncate, 1, 2, 0,
       "Truncate a floating point number to an int.\n\
Rounds ARG toward zero.\n\
With optional DIVISOR, truncate ARG/DIVISOR.")
  (arg, divisor)
     Lisp_Object arg, divisor;
{
  return rounding_driver (arg, divisor, double_identity, truncate2,
			  "truncate");
}

878

879 880 881 882 883 884
Lisp_Object
fmod_float (x, y)
     register Lisp_Object x, y;
{
  double f1, f2;

885 886
  f1 = FLOATP (x) ? XFLOAT_DATA (x) : XINT (x);
  f2 = FLOATP (y) ? XFLOAT_DATA (y) : XINT (y);
887 888 889 890 891 892 893 894 895 896

  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);
}
897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920

/* It's not clear these are worth adding.  */

DEFUN ("fceiling", Ffceiling, Sfceiling, 1, 1, 0,
  "Return the smallest integer no less than ARG, as a float.\n\
\(Round toward +inf.\)")
  (arg)
     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,
  "Return the largest integer no greater than ARG, as a float.\n\
\(Round towards -inf.\)")
  (arg)
     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
921

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

DEFUN ("ftruncate", Fftruncate, Sftruncate, 1, 1, 0,
933
  "Truncate a floating point number to an integral float value.\n\
934 935 936 937 938 939 940 941
Rounds the value toward zero.")
  (arg)
     register Lisp_Object arg;
{
  double d = extract_float (arg);
  if (d >= 0.0)
    IN_FLOAT (d = floor (d), "ftruncate", arg);
  else
942
    IN_FLOAT (d = ceil (d), "ftruncate", arg);
943
  return make_float (d);
Mike Rowan's avatar
Mike Rowan committed
944 945
}

946
#ifdef FLOAT_CATCH_SIGILL
Jim Blandy's avatar
Jim Blandy committed
947
static SIGTYPE
Mike Rowan's avatar
Mike Rowan committed
948 949 950 951 952 953
float_error (signo)
     int signo;
{
  if (! in_float)
    fatal_error_signal (signo);

954
#ifdef BSD_SYSTEM
Mike Rowan's avatar
Mike Rowan committed
955 956 957
#ifdef BSD4_1
  sigrelse (SIGILL);
#else /* not BSD4_1 */
Jim Blandy's avatar
Jim Blandy committed
958
  sigsetmask (SIGEMPTYMASK);
Mike Rowan's avatar
Mike Rowan committed
959
#endif /* not BSD4_1 */
Jim Blandy's avatar
Jim Blandy committed
960 961 962
#else
  /* Must reestablish handler each time it is called.  */
  signal (SIGILL, float_error);
963
#endif /* BSD_SYSTEM */
Mike Rowan's avatar
Mike Rowan committed
964 965 966 967 968 969

  in_float = 0;

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

970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004
/* Another idea was to replace the library function `infnan'
   where SIGILL is signaled.  */

#endif /* FLOAT_CATCH_SIGILL */

#ifdef HAVE_MATHERR
int 
matherr (x)
     struct exception *x;
{
  Lisp_Object args;
  if (! in_float)
    /* Not called from emacs-lisp float routines; do the default thing. */
    return 0;
  if (!strcmp (x->name, "pow"))
    x->name = "expt";

  args
    = Fcons (build_string (x->name),
	     Fcons (make_float (x->arg1),
		    ((!strcmp (x->name, "log") || !strcmp (x->name, "pow"))
		     ? Fcons (make_float (x->arg2), Qnil)
		     : Qnil)));
  switch (x->type)
    {
    case DOMAIN:	Fsignal (Qdomain_error, args);		break;
    case SING:		Fsignal (Qsingularity_error, args);	break;
    case OVERFLOW:	Fsignal (Qoverflow_error, args);	break;
    case UNDERFLOW:	Fsignal (Qunderflow_error, args);	break;
    default:		Fsignal (Qarith_error, args);		break;
    }
  return (1);	/* don't set errno or print a message */
}
#endif /* HAVE_MATHERR */

Andreas Schwab's avatar
Andreas Schwab committed
1005
void
Mike Rowan's avatar
Mike Rowan committed
1006 1007
init_floatfns ()
{
1008
#ifdef FLOAT_CATCH_SIGILL
Mike Rowan's avatar
Mike Rowan committed
1009
  signal (SIGILL, float_error);
1010
#endif 
Mike Rowan's avatar
Mike Rowan committed
1011 1012 1013
  in_float = 0;
}

Andreas Schwab's avatar
Andreas Schwab committed
1014
void
Mike Rowan's avatar
Mike Rowan committed
1015 1016 1017 1018 1019
syms_of_floatfns ()
{
  defsubr (&Sacos);
  defsubr (&Sasin);
  defsubr (&Satan);
1020 1021 1022 1023 1024 1025
  defsubr (&Scos);
  defsubr (&Ssin);
  defsubr (&Stan);
#if 0
  defsubr (&Sacosh);
  defsubr (&Sasinh);
Mike Rowan's avatar
Mike Rowan committed
1026
  defsubr (&Satanh);
1027 1028 1029
  defsubr (&Scosh);
  defsubr (&Ssinh);
  defsubr (&Stanh);
Mike Rowan's avatar
Mike Rowan committed
1030 1031 1032 1033 1034 1035 1036 1037
  defsubr (&Sbessel_y0);
  defsubr (&Sbessel_y1);
  defsubr (&Sbessel_yn);
  defsubr (&Sbessel_j0);
  defsubr (&Sbessel_j1);
  defsubr (&Sbessel_jn);
  defsubr (&Serf);
  defsubr (&Serfc);
1038
  defsubr (&Slog_gamma);
1039
  defsubr (&Scube_root);
1040
#endif
1041 1042 1043 1044
  defsubr (&Sfceiling);
  defsubr (&Sffloor);
  defsubr (&Sfround);
  defsubr (&Sftruncate);
Mike Rowan's avatar
Mike Rowan committed
1045
  defsubr (&Sexp);
1046
  defsubr (&Sexpt);
Mike Rowan's avatar
Mike Rowan committed
1047 1048 1049 1050 1051 1052 1053 1054
  defsubr (&Slog);
  defsubr (&Slog10);
  defsubr (&Ssqrt);

  defsubr (&Sabs);
  defsubr (&Sfloat);
  defsubr (&Slogb);
  defsubr (&Sceiling);
1055
  defsubr (&Sfloor);
Mike Rowan's avatar
Mike Rowan committed
1056 1057 1058
  defsubr (&Sround);
  defsubr (&Struncate);
}