floatfns.c 23.2 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
#include <signal.h>

48
#include <config.h>
Mike Rowan's avatar
Mike Rowan committed
49
#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

56 57 58 59 60 61 62 63 64 65
#if 0 /* That is untrue--XINT is used below, and it uses INTBITS.
	 What in the world is values.h, anyway?  */
#ifdef MSDOS
/* These are redefined in <values.h> and not used here */
#undef INTBITS
#undef LONGBITS
#undef SHORTBITS
#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 79
/* This declaration is omitted on some systems, like Ultrix.  */
#if !defined (hpux) && defined (HAVE_LOGB)
80
extern double logb ();
81
#endif /* !hpux && HAVE_LOGB */
82

83
#ifndef MSDOS
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
90
#endif
91

Richard M. Stallman's avatar
Richard M. Stallman committed
92
#ifdef NO_MATHERR
93 94 95
#undef HAVE_MATHERR
#endif

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

extern int errno;
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 126 127 128
#ifndef HAVE_RINT
#define rint(x) (floor((x)+0.5))
#endif

Jim Blandy's avatar
Jim Blandy committed
129
static SIGTYPE float_error ();
Mike Rowan's avatar
Mike Rowan committed
130 131 132 133 134 135 136

/* 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
137
   here is the actual argument value to use in the error message.  */
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 183 184 185 186 187 188 189 190
#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
191 192 193 194 195 196 197 198 199 200 201 202 203

/* 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);
}
204 205

/* Trig functions.  */
Mike Rowan's avatar
Mike Rowan committed
206 207 208

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

221 222
DEFUN ("asin", Fasin, Sasin, 1, 1, 0,
  "Return the inverse sine of ARG.")
223 224
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
225
{
226 227 228 229 230 231
  double d = extract_float (arg);
#ifdef FLOAT_CHECK_DOMAIN
  if (d > 1.0 || d < -1.0)
    domain_error ("asin", arg);
#endif
  IN_FLOAT (d = asin (d), "asin", arg);
Mike Rowan's avatar
Mike Rowan committed
232 233 234
  return make_float (d);
}

235 236
DEFUN ("atan", Fatan, Satan, 1, 1, 0,
  "Return the inverse tangent of ARG.")
237 238
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
239
{
240 241
  double d = extract_float (arg);
  IN_FLOAT (d = atan (d), "atan", arg);
Mike Rowan's avatar
Mike Rowan committed
242 243 244
  return make_float (d);
}

245 246
DEFUN ("cos", Fcos, Scos, 1, 1, 0,
  "Return the cosine of ARG.")
247 248
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
249
{
250 251
  double d = extract_float (arg);
  IN_FLOAT (d = cos (d), "cos", arg);
Mike Rowan's avatar
Mike Rowan committed
252 253 254
  return make_float (d);
}

255 256
DEFUN ("sin", Fsin, Ssin, 1, 1, 0,
  "Return the sine of ARG.")
257 258
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
259
{
260 261
  double d = extract_float (arg);
  IN_FLOAT (d = sin (d), "sin", arg);
Mike Rowan's avatar
Mike Rowan committed
262 263 264
  return make_float (d);
}

265 266
DEFUN ("tan", Ftan, Stan, 1, 1, 0,
  "Return the tangent of ARG.")
267 268 269 270 271 272 273 274 275 276
  (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
277 278 279
  return make_float (d);
}

280 281
#if 0 /* Leave these out unless we find there's a reason for them.  */

Mike Rowan's avatar
Mike Rowan committed
282 283
DEFUN ("bessel-j0", Fbessel_j0, Sbessel_j0, 1, 1, 0,
  "Return the bessel function j0 of ARG.")
284 285
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
286
{
287 288
  double d = extract_float (arg);
  IN_FLOAT (d = j0 (d), "bessel-j0", arg);
Mike Rowan's avatar
Mike Rowan committed
289 290 291 292 293
  return make_float (d);
}

DEFUN ("bessel-j1", Fbessel_j1, Sbessel_j1, 1, 1, 0,
  "Return the bessel function j1 of ARG.")
