floatfns.c 24 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
#ifdef MSDOS
Karl Heuer's avatar
Karl Heuer committed
57
/* These are redefined (correctly, but differently) in values.h.  */
58 59 60 61 62
#undef INTBITS
#undef LONGBITS
#undef SHORTBITS
#endif

63 64 65 66 67 68 69 70 71 72
/* 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
73
#include <math.h>
74

75
/* This declaration is omitted on some systems, like Ultrix.  */
76
#if !defined (HPUX) && defined (HAVE_LOGB)
77
extern double logb ();
78
#endif /* not HPUX and HAVE_LOGB */
79

80 81 82 83 84 85 86
#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
87
#ifdef NO_MATHERR
88 89 90
#undef HAVE_MATHERR
#endif

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

extern int errno;
108
#endif
Jim Blandy's avatar
Jim Blandy committed
109 110 111 112 113 114 115 116 117 118 119

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

120 121 122 123
#ifndef HAVE_RINT
#define rint(x) (floor((x)+0.5))
#endif

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

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

134 135 136
static Lisp_Object float_error_arg, float_error_arg2;

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

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

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

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

197 198 199 200
#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)))
201 202 203
#define range_error2(op,a1,a2) \
  Fsignal (Qrange_error, Fcons (build_string ((op)), \
				Fcons ((a1), Fcons ((a2), Qnil))))
204 205 206
#define domain_error(op,arg) \
  Fsignal (Qdomain_error, Fcons (build_string ((op)), Fcons ((arg), Qnil)))
#define domain_error2(op,a1,a2) \
207 208
  Fsignal (Qdomain_error, Fcons (build_string ((op)), \
				 Fcons ((a1), Fcons ((a2), Qnil))))
Mike Rowan's avatar
Mike Rowan committed
209 210 211 212 213 214 215 216 217 218 219 220 221

/* 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);
}
222 223

/* Trig functions.  */
Mike Rowan's avatar
Mike Rowan committed
224 225 226

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

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

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

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

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

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

Mike Rowan's avatar
Mike Rowan committed
300 301
DEFUN ("bessel-j0", Fbessel_j0, Sbessel_j0, 1, 1, 0,
  "Return the bessel function j0 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 = j0 (d), "bessel-j0", arg);
Mike Rowan's avatar
Mike Rowan committed
307 308 309 310 311
  return make_float (d);
}

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

329
  IN_FLOAT (f2 = jn (i1, f2), "bessel-jn", arg1);
Mike Rowan's avatar
Mike Rowan committed
330 331 332 333 334
  return make_float (f2);
}

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

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

362
  IN_FLOAT (f2 = yn (i1, f2), "bessel-yn", arg1);
Mike Rowan's avatar
Mike Rowan committed
363 364 365
  return make_float (f2);
}

366 367 368
#endif

#if 0 /* Leave these out unless we see they are worth having.  */
Mike Rowan's avatar
Mike Rowan committed
369 370 371

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

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

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

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

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

DEFUN ("expt", Fexpt, Sexpt, 2, 2, 0,
437
  "Return the exponential X ** Y.")
438 439
  (arg1, arg2)
     register Lisp_Object arg1, arg2;
