]> code.delx.au - gnu-emacs/blobdiff - src/floatfns.c
(syms_of_lread) <load-history>: Doc fix.
[gnu-emacs] / src / floatfns.c
index d6cbb876e37c785dbff4186ea3c130b6b5275473..08405c307a7c3d21d2eb976c2b0d08bd4041c7d8 100644 (file)
@@ -107,8 +107,10 @@ extern double logb ();
 #ifdef FLOAT_CHECK_ERRNO
 # include <errno.h>
 
+#ifndef USE_CRT_DLL
 extern int errno;
 #endif
+#endif
 
 /* Avoid traps on VMS from sinh and cosh.
    All the other functions set errno instead.  */
@@ -120,7 +122,9 @@ extern int errno;
 #define sinh(x) ((exp(x)-exp(-x))*0.5)
 #endif /* VMS */
 
+#ifdef FLOAT_CATCH_SIGILL
 static SIGTYPE float_error ();
+#endif
 
 /* Nonzero while executing in floating point.
    This tells float_error what to do.  */
@@ -181,8 +185,7 @@ static char *float_error_fn_name;
 #define FLOAT_TO_INT(x, i, name, num)                                  \
   do                                                                   \
     {                                                                  \
-      if ((x) >= (((EMACS_INT) 1) << (VALBITS-1)) ||                   \
-         (x) <= - (((EMACS_INT) 1) << (VALBITS-1)) - 1)                \
+      if (FIXNUM_OVERFLOW_P (x))                                       \
        range_error (name, num);                                        \
       XSETINT (i,  (EMACS_INT)(x));                                    \
     }                                                                  \
@@ -190,8 +193,7 @@ static char *float_error_fn_name;
 #define FLOAT_TO_INT2(x, i, name, num1, num2)                          \
   do                                                                   \
     {                                                                  \
-      if ((x) >= (((EMACS_INT) 1) << (VALBITS-1)) ||                   \
-         (x) <= - (((EMACS_INT) 1) << (VALBITS-1)) - 1)                \
+      if (FIXNUM_OVERFLOW_P (x))                                       \
        range_error2 (name, num1, num2);                                \
       XSETINT (i,  (EMACS_INT)(x));                                    \
     }                                                                  \
