floatfns.c 23.9 KB
Newer Older
Mike Rowan's avatar
Mike Rowan committed
1
/* Primitive operations on floating point for GNU Emacs Lisp interpreter.
Karl Heuer's avatar
Karl Heuer committed
2
   Copyright (C) 1988, 1993, 1994 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
/* 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
66
#include <math.h>
67

68
/* This declaration is omitted on some systems, like Ultrix.  */
69
#if !defined (HPUX) && defined (HAVE_LOGB) && !defined (logb)
70
extern double logb ();
71
#endif /* not HPUX and HAVE_LOGB and no logb macro */
72

73 74 75 76 77 78 79
#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
80
#ifdef NO_MATHERR
81 82 83
#undef HAVE_MATHERR
#endif

84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
#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
99 100

extern int errno;
101
#endif
Jim Blandy's avatar
Jim Blandy committed
102 103 104 105 106 107 108 109 110 111 112

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

113 114 115 116
#ifndef HAVE_RINT
#define rint(x) (floor((x)+0.5))
#endif

Jim Blandy's avatar
Jim Blandy committed
117
static SIGTYPE float_error ();
Mike Rowan's avatar
Mike Rowan committed
118 119 120 121 122 123 124

/* 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
125
   here is the actual argument value to use in the error message.  */
Mike Rowan's avatar
Mike Rowan committed
126

127 128 129
static Lisp_Object float_error_arg, float_error_arg2;

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

Jim Blandy's avatar
Jim Blandy committed
131 132 133
/* Evaluate the floating point expression D, recording NUM
   as the original argument for error messages.
   D is normally an assignment expression.
134 135 136 137 138
   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
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 166
#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
167
#define IN_FLOAT(d, name, num) (in_float = 1, (d), in_float = 0)
168 169 170
#define IN_FLOAT2(d, name, num, num2) (in_float = 1, (d), in_float = 0)
#endif

171 172 173 174 175
/* 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									\
    {									\
176 177
      if ((x) >= (((EMACS_INT) 1) << (VALBITS-1)) ||			\
	  (x) <= - (((EMACS_INT) 1) << (VALBITS-1)) - 1)		\
178
	range_error (name, num);					\
179
      XSETINT (i,  (EMACS_INT)(x));					\
180 181 182 183 184
    }									\
  while (0)
#define FLOAT_TO_INT2(x, i, name, num1, num2)				\
  do									\
    {									\
185 186
      if ((x) >= (((EMACS_INT) 1) << (VALBITS-1)) ||			\
	  (x) <= - (((EMACS_INT) 1) << (VALBITS-1)) - 1)		\
187
	range_error2 (name, num1, num2);				\
188
      XSETINT (i,  (EMACS_INT)(x));					\
189 190 191
    }									\
  while (0)

192 193 194 195
#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)))
196 197 198
#define range_error2(op,a1,a2) \
  Fsignal (Qrange_error, Fcons (build_string ((op)), \
				Fcons ((a1), Fcons ((a2), Qnil))))
199 200 201
#define domain_error(op,arg) \
  Fsignal (Qdomain_error, Fcons (build_string ((op)), Fcons ((arg), Qnil)))
#define domain_error2(op,a1,a2) \
202 203
  Fsignal (Qdomain_error, Fcons (build_string ((op)), \
				 Fcons ((a1), Fcons ((a2), Qnil))))
Mike Rowan's avatar
Mike Rowan committed
204 205 206 207 208 209 210 211 212

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

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

213
  if (FLOATP (num))
Mike Rowan's avatar
Mike Rowan committed
214 215 216
    return XFLOAT (num)->data;
  return (double) XINT (num);
}
217 218

/* Trig functions.  */
Mike Rowan's avatar
Mike Rowan committed
219 220 221

DEFUN ("acos", Facos, Sacos, 1, 1, 0,
  "Return the inverse cosine of ARG.")
222 223
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
224
{
225 226 227 228 229 230
  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
231 232 233
  return make_float (d);
}

234 235
DEFUN ("asin", Fasin, Sasin, 1, 1, 0,
  "Return the inverse sine of ARG.")
236 237
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
238
{
239 240 241 242 243 244
  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
245 246 247
  return make_float (d);
}