294 295
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
296
{
297 298
  double d = extract_float (arg);
  IN_FLOAT (d = j1 (d), "bessel-j1", arg);
Mike Rowan's avatar
Mike Rowan committed
299 300 301 302 303 304
  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.")
305 306
  (arg1, arg2)
     register Lisp_Object arg1, arg2;
Mike Rowan's avatar
Mike Rowan committed
307
{
308 309
  int i1 = extract_float (arg1);
  double f2 = extract_float (arg2);
Mike Rowan's avatar
Mike Rowan committed
310

311
  IN_FLOAT (f2 = jn (i1, f2), "bessel-jn", arg1);
Mike Rowan's avatar
Mike Rowan committed
312 313 314 315 316
  return make_float (f2);
}

DEFUN ("bessel-y0", Fbessel_y0, Sbessel_y0, 1, 1, 0,
  "Return the bessel function y0 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 = y0 (d), "bessel-y0", arg);
Mike Rowan's avatar
Mike Rowan committed
322 323 324 325 326
  return make_float (d);
}

DEFUN ("bessel-y1", Fbessel_y1, Sbessel_y1, 1, 1, 0,
  "Return the bessel function y1 of ARG.")
327 328
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
329
{
330 331
  double d = extract_float (arg);
  IN_FLOAT (d = y1 (d), "bessel-y0", arg);
Mike Rowan's avatar
Mike Rowan committed
332 333 334 335 336 337
  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.")
338 339
  (arg1, arg2)
     register Lisp_Object arg1, arg2;
Mike Rowan's avatar
Mike Rowan committed
340
{
341 342
  int i1 = extract_float (arg1);
  double f2 = extract_float (arg2);
Mike Rowan's avatar
Mike Rowan committed
343

344
  IN_FLOAT (f2 = yn (i1, f2), "bessel-yn", arg1);
Mike Rowan's avatar
Mike Rowan committed
345 346 347
  return make_float (f2);
}

348 349 350
#endif

#if 0 /* Leave these out unless we see they are worth having.  */
Mike Rowan's avatar
Mike Rowan committed
351 352 353

DEFUN ("erf", Ferf, Serf, 1, 1, 0,
  "Return the mathematical error function of ARG.")
354 355
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
356
{
357 358
  double d = extract_float (arg);
  IN_FLOAT (d = erf (d), "erf", arg);
Mike Rowan's avatar
Mike Rowan committed
359 360 361 362 363
  return make_float (d);
}

DEFUN ("erfc", Ferfc, Serfc, 1, 1, 0,
  "Return the complementary error function of ARG.")
364 365
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
366
{
367 368
  double d = extract_float (arg);
  IN_FLOAT (d = erfc (d), "erfc", arg);
Mike Rowan's avatar
Mike Rowan committed
369 370 371 372 373
  return make_float (d);
}

DEFUN ("log-gamma", Flog_gamma, Slog_gamma, 1, 1, 0,
  "Return the log gamma of ARG.")
374 375
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
376
{
377 378
  double d = extract_float (arg);
  IN_FLOAT (d = lgamma (d), "log-gamma", arg);
Mike Rowan's avatar
Mike Rowan committed
379 380 381
  return make_float (d);
}

382
DEFUN ("cube-root", Fcube_root, Scube_root, 1, 1, 0,
383
  "Return the cube root of ARG.")
384 385
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
386
{
387 388 389 390 391 392 393 394 395
  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
396 397 398
  return make_float (d);
}

Richard M. Stallman's avatar
Richard M. Stallman committed
399 400
#endif

401 402
DEFUN ("exp", Fexp, Sexp, 1, 1, 0,
  "Return the exponential base e of ARG.")
403 404 405 406 407 408 409 410 411 412 413 414
  (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
415 416 417 418
  return make_float (d);
}

DEFUN ("expt", Fexpt, Sexpt, 2, 2, 0,
419
  "Return the exponential X ** Y.")
420 421
  (arg1, arg2)
     register Lisp_Object arg1, arg2;
Mike Rowan's avatar
Mike Rowan committed
422 423 424
{
  double f1, f2;

425 426
  CHECK_NUMBER_OR_FLOAT (arg1, 0);
  CHECK_NUMBER_OR_FLOAT (arg2, 0);
Richard M. Stallman's avatar
Richard M. Stallman committed
427 428
  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
429
    {				/* this can be improved by pre-calculating */
430
      int acc, x, y;		/* some binary powers of x then accumulating */
431 432
      Lisp_Object val;

433 434
      x = XINT (arg1);
      y = XINT (arg2);
Mike Rowan's avatar
Mike Rowan committed
435 436 437 438
      acc = 1;
      
      if (y < 0)
	{
439 440 441 442 443 444
	  if (x == 1)
	    acc = 1;
	  else if (x == -1)
	    acc = (y & 1) ? -1 : 1;
	  else
	    acc = 0;
Mike Rowan's avatar
Mike Rowan committed
445 446 447
	}
      else
	{
448 449 450 451 452 453 454
	  while (y > 0)
	    {
	      if (y & 1)
		acc *= x;
	      x *= x;
	      y = (unsigned)y >> 1;
	    }
Mike Rowan's avatar
Mike Rowan committed
455
	}
456 457
      XSET (val, Lisp_Int, acc);
      return val;
Mike Rowan's avatar
Mike Rowan committed
458
    }
459 460 461 462 463 464 465 466 467
  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
Richard M. Stallman's avatar
Richard M. Stallman committed
468
  IN_FLOAT2 (f1 = pow (f1, f2), "expt", arg1, arg2);
Mike Rowan's avatar
Mike Rowan committed
469 470
  return make_float (f1);
}
471

472
DEFUN ("log", Flog, Slog, 1, 2, 0,
473 474 475 476
  "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
477
{
478
  double d = extract_float (arg);
479

480 481 482 483
#ifdef FLOAT_CHECK_DOMAIN
  if (d <= 0.0)
    domain_error2 ("log", arg, base);
#endif
484
  if (NILP (base))
485
    IN_FLOAT (d = log (d), "log", arg);
486 487 488 489
  else
    {
      double b = extract_float (base);

490 491 492 493 494 495 496
#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
497
	IN_FLOAT2 (d = log (d) / log (b), "log", arg, base);
498
    }
Mike Rowan's avatar
Mike Rowan committed
499 500 501
  return make_float (d);
}

502 503
DEFUN ("log10", Flog10, Slog10, 1, 1, 0,
  "Return the logarithm base 10 of ARG.")
504 505
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
506
{
507 508 509 510 511 512
  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);
513 514 515
  return make_float (d);
}

Mike Rowan's avatar
Mike Rowan committed
516 517
DEFUN ("sqrt", Fsqrt, Ssqrt, 1, 1, 0,
  "Return the square root of ARG.")
518 519
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
520
{
521 522 523 524 525 526
  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
527 528
  return make_float (d);
}
529

Richard M. Stallman's avatar
Richard M. Stallman committed
530
#if 0 /* Not clearly worth adding.  */
Mike Rowan's avatar
Mike Rowan committed
531

532 533
DEFUN ("acosh", Facosh, Sacosh, 1, 1, 0,
  "Return the inverse hyperbolic cosine of ARG.")
534 535
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
536
{
537 538 539 540 541 542 543 544 545 546
  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
547 548 549 550 551
  return make_float (d);
}

DEFUN ("asinh", Fasinh, Sasinh, 1, 1, 0,
  "Return the inverse hyperbolic sine of ARG.")
552 553
  (arg)
     register Lisp_Object arg;
554
{
555 556 557 558 559 560
  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
561 562 563 564 565
  return make_float (d);
}

DEFUN ("atanh", Fatanh, Satanh, 1, 1, 0,
  "Return the inverse hyperbolic tangent of ARG.")
566 567
  (arg)
     register Lisp_Object arg;
568
{
569 570 571 572 573 574 575 576 577 578
  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
579 580 581 582 583
  return make_float (d);
}

DEFUN ("cosh", Fcosh, Scosh, 1, 1, 0,
  "Return the hyperbolic cosine of ARG.")
584 585
  (arg)
     register Lisp_Object arg;
586
{
587 588 589 590 591 592
  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);
593 594 595 596 597
  return make_float (d);
}

DEFUN ("sinh", Fsinh, Ssinh, 1, 1, 0,
  "Return the hyperbolic sine of ARG.")
598 599
  (arg)
     register Lisp_Object arg;
600
{
601 602 603 604 605 606
  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
607 608 609 610 611
  return make_float (d);
}

DEFUN ("tanh", Ftanh, Stanh, 1, 1, 0,
  "Return the hyperbolic tangent of ARG.")
612 613
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
614
{
615 616
  double d = extract_float (arg);
  IN_FLOAT (d = tanh (d), "tanh", arg);
Mike Rowan's avatar
Mike Rowan committed
617 618
  return make_float (d);
}
619
#endif
Mike Rowan's avatar
Mike Rowan committed
620 621 622

DEFUN ("abs", Fabs, Sabs, 1, 1, 0,
  "Return the absolute value of ARG.")
623 624
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
625
{
626
  CHECK_NUMBER_OR_FLOAT (arg, 0);
Mike Rowan's avatar
Mike Rowan committed
627

628 629 630 631
  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
632

633
  return arg;
Mike Rowan's avatar
Mike Rowan committed
634 635 636 637
}

DEFUN ("float", Ffloat, Sfloat, 1, 1, 0,
  "Return the floating point number equal to ARG.")
638 639
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
640
{
641
  CHECK_NUMBER_OR_FLOAT (arg, 0);
Mike Rowan's avatar
Mike Rowan committed
642

643 644
  if (XTYPE (arg) == Lisp_Int)
    return make_float ((double) XINT (arg));
Mike Rowan's avatar
Mike Rowan committed
645
  else				/* give 'em the same float back */
646
    return arg;
Mike Rowan's avatar
Mike Rowan committed
647 648 649
}

DEFUN ("logb", Flogb, Slogb, 1, 1, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
650
  "Returns largest integer <= the base 2 log of the magnitude of ARG.\n\
Mike Rowan's avatar
Mike Rowan committed
651
This is the same as the exponent of a float.")
652 653
     (arg)
     Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
654
{
655
  Lisp_Object val;
656 657
  int value;
  double f = extract_float (arg);
658

659 660 661 662
  if (f == 0.0)
    value = -(VALMASK >> 1);
  else
    {
663
#ifdef HAVE_LOGB
664
      IN_FLOAT (value = logb (f), "logb", arg);
665 666
#else
#ifdef HAVE_FREXP
667 668
      IN_FLOAT (frexp (f, &value), "logb", arg);
      value--;
669
#else
670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688
      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;
	}
689
#endif
690
#endif
691 692
    }
  XSET (val, Lisp_Int, value);
693
  return val;
Mike Rowan's avatar
Mike Rowan committed
694 695 696 697 698 699
}

/* the rounding functions  */

DEFUN ("ceiling", Fceiling, Sceiling, 1, 1, 0,
  "Return the smallest integer no less than ARG.  (Round toward +inf.)")
700 701
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
702
{
703
  CHECK_NUMBER_OR_FLOAT (arg, 0);
Mike Rowan's avatar
Mike Rowan committed
704

705
  if (XTYPE (arg) == Lisp_Float)
706
    IN_FLOAT (XSET (arg, Lisp_Int, ceil (XFLOAT (arg)->data)), "ceiling", arg);
Mike Rowan's avatar
Mike Rowan committed
707

708
  return arg;
Mike Rowan's avatar
Mike Rowan committed
709 710
}

711 712 713 714 715 716 717 718
#endif /* LISP_FLOAT_TYPE */


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)
     register Lisp_Object arg, divisor;
