floatfns.c 21 KB
Newer Older
Mike Rowan's avatar
Mike Rowan committed
1
/* Primitive operations on floating point for GNU Emacs Lisp interpreter.
Jim Blandy's avatar
Jim Blandy committed
2
   Copyright (C) 1988, 1993 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 18 19 20
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
the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */


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

Mike Rowan's avatar
Mike Rowan committed
46 47 48 49
#include <signal.h>

#include "config.h"
#include "lisp.h"
Jim Blandy's avatar
Jim Blandy committed
50
#include "syssignal.h"
Mike Rowan's avatar
Mike Rowan committed
51 52 53 54

Lisp_Object Qarith_error;

#ifdef LISP_FLOAT_TYPE
Jim Blandy's avatar
Jim Blandy committed
55

Mike Rowan's avatar
Mike Rowan committed
56
#include <math.h>
57

58 59 60
/* These declarations are omitted on some systems, like Ultrix.  */
extern double logb ();

61 62 63 64 65 66 67
#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

68 69 70 71
#ifndef NO_MATHERR
#undef HAVE_MATHERR
#endif

72 73 74 75 76 77 78 79 80 81 82 83 84 85 86
#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
87 88

extern int errno;
89
#endif
Jim Blandy's avatar
Jim Blandy committed
90 91 92 93 94 95 96 97 98 99 100

/* 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 */

101 102 103 104
#ifndef HAVE_RINT
#define rint(x) (floor((x)+0.5))
#endif

Jim Blandy's avatar
Jim Blandy committed
105
static SIGTYPE float_error ();
Mike Rowan's avatar
Mike Rowan committed
106 107 108 109 110 111 112

/* Nonzero while executing in floating point.
   This tells float_error what to do.  */

static int in_float;

/* If an argument is out of range for a mathematical function,
Jim Blandy's avatar
Jim Blandy committed
113
   here is the actual argument value to use in the error message.  */
Mike Rowan's avatar
Mike Rowan committed
114

115 116 117
static Lisp_Object float_error_arg, float_error_arg2;

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

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

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

#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)))
#define domain_error(op,arg) \
  Fsignal (Qdomain_error, Fcons (build_string ((op)), Fcons ((arg), Qnil)))
#define domain_error2(op,a1,a2) \
  Fsignal (Qdomain_error, Fcons (build_string ((op)), Fcons ((a1), Fcons ((a2), Qnil))))
Mike Rowan's avatar
Mike Rowan committed
166 167 168 169 170 171 172 173 174 175 176 177 178

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

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

  if (XTYPE (num) == Lisp_Float)
    return XFLOAT (num)->data;
  return (double) XINT (num);
}
179 180

/* Trig functions.  */
Mike Rowan's avatar
Mike Rowan committed
181 182 183

DEFUN ("acos", Facos, Sacos, 1, 1, 0,
  "Return the inverse cosine of ARG.")
184 185
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
186
{
187 188 189 190 191 192
  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
193 194 195
  return make_float (d);
}

196 197
DEFUN ("asin", Fasin, Sasin, 1, 1, 0,
  "Return the inverse sine of ARG.")
198 199
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
200
{
201 202 203 204 205 206
  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
207 208 209
  return make_float (d);
}

210 211
DEFUN ("atan", Fatan, Satan, 1, 1, 0,
  "Return the inverse tangent of ARG.")
212 213
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
214
{
215 216
  double d = extract_float (arg);
  IN_FLOAT (d = atan (d), "atan", arg);
Mike Rowan's avatar
Mike Rowan committed
217 218 219
  return make_float (d);
}

220 221
DEFUN ("cos", Fcos, Scos, 1, 1, 0,
  "Return the cosine of ARG.")
222 223
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
224
{
225 226
  double d = extract_float (arg);
  IN_FLOAT (d = cos (d), "cos", arg);
Mike Rowan's avatar
Mike Rowan committed
227 228 229
  return make_float (d);
}

