floatfns.c 25.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
any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
18 19
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Mike Rowan's avatar
Mike Rowan committed
20 21


22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
/* 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
Karl Heuer's avatar
Karl Heuer committed
41
   either setting errno, or signaling SIGFPE/SIGILL.  Otherwise, domain and
42 43 44 45 46
   range checking will happen before calling the float routines.  This has
   no effect if HAVE_MATHERR is defined (since matherr will be called when
   a domain error occurs.)
 */

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

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

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

55 56 57 58 59 60 61 62 63 64 65 66 67 68
#if STDC_HEADERS
#include <float.h>
#endif

/* If IEEE_FLOATING_POINT isn't defined, default it from FLT_*. */
#ifndef IEEE_FLOATING_POINT
#if (FLT_RADIX == 2 && FLT_MANT_DIG == 24 \
     && FLT_MIN_EXP == -125 && FLT_MAX_EXP == 128)
#define IEEE_FLOATING_POINT 1
#else
#define IEEE_FLOATING_POINT 0
#endif
#endif

69 70 71 72 73 74 75 76 77 78
/* 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
79
#include <math.h>
80

81
/* This declaration is omitted on some systems, like Ultrix.  */
82
#if !defined (HPUX) && defined (HAVE_LOGB) && !defined (logb)
83
extern double logb ();
84
#endif /* not HPUX and HAVE_LOGB and no logb macro */
85

86 87 88 89 90 91 92
#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
93
#ifdef NO_MATHERR
94 95 96
#undef HAVE_MATHERR
#endif

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

extern int errno;
114
#endif
Jim Blandy's avatar
Jim Blandy committed
115 116 117 118 119 120 121 122 123 124 125

/* Avoid traps on VMS from sinh and cosh.
   All the other functions set errno instead.  */

#ifdef VMS
#undef cosh
#undef sinh
#define cosh(x) ((exp(x)+exp(-x))*0.5)
#define sinh(x) ((exp(x)-exp(-x))*0.5)
#endif /* VMS */

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

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

static int in_float;

/* If an argument is out of range for a mathematical function,
Richard M. Stallman's avatar
Richard M. Stallman committed
134 135 136
   here is the actual argument value to use in the error message.
   These variables are used only across the floating point library call
   so there is no need to staticpro them.  */
Mike Rowan's avatar
Mike Rowan committed
137

138 139 140
static Lisp_Object float_error_arg, float_error_arg2;

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

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

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

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

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

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

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

224
  if (FLOATP (num))
Mike Rowan's avatar
Mike Rowan committed
225 226 227
    return XFLOAT (num)->data;
  return (double) XINT (num);
}
228 229

/* Trig functions.  */
Mike Rowan's avatar
Mike Rowan committed
230 231 232

DEFUN ("acos", Facos, Sacos, 1, 1, 0,
  "Return the inverse cosine of ARG.")
233 234
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
235
{
236 237 238 239 240 241
  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
242 243 244
  return make_float (d);
}

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

259 260
DEFUN ("atan", Fatan, Satan, 1, 1, 0,
  "Return the inverse tangent of ARG.")
261 262
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
263
{
264 265
  double d = extract_float (arg);
  IN_FLOAT (d = atan (d), "atan", arg);
Mike Rowan's avatar
Mike Rowan committed
266 267 268
  return make_float (d);
}

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

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

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

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

DEFUN ("bessel-j1", Fbessel_j1, Sbessel_j1, 1, 1, 0,
  "Return the bessel function j1 of ARG.")