Mike Rowan's avatar
Mike Rowan committed
719
{
720
  CHECK_NUMBER_OR_FLOAT (arg, 0);
Mike Rowan's avatar
Mike Rowan committed
721

722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761
  if (! NILP (divisor))
    {
      int i1, i2;

      CHECK_NUMBER_OR_FLOAT (divisor, 1);

#ifdef LISP_FLOAT_TYPE
      if (XTYPE (arg) == Lisp_Float || XTYPE (divisor) == Lisp_Float)
	{
	  double f1, f2;

	  f1 = XTYPE (arg) == Lisp_Float ? XFLOAT (arg)->data : XINT (arg);
	  f2 = (XTYPE (divisor) == Lisp_Float
		? XFLOAT (divisor)->data : XINT (divisor));
	  if (f2 == 0)
	    Fsignal (Qarith_error, Qnil);

	  IN_FLOAT2 (XSET (arg, Lisp_Int, floor (f1 / f2)),
		     "floor", arg, divisor);
	  return arg;
	}
#endif

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

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

      /* With C's /, the result is implementation-defined if either operand
	 is negative, so use only nonnegative operands.  */
      i1 = (i2 < 0
	    ? (i1 <= 0  ?  -i1 / -i2  :  -1 - ((i1 - 1) / -i2))
	    : (i1 < 0  ?  -1 - ((-1 - i1) / i2)  :  i1 / i2));

      XSET (arg, Lisp_Int, i1);
      return arg;
    }

#ifdef LISP_FLOAT_TYPE
762 763
  if (XTYPE (arg) == Lisp_Float)
    IN_FLOAT (XSET (arg, Lisp_Int, floor (XFLOAT (arg)->data)), "floor", arg);
764
#endif
Mike Rowan's avatar
Mike Rowan committed
765

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

769 770
#ifdef LISP_FLOAT_TYPE

Mike Rowan's avatar
Mike Rowan committed
771 772
DEFUN ("round", Fround, Sround, 1, 1, 0,
  "Return the nearest integer to ARG.")
773 774
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
775
{
776
  CHECK_NUMBER_OR_FLOAT (arg, 0);
Mike Rowan's avatar
Mike Rowan committed
777

778 779 780
  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
781

782
  return arg;
Mike Rowan's avatar
Mike Rowan committed
783 784 785 786 787
}

DEFUN ("truncate", Ftruncate, Struncate, 1, 1, 0,
       "Truncate a floating point number to an int.\n\
Rounds the value toward zero.")
788 789
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
790
{
791
  CHECK_NUMBER_OR_FLOAT (arg, 0);
Mike Rowan's avatar
Mike Rowan committed
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
  if (XTYPE (arg) == Lisp_Float)
    XSET (arg, Lisp_Int, (int) XFLOAT (arg)->data);

  return arg;
}

/* 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
822

823 824 825 826 827 828
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);
829
  IN_FLOAT (d = rint (d), "fround", arg);
830 831 832 833 834 835 836 837 838 839 840 841 842
  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
843
    IN_FLOAT (d = ceil (d), "ftruncate", arg);
844
  return make_float (d);
Mike Rowan's avatar
Mike Rowan committed
845 846
}

847
#ifdef FLOAT_CATCH_SIGILL
Jim Blandy's avatar
Jim Blandy committed
848
static SIGTYPE
Mike Rowan's avatar
Mike Rowan committed
849 850 851 852 853 854
float_error (signo)
     int signo;
{
  if (! in_float)
    fatal_error_signal (signo);

Jim Blandy's avatar
Jim Blandy committed
855
#ifdef BSD
Mike Rowan's avatar
Mike Rowan committed
856 857 858
#ifdef BSD4_1
  sigrelse (SIGILL);
#else /* not BSD4_1 */
Jim Blandy's avatar
Jim Blandy committed
859
  sigsetmask (SIGEMPTYMASK);
Mike Rowan's avatar
Mike Rowan committed
860
#endif /* not BSD4_1 */
Jim Blandy's avatar
Jim Blandy committed
861 862 863 864
#else
  /* Must reestablish handler each time it is called.  */
  signal (SIGILL, float_error);
#endif /* BSD */
Mike Rowan's avatar
Mike Rowan committed
865 866 867 868 869 870

  in_float = 0;

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

871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905
/* 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
906 907
init_floatfns ()
{
908
#ifdef FLOAT_CATCH_SIGILL
Mike Rowan's avatar
Mike Rowan committed
909
  signal (SIGILL, float_error);
910
#endif 
Mike Rowan's avatar
Mike Rowan committed
911 912 913
  in_float = 0;
}

914 915 916 917 918 919 920
#else /* not LISP_FLOAT_TYPE */

init_floatfns ()
{}

#endif /* not LISP_FLOAT_TYPE */

Mike Rowan's avatar
Mike Rowan committed
921 922
syms_of_floatfns ()
{
923
#ifdef LISP_FLOAT_TYPE
Mike Rowan's avatar
Mike Rowan committed
924 925 926
  defsubr (&Sacos);
  defsubr (&Sasin);
  defsubr (&Satan);
927 928 929 930 931 932
  defsubr (&Scos);
  defsubr (&Ssin);
  defsubr (&Stan);
#if 0
  defsubr (&Sacosh);
  defsubr (&Sasinh);
Mike Rowan's avatar
Mike Rowan committed
933
  defsubr (&Satanh);
934 935 936
  defsubr (&Scosh);
  defsubr (&Ssinh);
  defsubr (&Stanh);
Mike Rowan's avatar
Mike Rowan committed
937 938 939 940 941 942 943 944
  defsubr (&Sbessel_y0);
  defsubr (&Sbessel_y1);
  defsubr (&Sbessel_yn);
  defsubr (&Sbessel_j0);
  defsubr (&Sbessel_j1);
  defsubr (&Sbessel_jn);
  defsubr (&Serf);
  defsubr (&Serfc);
945
  defsubr (&Slog_gamma);
946
  defsubr (&Scube_root);
947
#endif
948 949 950 951
  defsubr (&Sfceiling);
  defsubr (&Sffloor);
  defsubr (&Sfround);
  defsubr (&Sftruncate);
Mike Rowan's avatar
Mike Rowan committed
952
  defsubr (&Sexp);
953
  defsubr (&Sexpt);
Mike Rowan's avatar
Mike Rowan committed
954 955 956 957 958 959 960 961 962 963
  defsubr (&Slog);
  defsubr (&Slog10);
  defsubr (&Ssqrt);

  defsubr (&Sabs);
  defsubr (&Sfloat);
  defsubr (&Slogb);
  defsubr (&Sceiling);
  defsubr (&Sround);
  defsubr (&Struncate);
964 965
#endif /* LISP_FLOAT_TYPE */
  defsubr (&Sfloor);
Mike Rowan's avatar
Mike Rowan committed
966
}