230 231
DEFUN ("sin", Fsin, Ssin, 1, 1, 0,
  "Return the sine of ARG.")
232 233
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
234
{
235 236
  double d = extract_float (arg);
  IN_FLOAT (d = sin (d), "sin", arg);
Mike Rowan's avatar
Mike Rowan committed
237 238 239
  return make_float (d);
}

240 241
DEFUN ("tan", Ftan, Stan, 1, 1, 0,
  "Return the tangent of ARG.")
242 243 244 245 246 247 248 249 250 251
  (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
252 253 254
  return make_float (d);
}

255 256
#if 0 /* Leave these out unless we find there's a reason for them.  */

Mike Rowan's avatar
Mike Rowan committed
257 258
DEFUN ("bessel-j0", Fbessel_j0, Sbessel_j0, 1, 1, 0,
  "Return the bessel function j0 of ARG.")
259 260
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
261
{
262 263
  double d = extract_float (arg);
  IN_FLOAT (d = j0 (d), "bessel-j0", arg);
Mike Rowan's avatar
Mike Rowan committed
264 265 266 267 268
  return make_float (d);
}

DEFUN ("bessel-j1", Fbessel_j1, Sbessel_j1, 1, 1, 0,
  "Return the bessel function j1 of ARG.")
269 270
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
271
{
272 273
  double d = extract_float (arg);
  IN_FLOAT (d = j1 (d), "bessel-j1", arg);
Mike Rowan's avatar
Mike Rowan committed
274 275 276 277 278 279
  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.")
280 281
  (arg1, arg2)
     register Lisp_Object arg1, arg2;
Mike Rowan's avatar
Mike Rowan committed
282
{
283 284
  int i1 = extract_float (arg1);
  double f2 = extract_float (arg2);
Mike Rowan's avatar
Mike Rowan committed
285

286
  IN_FLOAT (f2 = jn (i1, f2), "bessel-jn", arg1);
Mike Rowan's avatar
Mike Rowan committed
287 288 289 290 291
  return make_float (f2);
}

DEFUN ("bessel-y0", Fbessel_y0, Sbessel_y0, 1, 1, 0,
  "Return the bessel function y0 of ARG.")
292 293
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
294
{
295 296
  double d = extract_float (arg);
  IN_FLOAT (d = y0 (d), "bessel-y0", arg);
Mike Rowan's avatar
Mike Rowan committed
297 298 299 300 301
  return make_float (d);
}

DEFUN ("bessel-y1", Fbessel_y1, Sbessel_y1, 1, 1, 0,
  "Return the bessel function y1 of ARG.")
302 303
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
304
{
305 306
  double d = extract_float (arg);
  IN_FLOAT (d = y1 (d), "bessel-y0", arg);
Mike Rowan's avatar
Mike Rowan committed
307 308 309 310 311 312
  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.")
313 314
  (arg1, arg2)
     register Lisp_Object arg1, arg2;
Mike Rowan's avatar
Mike Rowan committed
315
{
316 317
  int i1 = extract_float (arg1);
  double f2 = extract_float (arg2);
Mike Rowan's avatar
Mike Rowan committed
318

319
  IN_FLOAT (f2 = yn (i1, f2), "bessel-yn", arg1);
Mike Rowan's avatar
Mike Rowan committed
320 321 322
  return make_float (f2);
}

323 324 325
#endif

#if 0 /* Leave these out unless we see they are worth having.  */
Mike Rowan's avatar
Mike Rowan committed
326 327 328

DEFUN ("erf", Ferf, Serf, 1, 1, 0,
  "Return the mathematical error function of ARG.")
329 330
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
331
{
332 333
  double d = extract_float (arg);
  IN_FLOAT (d = erf (d), "erf", arg);
Mike Rowan's avatar
Mike Rowan committed
334 335 336 337 338
  return make_float (d);
}

DEFUN ("erfc", Ferfc, Serfc, 1, 1, 0,
  "Return the complementary error function of ARG.")
339 340
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
341
{
342 343
  double d = extract_float (arg);
  IN_FLOAT (d = erfc (d), "erfc", arg);
Mike Rowan's avatar
Mike Rowan committed
344 345 346 347 348
  return make_float (d);
}

DEFUN ("log-gamma", Flog_gamma, Slog_gamma, 1, 1, 0,
  "Return the log gamma of ARG.")
349 350
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
351
{
352 353
  double d = extract_float (arg);
  IN_FLOAT (d = lgamma (d), "log-gamma", arg);
Mike Rowan's avatar
Mike Rowan committed
354 355 356
  return make_float (d);
}

357
DEFUN ("cube-root", Fcube_root, Scube_root, 1, 1, 0,
358
  "Return the cube root of ARG.")
359 360
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
361
{
362 363 364 365 366 367 368 369 370
  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
371 372 373
  return make_float (d);
}

Richard M. Stallman's avatar
Richard M. Stallman committed
374 375
#endif

376 377
DEFUN ("exp", Fexp, Sexp, 1, 1, 0,
  "Return the exponential base e of ARG.")
378 379 380 381 382 383 384 385 386 387 388 389
  (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
390 391 392 393
  return make_float (d);
}

DEFUN ("expt", Fexpt, Sexpt, 2, 2, 0,
394
  "Return the exponential X ** Y.")
395 396
  (arg1, arg2)
     register Lisp_Object arg1, arg2;
Mike Rowan's avatar
Mike Rowan committed
397 398 399
{
  double f1, f2;

400 401 402 403
  CHECK_NUMBER_OR_FLOAT (arg1, 0);
  CHECK_NUMBER_OR_FLOAT (arg2, 0);
  if ((XTYPE (arg1) == Lisp_Int) && /* common lisp spec */
      (XTYPE (arg2) == Lisp_Int)) /* don't promote, if both are ints */
Mike Rowan's avatar
Mike Rowan committed
404 405 406
    {				/* this can be improved by pre-calculating */
      int acc, x, y;		/* some binary powers of x then acumulating */
      /* these, therby saving some time. -wsr */
407 408
      x = XINT (arg1);
      y = XINT (arg2);
Mike Rowan's avatar
Mike Rowan committed
409 410 411 412
      acc = 1;
      
      if (y < 0)
	{
413 414 415 416 417 418
	  if (x == 1)
	    acc = 1;
	  else if (x == -1)
	    acc = (y & 1) ? -1 : 1;
	  else
	    acc = 0;
Mike Rowan's avatar
Mike Rowan committed
419 420 421 422
	}
      else
	{
	  for (; y > 0; y--)
423 424 425 426 427 428 429
	  while (y > 0)
	    {
	      if (y & 1)
		acc *= x;
	      x *= x;
	      y = (unsigned)y >> 1;
	    }
Mike Rowan's avatar
Mike Rowan committed
430
	}
431
      XSET (x, Lisp_Int, acc);
432
      return x;
Mike Rowan's avatar
Mike Rowan committed
433
    }
434 435 436 437 438 439 440 441 442 443
  f1 = (XTYPE (arg1) == Lisp_Float) ? XFLOAT (arg1)->data : XINT (arg1);
  f2 = (XTYPE (arg2) == Lisp_Float) ? XFLOAT (arg2)->data : XINT (arg2);
  /* 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
  IN_FLOAT (f1 = pow (f1, f2), "expt", arg1);
Mike Rowan's avatar
Mike Rowan committed
444 445
  return make_float (f1);
}
446

447
DEFUN ("log", Flog, Slog, 1, 2, 0,
448 449 450 451
  "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
452
{
453
  double d = extract_float (arg);
454

455 456 457 458
#ifdef FLOAT_CHECK_DOMAIN
  if (d <= 0.0)
    domain_error2 ("log", arg, base);
#endif
459
  if (NILP (base))
460
    IN_FLOAT (d = log (d), "log", arg);
461 462 463 464
  else
    {
      double b = extract_float (base);

465 466 467 468 469 470 471 472
#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
	IN_FLOAT2 (d = log (arg) / log (b), "log", arg, base);
473
    }
Mike Rowan's avatar
Mike Rowan committed
474 475 476
  return make_float (d);
}

477 478
DEFUN ("log10", Flog10, Slog10, 1, 1, 0,
  "Return the logarithm base 10 of ARG.")
479 480
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
481
{
482 483 484 485 486 487
  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);
488 489 490
  return make_float (d);
}

Mike Rowan's avatar
Mike Rowan committed
491 492
DEFUN ("sqrt", Fsqrt, Ssqrt, 1, 1, 0,
  "Return the square root of ARG.")
493 494
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
495
{
496 497 498 499 500 501
  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
502 503
  return make_float (d);
}
504

Richard M. Stallman's avatar
Richard M. Stallman committed
505
#if 0 /* Not clearly worth adding.  */
Mike Rowan's avatar
Mike Rowan committed
506

507 508
DEFUN ("acosh", Facosh, Sacosh, 1, 1, 0,
  "Return the inverse hyperbolic cosine of ARG.")
509 510
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
511
{
512 513 514 515 516 517 518 519 520 521
  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
522 523 524 525 526
  return make_float (d);
}

DEFUN ("asinh", Fasinh, Sasinh, 1, 1, 0,
  "Return the inverse hyperbolic sine of ARG.")
527 528
  (arg)
     register Lisp_Object arg;
529
{
530 531 532 533 534 535
  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
536 537 538 539 540
  return make_float (d);
}

DEFUN ("atanh", Fatanh, Satanh, 1, 1, 0,
  "Return the inverse hyperbolic tangent of ARG.")
541 542
  (arg)
     register Lisp_Object arg;
543
{
544 545 546 547 548 549 550 551 552 553
  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
554 555 556 557 558
  return make_float (d);
}

DEFUN ("cosh", Fcosh, Scosh, 1, 1, 0,
  "Return the hyperbolic cosine of ARG.")
559 560
  (arg)
     register Lisp_Object arg;
561
{
562 563 564 565 566 567
  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);
568 569 570 571 572
  return make_float (d);
}

DEFUN ("sinh", Fsinh, Ssinh, 1, 1, 0,
  "Return the hyperbolic sine of ARG.")
573 574
  (arg)
     register Lisp_Object arg;
575
{
576 577 578 579 580 581
  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
582 583 584 585 586
  return make_float (d);
}

DEFUN ("tanh", Ftanh, Stanh, 1, 1, 0,
  "Return the hyperbolic tangent of ARG.")
587 588
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
589
{
590 591
  double d = extract_float (arg);
  IN_FLOAT (d = tanh (d), "tanh", arg);
Mike Rowan's avatar
Mike Rowan committed
592 593
  return make_float (d);
}
594
#endif
Mike Rowan's avatar
Mike Rowan committed
595 596 597

DEFUN ("abs", Fabs, Sabs, 1, 1, 0,
  "Return the absolute value of ARG.")
598 599
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
600
{
601
  CHECK_NUMBER_OR_FLOAT (arg, 0);
Mike Rowan's avatar
Mike Rowan committed
602

603 604 605 606
  if (XTYPE (arg) == Lisp_Float)
    IN_FLOAT (arg = make_float (fabs (XFLOAT (arg)->data)), "abs", arg);
  else if (XINT (arg) < 0)
    XSETINT (arg, - XFASTINT (arg));
Mike Rowan's avatar
Mike Rowan committed
607

608
  return arg;
Mike Rowan's avatar
Mike Rowan committed
609 610 611 612
}

DEFUN ("float", Ffloat, Sfloat, 1, 1, 0,
  "Return the floating point number equal to ARG.")
613 614
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
615
{
616
  CHECK_NUMBER_OR_FLOAT (arg, 0);
Mike Rowan's avatar
Mike Rowan committed
617

618 619
  if (XTYPE (arg) == Lisp_Int)
    return make_float ((double) XINT (arg));
Mike Rowan's avatar
Mike Rowan committed
620
  else				/* give 'em the same float back */
621
    return arg;
Mike Rowan's avatar
Mike Rowan committed
622 623 624
}

DEFUN ("logb", Flogb, Slogb, 1, 1, 0,
625
  "Returns the integer not greater than the base 2 log of the magnitude of ARG.\n\
Mike Rowan's avatar
Mike Rowan committed
626
This is the same as the exponent of a float.")
627 628
     (arg)
     Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
629
{
630
  Lisp_Object val;
631 632
  int value;
  double f = extract_float (arg);
633

634 635 636 637 638 639 640 641
#ifdef USG
  {
    int exp;  

    IN_FLOAT (frexp (f, &exp), "logb", arg);
    XSET (val, Lisp_Int, exp-1);
  }
#else
642 643
  IN_FLOAT (value = logb (f), "logb", arg);
  XSET (val, Lisp_Int, value);
644
#endif
645 646

  return val;
Mike Rowan's avatar
Mike Rowan committed
647 648 649 650 651 652
}

/* the rounding functions  */

DEFUN ("ceiling", Fceiling, Sceiling, 1, 1, 0,
  "Return the smallest integer no less than ARG.  (Round toward +inf.)")
653 654
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
655
{
656
  CHECK_NUMBER_OR_FLOAT (arg, 0);
Mike Rowan's avatar
Mike Rowan committed
657

658 659
  if (XTYPE (arg) == Lisp_Float)
    IN_FLOAT (XSET (arg, Lisp_Int, ceil (XFLOAT (arg)->data)), "celing", arg);
Mike Rowan's avatar
Mike Rowan committed
660

661
  return arg;
Mike Rowan's avatar
Mike Rowan committed
662 663 664 665
}

DEFUN ("floor", Ffloor, Sfloor, 1, 1, 0,
  "Return the largest integer no greater than ARG.  (Round towards -inf.)")
666 667
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
668
{
669
  CHECK_NUMBER_OR_FLOAT (arg, 0);
Mike Rowan's avatar
Mike Rowan committed
670

671 672
  if (XTYPE (arg) == Lisp_Float)
    IN_FLOAT (XSET (arg, Lisp_Int, floor (XFLOAT (arg)->data)), "floor", arg);
Mike Rowan's avatar
Mike Rowan committed
673

674
  return arg;
Mike Rowan's avatar
Mike Rowan committed
675 676 677 678
}

DEFUN ("round", Fround, Sround, 1, 1, 0,
  "Return the nearest integer to ARG.")
679 680
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
681
{
682
  CHECK_NUMBER_OR_FLOAT (arg, 0);
Mike Rowan's avatar
Mike Rowan committed
683

684 685 686
  if (XTYPE (arg) == Lisp_Float)
    /* Screw the prevailing rounding mode.  */
    IN_FLOAT (XSET (arg, Lisp_Int, rint (XFLOAT (arg)->data)), "round", arg);
Mike Rowan's avatar
Mike Rowan committed
687

688
  return arg;
Mike Rowan's avatar
Mike Rowan committed
689 690 691 692 693
}

DEFUN ("truncate", Ftruncate, Struncate, 1, 1, 0,
       "Truncate a floating point number to an int.\n\
Rounds the value toward zero.")
694 695
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
696
{
697
  CHECK_NUMBER_OR_FLOAT (arg, 0);
Mike Rowan's avatar
Mike Rowan committed
698

699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728
  if (XTYPE (arg) == Lisp_Float)
    XSET (arg, Lisp_Int, (int) XFLOAT (arg)->data);

  return arg;
}

#if 0
/* 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
729

730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751
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);
  IN_FLOAT (d = rint (XFLOAT (arg)->data), "fround", arg);
  return make_float (d);
}

DEFUN ("ftruncate", Fftruncate, Sftruncate, 1, 1, 0,
       "Truncate a floating point number to an integral float value.\n\
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
    IN_FLOAT (d = ceil (d), arg);
  return make_float (d);
Mike Rowan's avatar
Mike Rowan committed
752
}
753
#endif
Mike Rowan's avatar
Mike Rowan committed
754

755
#ifdef FLOAT_CATCH_SIGILL
Jim Blandy's avatar
Jim Blandy committed
756
static SIGTYPE
Mike Rowan's avatar
Mike Rowan committed
757 758 759 760 761 762
float_error (signo)
     int signo;
{
  if (! in_float)
    fatal_error_signal (signo);

Jim Blandy's avatar
Jim Blandy committed
763
#ifdef BSD
Mike Rowan's avatar
Mike Rowan committed
764 765 766
#ifdef BSD4_1
  sigrelse (SIGILL);
#else /* not BSD4_1 */
Jim Blandy's avatar
Jim Blandy committed
767
  sigsetmask (SIGEMPTYMASK);
Mike Rowan's avatar
Mike Rowan committed
768
#endif /* not BSD4_1 */
Jim Blandy's avatar
Jim Blandy committed
769 770 771 772
#else
  /* Must reestablish handler each time it is called.  */
  signal (SIGILL, float_error);
#endif /* BSD */
Mike Rowan's avatar
Mike Rowan committed
773 774 775 776 777 778

  in_float = 0;

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

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
/* 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 */

Mike Rowan's avatar
Mike Rowan committed
814 815
init_floatfns ()
{
816
#ifdef FLOAT_CATCH_SIGILL
Mike Rowan's avatar
Mike Rowan committed
817
  signal (SIGILL, float_error);
818
#endif 
Mike Rowan's avatar
Mike Rowan committed
819 820 821 822 823 824 825 826
  in_float = 0;
}

syms_of_floatfns ()
{
  defsubr (&Sacos);
  defsubr (&Sasin);
  defsubr (&Satan);
827 828 829 830 831 832
  defsubr (&Scos);
  defsubr (&Ssin);
  defsubr (&Stan);
#if 0
  defsubr (&Sacosh);
  defsubr (&Sasinh);
Mike Rowan's avatar
Mike Rowan committed
833
  defsubr (&Satanh);
834 835 836
  defsubr (&Scosh);
  defsubr (&Ssinh);
  defsubr (&Stanh);
Mike Rowan's avatar
Mike Rowan committed
837 838 839 840 841 842 843 844
  defsubr (&Sbessel_y0);
  defsubr (&Sbessel_y1);
  defsubr (&Sbessel_yn);
  defsubr (&Sbessel_j0);
  defsubr (&Sbessel_j1);
  defsubr (&Sbessel_jn);
  defsubr (&Serf);
  defsubr (&Serfc);
845
  defsubr (&Slog_gamma);
846 847 848 849 850
  defsubr (&Scube_root);
  defsubr (&Sfceiling);
  defsubr (&Sffloor);
  defsubr (&Sfround);
  defsubr (&Sftruncate);
851
#endif
Mike Rowan's avatar
Mike Rowan committed
852
  defsubr (&Sexp);
853
  defsubr (&Sexpt);
Mike Rowan's avatar
Mike Rowan committed
854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875
  defsubr (&Slog);
  defsubr (&Slog10);
  defsubr (&Ssqrt);

  defsubr (&Sabs);
  defsubr (&Sfloat);
  defsubr (&Slogb);
  defsubr (&Sceiling);
  defsubr (&Sfloor);
  defsubr (&Sround);
  defsubr (&Struncate);
}

#else /* not LISP_FLOAT_TYPE */

init_floatfns ()
{}

syms_of_floatfns ()
{}

#endif /* not LISP_FLOAT_TYPE */