Mike Rowan's avatar
Mike Rowan committed
440 441 442
{
  double f1, f2;

443 444
  CHECK_NUMBER_OR_FLOAT (arg1, 0);
  CHECK_NUMBER_OR_FLOAT (arg2, 0);
Richard M. Stallman's avatar
Richard M. Stallman committed
445 446
  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
447
    {				/* this can be improved by pre-calculating */
448
      int acc, x, y;		/* some binary powers of x then accumulating */
449 450
      Lisp_Object val;

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

490
DEFUN ("log", Flog, Slog, 1, 2, 0,
491 492 493 494
  "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
495
{
496
  double d = extract_float (arg);
497

498 499 500 501
#ifdef FLOAT_CHECK_DOMAIN
  if (d <= 0.0)
    domain_error2 ("log", arg, base);
#endif
502
  if (NILP (base))
503
    IN_FLOAT (d = log (d), "log", arg);
504 505 506 507
  else
    {
      double b = extract_float (base);

508 509 510 511 512 513 514
#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
515
	IN_FLOAT2 (d = log (d) / log (b), "log", arg, base);
516
    }
Mike Rowan's avatar
Mike Rowan committed
517 518 519
  return make_float (d);
}

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

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

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

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

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

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

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

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

646 647 648 649
  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
650

651
  return arg;
Mike Rowan's avatar
Mike Rowan committed
652 653 654 655
}

DEFUN ("float", Ffloat, Sfloat, 1, 1, 0,
  "Return the floating point number equal to ARG.")
656 657
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
658
{
659
  CHECK_NUMBER_OR_FLOAT (arg, 0);
Mike Rowan's avatar
Mike Rowan committed
660

661 662
  if (XTYPE (arg) == Lisp_Int)
    return make_float ((double) XINT (arg));
Mike Rowan's avatar
Mike Rowan committed
663
  else				/* give 'em the same float back */
664
    return arg;
Mike Rowan's avatar
Mike Rowan committed
665 666 667
}

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

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

/* the rounding functions  */

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

723
  if (XTYPE (arg) == Lisp_Float)
724 725 726 727 728 729
    {
      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
730

731
  return arg;
Mike Rowan's avatar
Mike Rowan committed
732 733
}

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

762 763
	  IN_FLOAT2 (f1 = floor (f1 / f2), "floor", arg, divisor);
	  FLOAT_TO_INT2 (f1, arg, "floor", arg, divisor);
764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784
	  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
785
  if (XTYPE (arg) == Lisp_Float)
786 787 788 789 790
    {
      double d;
      IN_FLOAT (d = floor (XFLOAT (arg)->data), "floor", arg);
      FLOAT_TO_INT (d, arg, "floor", arg);
    }
791
#endif
Mike Rowan's avatar
Mike Rowan committed
792

793
  return arg;
Mike Rowan's avatar
Mike Rowan committed
794 795
}

796 797
#ifdef LISP_FLOAT_TYPE

Mike Rowan's avatar
Mike Rowan committed
798 799
DEFUN ("round", Fround, Sround, 1, 1, 0,
  "Return the nearest integer to ARG.")
800 801
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
802
{
803
  CHECK_NUMBER_OR_FLOAT (arg, 0);
Mike Rowan's avatar
Mike Rowan committed
804

805
  if (XTYPE (arg) == Lisp_Float)
806 807 808 809 810 811 812
    {
      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
813

814
  return arg;
Mike Rowan's avatar
Mike Rowan committed
815 816 817 818 819
}

DEFUN ("truncate", Ftruncate, Struncate, 1, 1, 0,
       "Truncate a floating point number to an int.\n\
Rounds the value toward zero.")
820 821
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
822
{
823
  CHECK_NUMBER_OR_FLOAT (arg, 0);
Mike Rowan's avatar
Mike Rowan committed
824

825
  if (XTYPE (arg) == Lisp_Float)
826 827 828 829 830 831
    {
      double d;

      d = XFLOAT (arg)->data;
      FLOAT_TO_INT (d, arg, "truncate", arg);
    }
832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858

  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
859

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

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

  in_float = 0;

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

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 938 939 940 941 942
/* 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
943 944
init_floatfns ()
{
945
#ifdef FLOAT_CATCH_SIGILL
Mike Rowan's avatar
Mike Rowan committed
946
  signal (SIGILL, float_error);
947
#endif 
Mike Rowan's avatar
Mike Rowan committed
948 949 950
  in_float = 0;
}

951 952 953 954 955 956 957
#else /* not LISP_FLOAT_TYPE */

init_floatfns ()
{}

#endif /* not LISP_FLOAT_TYPE */

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

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