318 319
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
320
{
321 322
  double d = extract_float (arg);
  IN_FLOAT (d = j1 (d), "bessel-j1", arg);
Mike Rowan's avatar
Mike Rowan committed
323 324 325 326 327 328
  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.")
329 330
  (n, arg)
     register Lisp_Object n, arg;
Mike Rowan's avatar
Mike Rowan committed
331
{
332 333
  int i1 = extract_float (n);
  double f2 = extract_float (arg);
Mike Rowan's avatar
Mike Rowan committed
334

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

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

DEFUN ("bessel-y1", Fbessel_y1, Sbessel_y1, 1, 1, 0,
  "Return the bessel function y1 of ARG.")
351 352
  (arg)
     register Lisp_Object arg;
Mike Rowan's avatar
Mike Rowan committed
353
{
354 355
  double d = extract_float (arg);
  IN_FLOAT (d = y1 (d), "bessel-y0", arg);
Mike Rowan's avatar
Mike Rowan committed
356 357 358 359 360 361
  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.")
362 363
  (n, arg)
     register Lisp_Object n, arg;
Mike Rowan's avatar
Mike Rowan committed
364
{
365 366
  int i1 = extract_float (n);
  double f2 = extract_float (arg);
Mike Rowan's avatar
Mike Rowan committed
367

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

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

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

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

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

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

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

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

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

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

496
DEFUN ("log", Flog, Slog, 1, 2, 0,
497 498 499 500
  "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
501
{
502
  double d = extract_float (arg);
503

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

721 722 723
#endif /* LISP_FLOAT_TYPE */


724 725 726 727
/* the rounding functions  */

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

735 736
  if (! NILP (divisor))
    {
737
      EMACS_INT i1, i2;
738 739 740 741

      CHECK_NUMBER_OR_FLOAT (divisor, 1);

#ifdef LISP_FLOAT_TYPE
742
      if (FLOATP (arg) || FLOATP (divisor))
743 744 745
	{
	  double f1, f2;

746 747
	  f1 = FLOATP (arg) ? XFLOAT (arg)->data : XINT (arg);
	  f2 = (FLOATP (divisor) ? XFLOAT (divisor)->data : XINT (divisor));
748
	  if (! IEEE_FLOATING_POINT && f2 == 0)
749 750
	    Fsignal (Qarith_error, Qnil);

751 752
	  IN_FLOAT2 (f1 = (*double_round) (f1 / f2), name, arg, divisor);
	  FLOAT_TO_INT2 (f1, arg, name, arg, divisor);
753 754 755 756 757 758 759 760 761 762
	  return arg;
	}
#endif

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

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

763
      XSETINT (arg, (*int_round2) (i1, i2));
764 765 766 767
      return arg;
    }

#ifdef LISP_FLOAT_TYPE
768
  if (FLOATP (arg))
769 770
    {
      double d;
771 772 773

      IN_FLOAT (d = (*double_round) (XFLOAT (arg)->data), name, arg);
      FLOAT_TO_INT (d, arg, name, arg);
774
    }
775
#endif
Mike Rowan's avatar
Mike Rowan committed
776

777
  return arg;
Mike Rowan's avatar
Mike Rowan committed
778 779
}

780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826
/* With C's /, the result is implementation-defined if either operand
   is negative, so take care with negative operands in the following
   integer functions.  */

static EMACS_INT
ceiling2 (i1, i2)
     EMACS_INT i1, i2;
{
  return (i2 < 0
	  ? (i1 < 0  ?  ((-1 - i1) / -i2) + 1  :  - (i1 / -i2))
	  : (i1 <= 0  ?  - (-i1 / i2)  :  ((i1 - 1) / i2) + 1));
}

static EMACS_INT
floor2 (i1, i2)
     EMACS_INT i1, i2;
{
  return (i2 < 0
	  ? (i1 <= 0  ?  -i1 / -i2  :  -1 - ((i1 - 1) / -i2))
	  : (i1 < 0  ?  -1 - ((-1 - i1) / i2)  :  i1 / i2));
}

static EMACS_INT
truncate2 (i1, i2)
     EMACS_INT i1, i2;
{
  return (i2 < 0
	  ? (i1 < 0  ?  -i1 / -i2  :  - (i1 / -i2))
	  : (i1 < 0  ?  - (-i1 / i2)  :  i1 / i2));
}

static EMACS_INT
round2 (i1, i2)
     EMACS_INT i1, i2;
{
  /* The C language's division operator gives us one remainder R, but
     we want the remainder R1 on the other side of 0 if R1 is closer
     to 0 than R is; because we want to round to even, we also want R1
     if R and R1 are the same distance from 0 and if C's quotient is
     odd.  */
  EMACS_INT q = i1 / i2;
  EMACS_INT r = i1 % i2;
  EMACS_INT abs_r = r < 0 ? -r : r;
  EMACS_INT abs_r1 = (i2 < 0 ? -i2 : i2) - abs_r;
  return q + (abs_r + (q & 1) <= abs_r1 ? 0 : (i2 ^ r) < 0 ? -1 : 1);
}

827 828 829 830 831
#ifndef HAVE_RINT
static double
rint (d)
     double d;
{
Richard M. Stallman's avatar
Richard M. Stallman committed
832
  return floor (d + 0.5);
833 834 835
}
#endif

836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880
static double
double_identity (d)
     double d;
{
  return d;
}

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

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

DEFUN ("round", Fround, Sround, 1, 2, 0,
  "Return the nearest integer to ARG.\n\
With optional DIVISOR, return the nearest integer to ARG/DIVISOR.")
  (arg, divisor)
     Lisp_Object arg, divisor;
{
  return rounding_driver (arg, divisor, rint, round2, "round");
}

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

881 882
#ifdef LISP_FLOAT_TYPE

883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900
Lisp_Object
fmod_float (x, y)
     register Lisp_Object x, y;
{
  double f1, f2;

  f1 = FLOATP (x) ? XFLOAT (x)->data : XINT (x);
  f2 = FLOATP (y) ? XFLOAT (y)->data : XINT (y);

  if (! IEEE_FLOATING_POINT && f2 == 0)
    Fsignal (Qarith_error, Qnil);

  /* If the "remainder" comes out with the wrong sign, fix it.  */
  IN_FLOAT2 ((f1 = fmod (f1, f2),
	      f1 = (f2 < 0 ? f1 > 0 : f1 < 0) ? f1 + f2 : f1),
	     "mod", x, y);
  return make_float (f1);
}
901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924

/* 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
925

926 927 928 929 930 931
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);
932
  IN_FLOAT (d = rint (d), "fround", arg);
933 934 935 936 937 938 939 940 941 942 943 944 945
  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
946
    IN_FLOAT (d = ceil (d), "ftruncate", arg);
947
  return make_float (d);
Mike Rowan's avatar
Mike Rowan committed
948 949
}

950
#ifdef FLOAT_CATCH_SIGILL
Jim Blandy's avatar
Jim Blandy committed
951
static SIGTYPE
Mike Rowan's avatar
Mike Rowan committed
952 953 954 955 956 957
float_error (signo)
     int signo;
{
  if (! in_float)
    fatal_error_signal (signo);

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

  in_float = 0;

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

974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008
/* 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
1009 1010
init_floatfns ()
{
1011
#ifdef FLOAT_CATCH_SIGILL
Mike Rowan's avatar
Mike Rowan committed
1012
  signal (SIGILL, float_error);
1013
#endif 
Mike Rowan's avatar
Mike Rowan committed
1014 1015 1016
  in_float = 0;
}

1017 1018 1019 1020 1021 1022 1023
#else /* not LISP_FLOAT_TYPE */

init_floatfns ()
{}

#endif /* not LISP_FLOAT_TYPE */

Mike Rowan's avatar
Mike Rowan committed
1024 1025
syms_of_floatfns ()
{
1026
#ifdef LISP_FLOAT_TYPE
Mike Rowan's avatar
Mike Rowan committed
1027 1028 1029
  defsubr (&Sacos);
  defsubr (&Sasin);
  defsubr (&Satan);
1030 1031 1032 1033 1034 1035
  defsubr (&Scos);
  defsubr (&Ssin);
  defsubr (&Stan);
#if 0
  defsubr (&Sacosh);
  defsubr (&Sasinh);
Mike Rowan's avatar
Mike Rowan committed
1036
  defsubr (&Satanh);
1037 1038 1039
  defsubr (&Scosh);
  defsubr (&Ssinh);
  defsubr (&Stanh);
Mike Rowan's avatar
Mike Rowan committed
1040 1041 1042 1043 1044 1045 1046 1047
  defsubr (&Sbessel_y0);
  defsubr (&Sbessel_y1);
  defsubr (&Sbessel_yn);
  defsubr (&Sbessel_j0);
  defsubr (&Sbessel_j1);
  defsubr (&Sbessel_jn);
  defsubr (&Serf);
  defsubr (&Serfc);
1048
  defsubr (&Slog_gamma);
1049
  defsubr (&Scube_root);
1050
#endif
1051 1052 1053 1054
  defsubr (&Sfceiling);
  defsubr (&Sffloor);
  defsubr (&Sfround);
  defsubr (&Sftruncate);
Mike Rowan's avatar
Mike Rowan committed
1055
  defsubr (&Sexp);
1056
  defsubr (&Sexpt);
Mike Rowan's avatar
Mike Rowan committed
1057 1058 1059 1060 1061 1062 1063
  defsubr (&Slog);
  defsubr (&Slog10);
  defsubr (&Ssqrt);

  defsubr (&Sabs);
  defsubr (&Sfloat);
  defsubr (&Slogb);
1064
#endif /* LISP_FLOAT_TYPE */
Mike Rowan's avatar
Mike Rowan committed
1065
  defsubr (&Sceiling);
1066
  defsubr (&Sfloor);
Mike Rowan's avatar
Mike Rowan committed
1067 1068 1069
  defsubr (&Sround);
  defsubr (&Struncate);
}