248 249
DEFUN ("atan", Fatan, Satan, 1, 1, 0,
  "Return the inverse tangent of ARG.")
250 251
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
252
{
253 254
  double d = extract_float (arg);
  IN_FLOAT (d = atan (d), "atan", arg);
Mike Rowan's avatar
Mike Rowan committed
255 256 257
  return make_float (d);
}

258 259
DEFUN ("cos", Fcos, Scos, 1, 1, 0,
  "Return the cosine 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 = cos (d), "cos", arg);
Mike Rowan's avatar
Mike Rowan committed
265 266 267
  return make_float (d);
}

268 269
DEFUN ("sin", Fsin, Ssin, 1, 1, 0,
  "Return the sine 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 = sin (d), "sin", arg);
Mike Rowan's avatar
Mike Rowan committed
275 276 277
  return make_float (d);
}

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

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

DEFUN ("bessel-j1", Fbessel_j1, Sbessel_j1, 1, 1, 0,
  "Return the bessel function j1 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 = j1 (d), "bessel-j1", arg);
Mike Rowan's avatar
Mike Rowan committed
312 313 314 315 316 317
  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.")
318 319
  (arg1, arg2)
     register Lisp_Object arg1, arg2;
Mike Rowan's avatar
Mike Rowan committed
320
{
321 322
  int i1 = extract_float (arg1);
  double f2 = extract_float (arg2);
Mike Rowan's avatar
Mike Rowan committed
323

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

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

DEFUN ("bessel-y1", Fbessel_y1, Sbessel_y1, 1, 1, 0,
  "Return the bessel function y1 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 = y1 (d), "bessel-y0", arg);
Mike Rowan's avatar
Mike Rowan committed
345 346 347 348 349 350
  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.")
351 352
  (arg1, arg2)
     register Lisp_Object arg1, arg2;
Mike Rowan's avatar
Mike Rowan committed
353
{
354 355
  int i1 = extract_float (arg1);
  double f2 = extract_float (arg2);
Mike Rowan's avatar
Mike Rowan committed
356

357
  IN_FLOAT (f2 = yn (i1, f2), "bessel-yn", arg1);
Mike Rowan's avatar
Mike Rowan committed
358 359 360
  return make_float (f2);
}

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

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

DEFUN ("erfc", Ferfc, Serfc, 1, 1, 0,
  "Return the complementary 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 = erfc (d), "erfc", arg);
Mike Rowan's avatar
Mike Rowan committed
382 383 384 385 386
  return make_float (d);
}

DEFUN ("log-gamma", Flog_gamma, Slog_gamma, 1, 1, 0,
  "Return the log gamma 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 = lgamma (d), "log-gamma", arg);
Mike Rowan's avatar
Mike Rowan committed
392 393 394
  return make_float (d);
}

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

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

DEFUN ("expt", Fexpt, Sexpt, 2, 2, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
432
  "Return the exponential ARG1 ** ARG2.")
433 434
  (arg1, arg2)
     register Lisp_Object arg1, arg2;
Mike Rowan's avatar
Mike Rowan committed
435 436 437
{
  double f1, f2;

438 439
  CHECK_NUMBER_OR_FLOAT (arg1, 0);
  CHECK_NUMBER_OR_FLOAT (arg2, 0);
440 441
  if (INTEGERP (arg1)     /* common lisp spec */
      && INTEGERP (arg2)) /* don't promote, if both are ints */
Mike Rowan's avatar
Mike Rowan committed
442
    {				/* this can be improved by pre-calculating */
443
      EMACS_INT acc, x, y;	/* some binary powers of x then accumulating */
444 445
      Lisp_Object val;

446 447
      x = XINT (arg1);
      y = XINT (arg2);
Mike Rowan's avatar
Mike Rowan committed
448 449 450 451
      acc = 1;
      
      if (y < 0)
	{
452 453 454 455 456 457
	  if (x == 1)
	    acc = 1;
	  else if (x == -1)
	    acc = (y & 1) ? -1 : 1;
	  else
	    acc = 0;
Mike Rowan's avatar
Mike Rowan committed
458 459 460
	}
      else
	{
461 462 463 464 465 466 467
	  while (y > 0)
	    {
	      if (y & 1)
		acc *= x;
	      x *= x;
	      y = (unsigned)y >> 1;
	    }
Mike Rowan's avatar
Mike Rowan committed
468
	}
469
      XSETINT (val, acc);
470
      return val;
Mike Rowan's avatar
Mike Rowan committed
471
    }
472 473
  f1 = FLOATP (arg1) ? XFLOAT (arg1)->data : XINT (arg1);
  f2 = FLOATP (arg2) ? XFLOAT (arg2)->data : XINT (arg2);
474 475 476 477 478 479 480
  /* 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
481
  IN_FLOAT2 (f1 = pow (f1, f2), "expt", arg1, arg2);
Mike Rowan's avatar
Mike Rowan committed
482 483
  return make_float (f1);
}
484

485
DEFUN ("log", Flog, Slog, 1, 2, 0,
486 487 488 489
  "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
490
{
491
  double d = extract_float (arg);
492

493 494 495 496
#ifdef FLOAT_CHECK_DOMAIN
  if (d <= 0.0)
    domain_error2 ("log", arg, base);
#endif
497
  if (NILP (base))
498
    IN_FLOAT (d = log (d), "log", arg);
499 500 501 502
  else
    {
      double b = extract_float (base);

503 504 505 506 507 508 509
#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
510
	IN_FLOAT2 (d = log (d) / log (b), "log", arg, base);
511
    }
Mike Rowan's avatar
Mike Rowan committed
512 513 514
  return make_float (d);
}

515 516
DEFUN ("log10", Flog10, Slog10, 1, 1, 0,
  "Return the logarithm base 10 of ARG.")
517 518
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
519
{
520 521 522 523 524 525
  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);
526 527 528
  return make_float (d);
}

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

545 546
DEFUN ("acosh", Facosh, Sacosh, 1, 1, 0,
  "Return the inverse hyperbolic cosine of ARG.")
547 548
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
549
{
550 551 552 553 554 555 556 557 558 559
  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
560 561 562 563 564
  return make_float (d);
}

DEFUN ("asinh", Fasinh, Sasinh, 1, 1, 0,
  "Return the inverse hyperbolic sine of ARG.")
565 566
  (arg)
     register Lisp_Object arg;
567
{
568 569 570 571 572 573
  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
574 575 576 577 578
  return make_float (d);
}

DEFUN ("atanh", Fatanh, Satanh, 1, 1, 0,
  "Return the inverse hyperbolic tangent of ARG.")
579 580
  (arg)
     register Lisp_Object arg;
581
{
582 583 584 585 586 587 588 589 590 591
  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
592 593 594 595 596
  return make_float (d);
}

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

DEFUN ("sinh", Fsinh, Ssinh, 1, 1, 0,
  "Return the hyperbolic sine of ARG.")
611 612
  (arg)
     register Lisp_Object arg;
613
{
614 615 616 617 618 619
  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
620 621 622 623 624
  return make_float (d);
}

DEFUN ("tanh", Ftanh, Stanh, 1, 1, 0,
  "Return the hyperbolic tangent of ARG.")
625 626
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
627
{
628 629
  double d = extract_float (arg);
  IN_FLOAT (d = tanh (d), "tanh", arg);
Mike Rowan's avatar
Mike Rowan committed
630 631
  return make_float (d);
}
632
#endif
Mike Rowan's avatar
Mike Rowan committed
633 634 635

DEFUN ("abs", Fabs, Sabs, 1, 1, 0,
  "Return the absolute value of ARG.")
636 637
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
638
{
639
  CHECK_NUMBER_OR_FLOAT (arg, 0);
Mike Rowan's avatar
Mike Rowan committed
640

641
  if (FLOATP (arg))
642 643
    IN_FLOAT (arg = make_float (fabs (XFLOAT (arg)->data)), "abs", arg);
  else if (XINT (arg) < 0)
644
    XSETINT (arg, - XINT (arg));
Mike Rowan's avatar
Mike Rowan committed
645

646
  return arg;
Mike Rowan's avatar
Mike Rowan committed
647 648 649 650
}

DEFUN ("float", Ffloat, Sfloat, 1, 1, 0,
  "Return the floating point number equal to ARG.")
651 652
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
653
{
654
  CHECK_NUMBER_OR_FLOAT (arg, 0);
Mike Rowan's avatar
Mike Rowan committed
655

656
  if (INTEGERP (arg))
657
    return make_float ((double) XINT (arg));
Mike Rowan's avatar
Mike Rowan committed
658
  else				/* give 'em the same float back */
659
    return arg;
Mike Rowan's avatar
Mike Rowan committed
660 661 662
}

DEFUN ("logb", Flogb, Slogb, 1, 1, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
663
  "Returns largest integer <= the base 2 log of the magnitude of ARG.\n\
Mike Rowan's avatar
Mike Rowan committed
664
This is the same as the exponent of a float.")
665 666
     (arg)
     Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
667
{
668
  Lisp_Object val;
669
  EMACS_INT value;
670
  double f = extract_float (arg);
671

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

/* the rounding functions  */

DEFUN ("ceiling", Fceiling, Sceiling, 1, 1, 0,
  "Return the smallest integer no less than ARG.  (Round toward +inf.)")
714 715
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
716
{
717
  CHECK_NUMBER_OR_FLOAT (arg, 0);
Mike Rowan's avatar
Mike Rowan committed
718

719
  if (FLOATP (arg))
720 721 722 723 724 725
    {
      double d;

      IN_FLOAT (d = ceil (XFLOAT (arg)->data), "ceiling", arg);
      FLOAT_TO_INT (d, arg, "ceiling", arg);
    }
Mike Rowan's avatar
Mike Rowan committed
726

727
  return arg;
Mike Rowan's avatar
Mike Rowan committed
728 729
}

730 731 732 733 734 735 736 737
#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
738
{
739
  CHECK_NUMBER_OR_FLOAT (arg, 0);
Mike Rowan's avatar
Mike Rowan committed
740

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

      CHECK_NUMBER_OR_FLOAT (divisor, 1);

#ifdef LISP_FLOAT_TYPE
748
      if (FLOATP (arg) || FLOATP (divisor))
749 750 751
	{
	  double f1, f2;

752 753
	  f1 = FLOATP (arg) ? XFLOAT (arg)->data : XINT (arg);
	  f2 = (FLOATP (divisor) ? XFLOAT (divisor)->data : XINT (divisor));
754 755 756
	  if (f2 == 0)
	    Fsignal (Qarith_error, Qnil);

757 758
	  IN_FLOAT2 (f1 = floor (f1 / f2), "floor", arg, divisor);
	  FLOAT_TO_INT2 (f1, arg, "floor", arg, divisor);
759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774
	  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));

775
      XSETINT (arg, i1);
776 777 778 779
      return arg;
    }

#ifdef LISP_FLOAT_TYPE
780
  if (FLOATP (arg))
781 782 783 784 785
    {
      double d;
      IN_FLOAT (d = floor (XFLOAT (arg)->data), "floor", arg);
      FLOAT_TO_INT (d, arg, "floor", arg);
    }
786
#endif
Mike Rowan's avatar
Mike Rowan committed
787

788
  return arg;
Mike Rowan's avatar
Mike Rowan committed
789 790
}

791 792
#ifdef LISP_FLOAT_TYPE

Mike Rowan's avatar
Mike Rowan committed
793 794
DEFUN ("round", Fround, Sround, 1, 1, 0,
  "Return the nearest integer to ARG.")
795 796
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
797
{
798
  CHECK_NUMBER_OR_FLOAT (arg, 0);
Mike Rowan's avatar
Mike Rowan committed
799

800
  if (FLOATP (arg))
801 802 803 804 805 806 807
    {
      double d;

      /* Screw the prevailing rounding mode.  */
      IN_FLOAT (d = rint (XFLOAT (arg)->data), "round", arg);
      FLOAT_TO_INT (d, arg, "round", arg);
    }
Mike Rowan's avatar
Mike Rowan committed
808

809
  return arg;
Mike Rowan's avatar
Mike Rowan committed
810 811 812 813 814
}

DEFUN ("truncate", Ftruncate, Struncate, 1, 1, 0,
       "Truncate a floating point number to an int.\n\
Rounds the value toward zero.")
815 816
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
817
{
818
  CHECK_NUMBER_OR_FLOAT (arg, 0);
Mike Rowan's avatar
Mike Rowan committed
819

820
  if (FLOATP (arg))
821 822 823 824 825 826
    {
      double d;

      d = XFLOAT (arg)->data;
      FLOAT_TO_INT (d, arg, "truncate", arg);
    }
827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853

  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
854

855 856 857 858 859 860
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);
861
  IN_FLOAT (d = rint (d), "fround", arg);
862 863 864 865 866 867 868 869 870 871 872 873 874
  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
875
    IN_FLOAT (d = ceil (d), "ftruncate", arg);
876
  return make_float (d);
Mike Rowan's avatar
Mike Rowan committed
877 878
}

879
#ifdef FLOAT_CATCH_SIGILL
Jim Blandy's avatar
Jim Blandy committed
880
static SIGTYPE
Mike Rowan's avatar
Mike Rowan committed
881 882 883 884 885 886
float_error (signo)
     int signo;
{
  if (! in_float)
    fatal_error_signal (signo);

Jim Blandy's avatar
Jim Blandy committed
887
#ifdef BSD
Mike Rowan's avatar
Mike Rowan committed
888 889 890
#ifdef BSD4_1
  sigrelse (SIGILL);
#else /* not BSD4_1 */
Jim Blandy's avatar
Jim Blandy committed
891
  sigsetmask (SIGEMPTYMASK);
Mike Rowan's avatar
Mike Rowan committed
892
#endif /* not BSD4_1 */
Jim Blandy's avatar
Jim Blandy committed
893 894 895 896
#else
  /* Must reestablish handler each time it is called.  */
  signal (SIGILL, float_error);
#endif /* BSD */
Mike Rowan's avatar
Mike Rowan committed
897 898 899 900 901 902

  in_float = 0;

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

903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937
/* 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
938 939
init_floatfns ()
{
940
#ifdef FLOAT_CATCH_SIGILL
Mike Rowan's avatar
Mike Rowan committed
941
  signal (SIGILL, float_error);
942
#endif 
Mike Rowan's avatar
Mike Rowan committed
943 944 945
  in_float = 0;
}

946 947 948 949 950 951 952
#else /* not LISP_FLOAT_TYPE */

init_floatfns ()
{}

#endif /* not LISP_FLOAT_TYPE */

Mike Rowan's avatar
Mike Rowan committed
953 954
syms_of_floatfns ()
{
955
#ifdef LISP_FLOAT_TYPE
Mike Rowan's avatar
Mike Rowan committed
956 957 958
  defsubr (&Sacos);
  defsubr (&Sasin);
  defsubr (&Satan);
959 960 961 962 963 964
  defsubr (&Scos);
  defsubr (&Ssin);
  defsubr (&Stan);
#if 0
  defsubr (&Sacosh);
  defsubr (&Sasinh);
Mike Rowan's avatar
Mike Rowan committed
965
  defsubr (&Satanh);
966 967 968
  defsubr (&Scosh);
  defsubr (&Ssinh);
  defsubr (&Stanh);
Mike Rowan's avatar
Mike Rowan committed
969 970 971 972 973 974 975 976
  defsubr (&Sbessel_y0);
  defsubr (&Sbessel_y1);
  defsubr (&Sbessel_yn);
  defsubr (&Sbessel_j0);
  defsubr (&Sbessel_j1);
  defsubr (&Sbessel_jn);
  defsubr (&Serf);
  defsubr (&Serfc);
977
  defsubr (&Slog_gamma);
978
  defsubr (&Scube_root);
979
#endif
980 981 982 983
  defsubr (&Sfceiling);
  defsubr (&Sffloor);
  defsubr (&Sfround);
  defsubr (&Sftruncate);
Mike Rowan's avatar
Mike Rowan committed
984
  defsubr (&Sexp);
985
  defsubr (&Sexpt);
Mike Rowan's avatar
Mike Rowan committed
986 987 988 989 990 991 992 993 994 995
  defsubr (&Slog);
  defsubr (&Slog10);
  defsubr (&Ssqrt);

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