@@ -216,7 +218,7 @@ double
 extract_float (num)
      Lisp_Object num;
 {
-  CHECK_NUMBER_OR_FLOAT (num, 0);
+  CHECK_NUMBER_OR_FLOAT (num);
 
   if (FLOATP (num))
     return XFLOAT_DATA (num);
@@ -226,8 +228,8 @@ extract_float (num)
 /* Trig functions.  */
 
 DEFUN ("acos", Facos, Sacos, 1, 1, 0,
-  "Return the inverse cosine of ARG.")
-  (arg)
+       doc: /* Return the inverse cosine of ARG.  */)
+     (arg)
      register Lisp_Object arg;
 {
   double d = extract_float (arg);
@@ -240,8 +242,8 @@ DEFUN ("acos", Facos, Sacos, 1, 1, 0,
 }
 
 DEFUN ("asin", Fasin, Sasin, 1, 1, 0,
-  "Return the inverse sine of ARG.")
-  (arg)
+       doc: /* Return the inverse sine of ARG.  */)
+     (arg)
      register Lisp_Object arg;
 {
   double d = extract_float (arg);
@@ -253,19 +255,31 @@ DEFUN ("asin", Fasin, Sasin, 1, 1, 0,
   return make_float (d);
 }
 
-DEFUN ("atan", Fatan, Satan, 1, 1, 0,
-  "Return the inverse tangent of ARG.")
-  (arg)
-     register Lisp_Object arg;
+DEFUN ("atan", Fatan, Satan, 1, 2, 0,
+       doc: /* Return the inverse tangent of the arguments.
+If only one argument Y is given, return the inverse tangent of Y.
+If two arguments Y and X are given, return the inverse tangent of Y
+divided by X, i.e. the angle in radians between the vector (X, Y)
+and the x-axis.  */)
+     (y, x)
+     register Lisp_Object y, x;
 {
-  double d = extract_float (arg);
-  IN_FLOAT (d = atan (d), "atan", arg);
+  double d = extract_float (y);
+
+  if (NILP (x))
+    IN_FLOAT (d = atan (d), "atan", y);
+  else
+    {
+      double d2 = extract_float (x);
+
+      IN_FLOAT2 (d = atan2 (d, d2), "atan", y, x);
+    }
   return make_float (d);
 }
 
 DEFUN ("cos", Fcos, Scos, 1, 1, 0,
-  "Return the cosine of ARG.")
-  (arg)
+       doc: /* Return the cosine of ARG.  */)
+     (arg)
      register Lisp_Object arg;
 {
   double d = extract_float (arg);
@@ -274,8 +288,8 @@ DEFUN ("cos", Fcos, Scos, 1, 1, 0,
 }
 
 DEFUN ("sin", Fsin, Ssin, 1, 1, 0,
-  "Return the sine of ARG.")
-  (arg)
+       doc: /* Return the sine of ARG.  */)
+     (arg)
      register Lisp_Object arg;
 {
   double d = extract_float (arg);
@@ -284,8 +298,8 @@ DEFUN ("sin", Fsin, Ssin, 1, 1, 0,
 }
 
 DEFUN ("tan", Ftan, Stan, 1, 1, 0,
-  "Return the tangent of ARG.")
-  (arg)
+       doc: /* Return the tangent of ARG.  */)
+     (arg)
      register Lisp_Object arg;
 {
   double d = extract_float (arg);
@@ -301,8 +315,8 @@ DEFUN ("tan", Ftan, Stan, 1, 1, 0,
 #if 0 /* Leave these out unless we find there's a reason for them.  */
 
 DEFUN ("bessel-j0", Fbessel_j0, Sbessel_j0, 1, 1, 0,
-  "Return the bessel function j0 of ARG.")
-  (arg)
+       doc: /* Return the bessel function j0 of ARG.  */)
+     (arg)
      register Lisp_Object arg;
 {
   double d = extract_float (arg);
@@ -311,8 +325,8 @@ DEFUN ("bessel-j0", Fbessel_j0, Sbessel_j0, 1, 1, 0,
 }
 
 DEFUN ("bessel-j1", Fbessel_j1, Sbessel_j1, 1, 1, 0,
-  "Return the bessel function j1 of ARG.")
-  (arg)
+       doc: /* Return the bessel function j1 of ARG.  */)
+     (arg)
      register Lisp_Object arg;
 {
   double d = extract_float (arg);
@@ -321,9 +335,9 @@ DEFUN ("bessel-j1", Fbessel_j1, Sbessel_j1, 1, 1, 0,
 }
 
 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.")
-  (n, arg)
+       doc: /* Return the order N bessel function output jn of ARG.
+The first arg (the order) is truncated to an integer.  */)
+     (n, arg)
      register Lisp_Object n, arg;
 {
   int i1 = extract_float (n);
@@ -334,8 +348,8 @@ The first arg (the order) is truncated to an integer.")
 }
 
 DEFUN ("bessel-y0", Fbessel_y0, Sbessel_y0, 1, 1, 0,
-  "Return the bessel function y0 of ARG.")
-  (arg)
+       doc: /* Return the bessel function y0 of ARG.  */)
+     (arg)
      register Lisp_Object arg;
 {
   double d = extract_float (arg);
@@ -344,8 +358,8 @@ DEFUN ("bessel-y0", Fbessel_y0, Sbessel_y0, 1, 1, 0,
 }
 
 DEFUN ("bessel-y1", Fbessel_y1, Sbessel_y1, 1, 1, 0,
-  "Return the bessel function y1 of ARG.")
-  (arg)
+       doc: /* Return the bessel function y1 of ARG.  */)
+     (arg)
      register Lisp_Object arg;
 {
   double d = extract_float (arg);
@@ -354,9 +368,9 @@ DEFUN ("bessel-y1", Fbessel_y1, Sbessel_y1, 1, 1, 0,
 }
 
 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.")
-  (n, arg)
+       doc: /* Return the order N bessel function output yn of ARG.
+The first arg (the order) is truncated to an integer.  */)
+     (n, arg)
      register Lisp_Object n, arg;
 {
   int i1 = extract_float (n);
@@ -371,8 +385,8 @@ The first arg (the order) is truncated to an integer.")
 #if 0 /* Leave these out unless we see they are worth having.  */
 
 DEFUN ("erf", Ferf, Serf, 1, 1, 0,
-  "Return the mathematical error function of ARG.")
-  (arg)
+       doc: /* Return the mathematical error function of ARG.  */)
+     (arg)
      register Lisp_Object arg;
 {
   double d = extract_float (arg);
@@ -381,8 +395,8 @@ DEFUN ("erf", Ferf, Serf, 1, 1, 0,
 }
 
 DEFUN ("erfc", Ferfc, Serfc, 1, 1, 0,
-  "Return the complementary error function of ARG.")
-  (arg)
+       doc: /* Return the complementary error function of ARG.  */)
+     (arg)
      register Lisp_Object arg;
 {
   double d = extract_float (arg);
@@ -391,8 +405,8 @@ DEFUN ("erfc", Ferfc, Serfc, 1, 1, 0,
 }
 
 DEFUN ("log-gamma", Flog_gamma, Slog_gamma, 1, 1, 0,
-  "Return the log gamma of ARG.")
-  (arg)
+       doc: /* Return the log gamma of ARG.  */)
+     (arg)
      register Lisp_Object arg;
 {
   double d = extract_float (arg);
@@ -401,8 +415,8 @@ DEFUN ("log-gamma", Flog_gamma, Slog_gamma, 1, 1, 0,
 }
 
 DEFUN ("cube-root", Fcube_root, Scube_root, 1, 1, 0,
-  "Return the cube root of ARG.")
-  (arg)
+       doc: /* Return the cube root of ARG.  */)
+     (arg)
      register Lisp_Object arg;
 {
   double d = extract_float (arg);
@@ -420,8 +434,8 @@ DEFUN ("cube-root", Fcube_root, Scube_root, 1, 1, 0,
 #endif
 \f
 DEFUN ("exp", Fexp, Sexp, 1, 1, 0,
-  "Return the exponential base e of ARG.")
-  (arg)
+       doc: /* Return the exponential base e of ARG.  */)
+     (arg)
      register Lisp_Object arg;
 {
   double d = extract_float (arg);
@@ -437,14 +451,14 @@ DEFUN ("exp", Fexp, Sexp, 1, 1, 0,
 }
 
 DEFUN ("expt", Fexpt, Sexpt, 2, 2, 0,
-  "Return the exponential ARG1 ** ARG2.")
-  (arg1, arg2)
+       doc: /* Return the exponential ARG1 ** ARG2.  */)
+     (arg1, arg2)
      register Lisp_Object arg1, arg2;
 {
   double f1, f2;
 
-  CHECK_NUMBER_OR_FLOAT (arg1, 0);
-  CHECK_NUMBER_OR_FLOAT (arg2, 0);
+  CHECK_NUMBER_OR_FLOAT (arg1);
+  CHECK_NUMBER_OR_FLOAT (arg2);
   if (INTEGERP (arg1)     /* common lisp spec */
       && INTEGERP (arg2)) /* don't promote, if both are ints */
     {                          /* this can be improved by pre-calculating */
@@ -491,9 +505,9 @@ DEFUN ("expt", Fexpt, Sexpt, 2, 2, 0,
 }
 
 DEFUN ("log", Flog, Slog, 1, 2, 0,
-  "Return the natural logarithm of ARG.\n\
-If second optional argument BASE is given, return log ARG using that base.")
-  (arg, base)
+       doc: /* Return the natural logarithm of ARG.
+If second optional argument BASE is given, return log ARG using that base.  */)
+     (arg, base)
      register Lisp_Object arg, base;
 {
   double d = extract_float (arg);
@@ -521,8 +535,8 @@ If second optional argument BASE is given, return log ARG using that base.")
 }
 
 DEFUN ("log10", Flog10, Slog10, 1, 1, 0,
-  "Return the logarithm base 10 of ARG.")
-  (arg)
+       doc: /* Return the logarithm base 10 of ARG.  */)
+     (arg)
      register Lisp_Object arg;
 {
   double d = extract_float (arg);
@@ -535,8 +549,8 @@ DEFUN ("log10", Flog10, Slog10, 1, 1, 0,
 }
 
 DEFUN ("sqrt", Fsqrt, Ssqrt, 1, 1, 0,
-  "Return the square root of ARG.")
-  (arg)
+       doc: /* Return the square root of ARG.  */)
+     (arg)
      register Lisp_Object arg;
 {
   double d = extract_float (arg);
@@ -551,8 +565,8 @@ DEFUN ("sqrt", Fsqrt, Ssqrt, 1, 1, 0,
 #if 0 /* Not clearly worth adding.  */
 
 DEFUN ("acosh", Facosh, Sacosh, 1, 1, 0,
-  "Return the inverse hyperbolic cosine of ARG.")
-  (arg)
+       doc: /* Return the inverse hyperbolic cosine of ARG.  */)
+     (arg)
      register Lisp_Object arg;
 {
   double d = extract_float (arg);
@@ -569,8 +583,8 @@ DEFUN ("acosh", Facosh, Sacosh, 1, 1, 0,
 }
 
 DEFUN ("asinh", Fasinh, Sasinh, 1, 1, 0,
-  "Return the inverse hyperbolic sine of ARG.")
-  (arg)
+       doc: /* Return the inverse hyperbolic sine of ARG.  */)
+     (arg)
      register Lisp_Object arg;
 {
   double d = extract_float (arg);
@@ -583,8 +597,8 @@ DEFUN ("asinh", Fasinh, Sasinh, 1, 1, 0,
 }
 
 DEFUN ("atanh", Fatanh, Satanh, 1, 1, 0,
-  "Return the inverse hyperbolic tangent of ARG.")
-  (arg)
+       doc: /* Return the inverse hyperbolic tangent of ARG.  */)
+     (arg)
      register Lisp_Object arg;
 {
   double d = extract_float (arg);
@@ -601,8 +615,8 @@ DEFUN ("atanh", Fatanh, Satanh, 1, 1, 0,
 }
 
 DEFUN ("cosh", Fcosh, Scosh, 1, 1, 0,
-  "Return the hyperbolic cosine of ARG.")
-  (arg)
+       doc: /* Return the hyperbolic cosine of ARG.  */)
+     (arg)
      register Lisp_Object arg;
 {
   double d = extract_float (arg);
@@ -615,8 +629,8 @@ DEFUN ("cosh", Fcosh, Scosh, 1, 1, 0,
 }
 
 DEFUN ("sinh", Fsinh, Ssinh, 1, 1, 0,
-  "Return the hyperbolic sine of ARG.")
-  (arg)
+       doc: /* Return the hyperbolic sine of ARG.  */)
+     (arg)
      register Lisp_Object arg;
 {
   double d = extract_float (arg);
@@ -629,8 +643,8 @@ DEFUN ("sinh", Fsinh, Ssinh, 1, 1, 0,
 }
 
 DEFUN ("tanh", Ftanh, Stanh, 1, 1, 0,
-  "Return the hyperbolic tangent of ARG.")
-  (arg)
+       doc: /* Return the hyperbolic tangent of ARG.  */)
+     (arg)
      register Lisp_Object arg;
 {
   double d = extract_float (arg);
@@ -640,11 +654,11 @@ DEFUN ("tanh", Ftanh, Stanh, 1, 1, 0,
 #endif
 \f
 DEFUN ("abs", Fabs, Sabs, 1, 1, 0,
-  "Return the absolute value of ARG.")
-  (arg)
+       doc: /* Return the absolute value of ARG.  */)
+     (arg)
      register Lisp_Object arg;
 {
-  CHECK_NUMBER_OR_FLOAT (arg, 0);
+  CHECK_NUMBER_OR_FLOAT (arg);
 
   if (FLOATP (arg))
     IN_FLOAT (arg = make_float (fabs (XFLOAT_DATA (arg))), "abs", arg);
@@ -655,11 +669,11 @@ DEFUN ("abs", Fabs, Sabs, 1, 1, 0,
 }
 
 DEFUN ("float", Ffloat, Sfloat, 1, 1, 0,
-  "Return the floating point number equal to ARG.")
-  (arg)
+       doc: /* Return the floating point number equal to ARG.  */)
+     (arg)
      register Lisp_Object arg;
 {
-  CHECK_NUMBER_OR_FLOAT (arg, 0);
+  CHECK_NUMBER_OR_FLOAT (arg);
 
   if (INTEGERP (arg))
     return make_float ((double) XINT (arg));
@@ -668,8 +682,8 @@ DEFUN ("float", Ffloat, Sfloat, 1, 1, 0,
 }
 
 DEFUN ("logb", Flogb, Slogb, 1, 1, 0,
-  "Returns largest integer <= the base 2 log of the magnitude of ARG.\n\
-This is the same as the exponent of a float.")
+       doc: /* Returns largest integer <= the base 2 log of the magnitude of ARG.
+This is the same as the exponent of a float.  */)
      (arg)
      Lisp_Object arg;
 {
@@ -725,13 +739,13 @@ rounding_driver (arg, divisor, double_round, int_round2, name)
      EMACS_INT (*int_round2) ();
      char *name;
 {
-  CHECK_NUMBER_OR_FLOAT (arg, 0);
+  CHECK_NUMBER_OR_FLOAT (arg);
 
   if (! NILP (divisor))
     {
       EMACS_INT i1, i2;
 
-      CHECK_NUMBER_OR_FLOAT (divisor, 1);
+      CHECK_NUMBER_OR_FLOAT (divisor);
 
       if (FLOATP (arg) || FLOATP (divisor))
        {
@@ -836,37 +850,44 @@ double_identity (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)
+       doc: /* Return the smallest integer no less than ARG.
+This rounds the value towards +inf.
+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)
+       doc: /* Return the largest integer no greater than ARG.
+This rounds the value towards +inf.
+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)
+       doc: /* Return the nearest integer to ARG.
+With optional DIVISOR, return the nearest integer to ARG/DIVISOR.
+
+Rounding a value equidistant between two integers may choose the
+integer closer to zero, or it may prefer an even integer, depending on
+your machine.  For example, \(round 2.5\) can return 3 on some
+systems, but 2 on others.  */)
+     (arg, divisor)
      Lisp_Object arg, divisor;
 {
   return rounding_driver (arg, divisor, emacs_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)
+       doc: /* Truncate a floating point number to an int.
+Rounds ARG toward zero.
+With optional DIVISOR, truncate ARG/DIVISOR.  */)
+     (arg, divisor)
      Lisp_Object arg, divisor;
 {
   return rounding_driver (arg, divisor, double_identity, truncate2,
@@ -896,9 +917,9 @@ fmod_float (x, y)
 /* 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)
+       doc: /* Return the smallest integer no less than ARG, as a float.
+\(Round toward +inf.\)  */)
+     (arg)
      register Lisp_Object arg;
 {
   double d = extract_float (arg);
@@ -907,9 +928,9 @@ DEFUN ("fceiling", Ffceiling, Sfceiling, 1, 1, 0,
 }
 
 DEFUN ("ffloor", Fffloor, Sffloor, 1, 1, 0,
-  "Return the largest integer no greater than ARG, as a float.\n\
-\(Round towards -inf.\)")
-  (arg)
+       doc: /* Return the largest integer no greater than ARG, as a float.
+\(Round towards -inf.\)  */)
+     (arg)
      register Lisp_Object arg;
 {
   double d = extract_float (arg);
@@ -918,8 +939,8 @@ DEFUN ("ffloor", Fffloor, Sffloor, 1, 1, 0,
 }
 
 DEFUN ("fround", Ffround, Sfround, 1, 1, 0,
-  "Return the nearest integer to ARG, as a float.")
-  (arg)
+       doc: /* Return the nearest integer to ARG, as a float.  */)
+     (arg)
      register Lisp_Object arg;
 {
   double d = extract_float (arg);
@@ -928,9 +949,9 @@ DEFUN ("fround", Ffround, Sfround, 1, 1, 0,
 }
 
 DEFUN ("ftruncate", Fftruncate, Sftruncate, 1, 1, 0,
-  "Truncate a floating point number to an integral float value.\n\
-Rounds the value toward zero.")
-  (arg)
+       doc: /* Truncate a floating point number to an integral float value.
+Rounds the value toward zero.  */)
+     (arg)
      register Lisp_Object arg;
 {
   double d = extract_float (arg);