Update.
[platform/upstream/glibc.git] / math / math.h
index f1f8260..ebd601a 100644 (file)
@@ -1,5 +1,5 @@
 /* Declarations for math functions.
-   Copyright (C) 1991, 92, 93, 95, 96, 97 Free Software Foundation, Inc.
+   Copyright (C) 1991,92,93,95,96,97,98,99,2001 Free Software Foundation, Inc.
    This file is part of the GNU C Library.
 
    The GNU C Library is free software; you can redistribute it and/or
@@ -18,7 +18,7 @@
    Boston, MA 02111-1307, USA.  */
 
 /*
- *     ISO C Standard: 4.5 MATHEMATICS <math.h>
+ *     ISO C99 Standard: 7.12 Mathematics      <math.h>
  */
 
 #ifndef        _MATH_H
@@ -33,9 +33,11 @@ __BEGIN_DECLS
 #include <bits/huge_val.h>
 
 /* Get machine-dependent NAN value (returned for some domain errors).  */
-#ifdef  __USE_GNU
+#ifdef  __USE_ISOC99
 # include <bits/nan.h>
 #endif
+/* Get general and ISO C99 specific information.  */
+#include <bits/mathdef.h>
 
 
 /* The file <bits/mathcalls.h> contains the prototypes for all the
@@ -54,7 +56,7 @@ __BEGIN_DECLS
   __MATHDECL_1(type, function,suffix, args) __attribute__ (attrib); \
   __MATHDECL_1(type, __CONCAT(__,function),suffix, args) __attribute__ (attrib)
 #define __MATHDECL_1(type, function,suffix, args) \
-  extern type __MATH_PRECNAME(function,suffix) args
+  extern type __MATH_PRECNAME(function,suffix) args __THROW
 
 #define _Mdouble_              double
 #define __MATH_PRECNAME(name,r)        __CONCAT(name,r)
@@ -62,77 +64,91 @@ __BEGIN_DECLS
 #undef _Mdouble_
 #undef __MATH_PRECNAME
 
-#if defined __USE_MISC || defined __USE_ISOC9X
+#if defined __USE_MISC || defined __USE_ISOC99
 
 
 /* Include the file of declarations again, this time using `float'
    instead of `double' and appending f to each function name.  */
 
-#ifndef _Mfloat_
-# define _Mfloat_              float
-#endif
-#define _Mdouble_              _Mfloat_
-#ifdef __STDC__
-# define __MATH_PRECNAME(name,r) name##f##r
-#else
-# define __MATH_PRECNAME(name,r) name/**/f/**/r
-#endif
-#include <bits/mathcalls.h>
-#undef _Mdouble_
-#undef __MATH_PRECNAME
-
-#if __STDC__ - 0 || __GNUC__ - 0
-/* Include the file of declarations again, this time using `long double'
-   instead of `double' and appending l to each function name.  */
-
-# ifndef _Mlong_double_
-#  define _Mlong_double_       long double
+# ifndef _Mfloat_
+#  define _Mfloat_             float
 # endif
-# define _Mdouble_             _Mlong_double_
+# define _Mdouble_             _Mfloat_
 # ifdef __STDC__
-#  define __MATH_PRECNAME(name,r) name##l##r
+#  define __MATH_PRECNAME(name,r) name##f##r
 # else
-#  define __MATH_PRECNAME(name,r) name/**/l/**/r
+#  define __MATH_PRECNAME(name,r) name/**/f/**/r
 # endif
 # include <bits/mathcalls.h>
 # undef        _Mdouble_
 # undef        __MATH_PRECNAME
 
-#endif /* __STDC__ || __GNUC__ */
+# if (__STDC__ - 0 || __GNUC__ - 0) && !defined __NO_LONG_DOUBLE_MATH
+/* Include the file of declarations again, this time using `long double'
+   instead of `double' and appending l to each function name.  */
 
-#endif /* Use misc or ISO C 9X.  */
+#  ifndef _Mlong_double_
+#   define _Mlong_double_      long double
+#  endif
+#  define _Mdouble_            _Mlong_double_
+#  ifdef __STDC__
+#   define __MATH_PRECNAME(name,r) name##l##r
+#  else
+#   define __MATH_PRECNAME(name,r) name/**/l/**/r
+#  endif
+#  include <bits/mathcalls.h>
+#  undef _Mdouble_
+#  undef __MATH_PRECNAME
+
+# endif /* __STDC__ || __GNUC__ */
+
+#endif /* Use misc or ISO C99.  */
 #undef __MATHDECL_1
 #undef __MATHDECL
 #undef __MATHCALL
 
 
-#if defined __USE_MISC || defined __USE_XOPEN || defined __USE_ISOC9X
+#if defined __USE_MISC || defined __USE_XOPEN
 /* This variable is used by `gamma' and `lgamma'.  */
 extern int signgam;
 #endif
 
 
-/* ISO C 9X defines some generic macros which work on any data type.  */
-#if __USE_ISOC9X
+/* ISO C99 defines some generic macros which work on any data type.  */
+#if __USE_ISOC99
 
 /* Get the architecture specific values describing the floating-point
    evaluation.  The following symbols will get defined:
 
-     float_t   floating-point type at least as wide as `float' used
+    float_t    floating-point type at least as wide as `float' used
                to evaluate `float' expressions
-     double_t  floating-point type at least as wide as `double' used
+    double_t   floating-point type at least as wide as `double' used
                to evaluate `double' expressions
 
-     FLT_EVAL_METHOD
+    FLT_EVAL_METHOD
                Defined to
                  0     if `float_t' is `float' and `double_t' is `double'
                  1     if `float_t' and `double_t' are `double'
                  2     if `float_t' and `double_t' are `long double'
                  else  `float_t' and `double_t' are unspecified
 
-     INFINITY  representation of the infinity value of type `float_t'
+    INFINITY   representation of the infinity value of type `float'
+
+    FP_FAST_FMA
+    FP_FAST_FMAF
+    FP_FAST_FMAL
+               If defined it indicates that the `fma' function
+               generally executes about as fast as a multiply and an add.
+               This macro is defined only iff the `fma' function is
+               implemented directly with a hardware multiply-add instructions.
+
+    FP_ILOGB0  Expands to a value returned by `ilogb (0.0)'.
+    FP_ILOGBNAN        Expands to a value returned by `ilogb (NAN)'.
+
+    DECIMAL_DIG        Number of decimal digits supported by conversion between
+               decimal and all internal floating-point formats.
+
 */
-# include <bits/mathdef.h>
 
 /* All floating-point numbers can be put in one of these categories.  */
 enum
@@ -150,56 +166,85 @@ enum
   };
 
 /* Return number of classification appropriate for X.  */
-# define fpclassify(x) \
-     (sizeof (x) == sizeof (float) ?                                         \
-        __fpclassifyf (x)                                                    \
-      : sizeof (x) == sizeof (double) ?                                              \
-        __fpclassify (x) : __fpclassifyl (x))
+# ifdef __NO_LONG_DOUBLE_MATH
+#  define fpclassify(x) \
+     (sizeof (x) == sizeof (float) ? __fpclassifyf (x) : __fpclassify (x))
+# else
+#  define fpclassify(x) \
+     (sizeof (x) == sizeof (float)                                           \
+      ? __fpclassifyf (x)                                                    \
+      : sizeof (x) == sizeof (double)                                        \
+      ? __fpclassify (x) : __fpclassifyl (x))
+# endif
 
 /* Return nonzero value if sign of X is negative.  */
-# define signbit(x) \
-     (sizeof (x) == sizeof (float) ?                                         \
-        __signbitf (x)                                                       \
-      : sizeof (x) == sizeof (double) ?                                              \
-        __signbit (x) : __signbitl (x))
+# ifdef __NO_LONG_DOUBLE_MATH
+#  define signbit(x) \
+     (sizeof (x) == sizeof (float) ? __signbitf (x) : __signbit (x))
+# else
+#  define signbit(x) \
+     (sizeof (x) == sizeof (float)                                           \
+      ? __signbitf (x)                                                       \
+      : sizeof (x) == sizeof (double)                                        \
+      ? __signbit (x) : __signbitl (x))
+# endif
 
 /* Return nonzero value if X is not +-Inf or NaN.  */
-# define isfinite(x) \
-     (sizeof (x) == sizeof (float) ?                                         \
-        __finitef (x)                                                        \
-      : sizeof (x) == sizeof (double) ?                                              \
-        __finite (x) : __finitel (x))
+# ifdef __NO_LONG_DOUBLE_MATH
+#  define isfinite(x) \
+     (sizeof (x) == sizeof (float) ? __finitef (x) : __finite (x))
+# else
+#  define isfinite(x) \
+     (sizeof (x) == sizeof (float)                                           \
+      ? __finitef (x)                                                        \
+      : sizeof (x) == sizeof (double)                                        \
+      ? __finite (x) : __finitel (x))
+# endif
 
 /* Return nonzero value if X is neither zero, subnormal, Inf, nor NaN.  */
 # define isnormal(x) (fpclassify (x) == FP_NORMAL)
 
 /* Return nonzero value if X is a NaN.  We could use `fpclassify' but
    we already have this functions `__isnan' and it is faster.  */
-# define isnan(x) \
-     (sizeof (x) == sizeof (float) ?                                         \
-        __isnanf (x)                                                         \
-      : sizeof (x) == sizeof (double) ?                                              \
-        __isnan (x) : __isnanl (x))
-
-
-/* Conversion functions.  */
+# ifdef __NO_LONG_DOUBLE_MATH
+#  define isnan(x) \
+     (sizeof (x) == sizeof (float) ? __isnanf (x) : __isnan (x))
+# else
+#  define isnan(x) \
+     (sizeof (x) == sizeof (float)                                           \
+      ? __isnanf (x)                                                         \
+      : sizeof (x) == sizeof (double)                                        \
+      ? __isnan (x) : __isnanl (x))
+# endif
 
-/* Round X to nearest integral value according to current rounding
-   direction.  */
-extern long int lrint __P ((long double __x));
-extern long long int llrint __P ((long double __x));
+/* Return nonzero value is X is positive or negative infinity.  */
+# ifdef __NO_LONG_DOUBLE_MATH
+#  define isinf(x) \
+     (sizeof (x) == sizeof (float) ? __isinff (x) : __isinf (x))
+# else
+#  define isinf(x) \
+     (sizeof (x) == sizeof (float)                                           \
+      ? __isinff (x)                                                         \
+      : sizeof (x) == sizeof (double)                                        \
+      ? __isinf (x) : __isinfl (x))
+# endif
 
-/* Round X to nearest integral value, rounding halfway cases away from
-   zero.  */
-extern long int lround __P ((long double __x));
-extern long long int llround __P ((long double __x));
+/* Bitmasks for the math_errhandling macro.  */
+# define MATH_ERRNO    1       /* errno set by math functions.  */
+# define MATH_ERREXCEPT        2       /* Exceptions raised by math functions.  */
 
-#endif /* Use ISO C 9X.  */
+#endif /* Use ISO C99.  */
 
 #ifdef __USE_MISC
 /* Support for various different standard error handling behaviors.  */
-
-typedef enum { _IEEE_ = -1, _SVID_, _XOPEN_, _POSIX_ } _LIB_VERSION_TYPE;
+typedef enum
+{
+  _IEEE_ = -1, /* According to IEEE 754/IEEE 854.  */
+  _SVID_,      /* According to System V, release 4.  */
+  _XOPEN_,     /* Nowadays also Unix98.  */
+  _POSIX_,
+  _ISOC_       /* Actually this is ISO C99.  */
+} _LIB_VERSION_TYPE;
 
 /* This variable can be changed at run-time to any of the values above to
    affect floating point error handling behavior (it may also be necessary
@@ -212,8 +257,8 @@ extern _LIB_VERSION_TYPE _LIB_VERSION;
 /* In SVID error handling, `matherr' is called with this description
    of the exceptional condition.
 
-   We have a problem when using C++ since `exception' is reserved in
-   C++.  */
+   We have a problem when using C++ since `exception' is a reserved
+   name in C++.  */
 # ifdef __cplusplus
 struct __exception
 # else
@@ -228,11 +273,9 @@ struct exception
   };
 
 # ifdef __cplusplus
-extern int __matherr __P ((struct __exception *__exc));
-extern int matherr __P ((struct __exception *__exc));
+extern int matherr (struct __exception *__exc) throw ();
 # else
-extern int __matherr __P ((struct exception *__exc));
-extern int matherr __P ((struct exception *__exc));
+extern int matherr (struct exception *__exc);
 # endif
 
 # define X_TLOSS       1.41484755040568800000e+16
@@ -246,100 +289,121 @@ extern int matherr __P ((struct exception *__exc));
 # define PLOSS         6
 
 /* SVID mode specifies returning this large value instead of infinity.  */
-# define HUGE          FLT_MAX
-# include <float.h>            /* Defines FLT_MAX.  */
+# define HUGE          3.40282347e+38F
 
 #else  /* !SVID */
 
 # ifdef __USE_XOPEN
 /* X/Open wants another strange constant.  */
-#  define MAXFLOAT     FLT_MAX
-#  include <float.h>
+#  define MAXFLOAT     3.40282347e+38F
 # endif
 
 #endif /* SVID */
 
 
-#ifdef __USE_BSD
-
 /* Some useful constants.  */
-# define M_E           _Mldbl(2.7182818284590452354)   /* e */
-# define M_LOG2E       _Mldbl(1.4426950408889634074)   /* log 2e */
-# define M_LOG10E      _Mldbl(0.43429448190325182765)  /* log 10e */
-# define M_LN2         _Mldbl(0.69314718055994530942)  /* log e2 */
-# define M_LN10                _Mldbl(2.30258509299404568402)  /* log e10 */
-# define M_PI          _Mldbl(3.14159265358979323846)  /* pi */
-# define M_PI_2                _Mldbl(1.57079632679489661923)  /* pi/2 */
-# define M_PI_4                _Mldbl(0.78539816339744830962)  /* pi/4 */
-# define M_1_PI                _Mldbl(0.31830988618379067154)  /* 1/pi */
-# define M_2_PI                _Mldbl(0.63661977236758134308)  /* 2/pi */
-# define M_2_SQRTPI    _Mldbl(1.12837916709551257390)  /* 2/sqrt(pi) */
-# define M_SQRT2       _Mldbl(1.41421356237309504880)  /* sqrt(2) */
-# define M_SQRT1_2     _Mldbl(0.70710678118654752440)  /* 1/sqrt(2) */
-
+#if defined __USE_BSD || defined __USE_XOPEN
+# define M_E           2.7182818284590452354   /* e */
+# define M_LOG2E       1.4426950408889634074   /* log_2 e */
+# define M_LOG10E      0.43429448190325182765  /* log_10 e */
+# define M_LN2         0.69314718055994530942  /* log_e 2 */
+# define M_LN10                2.30258509299404568402  /* log_e 10 */
+# define M_PI          3.14159265358979323846  /* pi */
+# define M_PI_2                1.57079632679489661923  /* pi/2 */
+# define M_PI_4                0.78539816339744830962  /* pi/4 */
+# define M_1_PI                0.31830988618379067154  /* 1/pi */
+# define M_2_PI                0.63661977236758134308  /* 2/pi */
+# define M_2_SQRTPI    1.12837916709551257390  /* 2/sqrt(pi) */
+# define M_SQRT2       1.41421356237309504880  /* sqrt(2) */
+# define M_SQRT1_2     0.70710678118654752440  /* 1/sqrt(2) */
 #endif
 
-/* Our constants might specify more precision than `double' can represent.
-   Use `long double' constants in standard and GNU C, where they are
-   supported and the cast to `double'.
-
-   If the constants are use in code which does not use prototypes, one
-   might get problems if a function takes a `double' argument and any
-   of the constants are provided as the argument.  In this case, cast
-   the argument to `double'.
+/* The above constants are not adequate for computation using `long double's.
+   Therefore we provide as an extension constants with similar names as a
+   GNU extension.  Provide enough digits for the 128-bit IEEE quad.  */
+#ifdef __USE_GNU
+# define M_El          2.7182818284590452353602874713526625L  /* e */
+# define M_LOG2El      1.4426950408889634073599246810018922L  /* log_2 e */
+# define M_LOG10El     0.4342944819032518276511289189166051L  /* log_10 e */
+# define M_LN2l                0.6931471805599453094172321214581766L  /* log_e 2 */
+# define M_LN10l       2.3025850929940456840179914546843642L  /* log_e 10 */
+# define M_PIl         3.1415926535897932384626433832795029L  /* pi */
+# define M_PI_2l       1.5707963267948966192313216916397514L  /* pi/2 */
+# define M_PI_4l       0.7853981633974483096156608458198757L  /* pi/4 */
+# define M_1_PIl       0.3183098861837906715377675267450287L  /* 1/pi */
+# define M_2_PIl       0.6366197723675813430755350534900574L  /* 2/pi */
+# define M_2_SQRTPIl   1.1283791670955125738961589031215452L  /* 2/sqrt(pi) */
+# define M_SQRT2l      1.4142135623730950488016887242096981L  /* sqrt(2) */
+# define M_SQRT1_2l    0.7071067811865475244008443621048490L  /* 1/sqrt(2) */
+#endif
 
-   Please note we define the macro even if the constants are not defined.
-   This helps us to use the macros in other places.  */
-#if __STDC__ - 0 || __GNUC__ - 0
-# define _Mldbl(x) x##L
-#else  /* Traditional C.  */
-# define _Mldbl(x) x
-#endif /* Standard or GNU C.  */
 
+/* When compiling in strict ISO C compatible mode we must not use the
+   inline functions since they, among other things, do not set the
+   `errno' variable correctly.  */
+#if defined __STRICT_ANSI__ && !defined __NO_MATH_INLINES
+# define __NO_MATH_INLINES     1
+#endif
 
 /* Get machine-dependent inline versions (if there are any).  */
-#ifdef __OPTIMIZE__
+#ifdef __USE_EXTERN_INLINES
 # include <bits/mathinline.h>
 #endif
 
 
-#if __USE_ISOC9X
-/* ISO C 9X defines some macros to compare number while taking care
+#if __USE_ISOC99
+/* ISO C99 defines some macros to compare number while taking care
    for unordered numbers.  Since many FPUs provide special
    instructions to support these operations and these tests are
    defined in <bits/mathinline.h>, we define the generic macros at
-   this late point.  */
+   this late point and only if they are not defined yet.  */
 
 /* Return nonzero value if X is greater than Y.  */
 # ifndef isgreater
-#  define isgreater(x, y) (!isunordered ((x), (y)) && (x) > (y))
+#  define isgreater(x, y) \
+  (__extension__                                                             \
+   ({ __typeof__(x) __x = (x); __typeof__(y) __y = (y);                              \
+      !isunordered (__x, __y) && __x > __y; }))
 # endif
 
 /* Return nonzero value if X is greater than or equal to Y.  */
 # ifndef isgreaterequal
-#  define isgreaterequal(x, y) (!isunordered ((x), (y)) && (x) >= (y))
+#  define isgreaterequal(x, y) \
+  (__extension__                                                             \
+   ({ __typeof__(x) __x = (x); __typeof__(y) __y = (y);                              \
+      !isunordered (__x, __y) && __x >= __y; }))
 # endif
 
 /* Return nonzero value if X is less than Y.  */
 # ifndef isless
-#  define isless(x, y) (!isunordered ((x), (y)) && (x) < (y))
+#  define isless(x, y) \
+  (__extension__                                                             \
+   ({ __typeof__(x) __x = (x); __typeof__(y) __y = (y);                              \
+      !isunordered (__x, __y) && __x < __y; }))
 # endif
 
 /* Return nonzero value if X is less than or equal to Y.  */
 # ifndef islessequal
-#  define islessequal(x, y) (!isunordered ((x), (y)) && (x) <= (y))
+#  define islessequal(x, y) \
+  (__extension__                                                             \
+   ({ __typeof__(x) __x = (x); __typeof__(y) __y = (y);                              \
+      !isunordered (__x, __y) && __x <= __y; }))
 # endif
 
 /* Return nonzero value if either X is less than Y or Y is less than X.  */
 # ifndef islessgreater
 #  define islessgreater(x, y) \
-     (!isunordered ((x), (y)) && ((x) < (y) || (y) < (x)))
+  (__extension__                                                             \
+   ({ __typeof__(x) __x = (x); __typeof__(y) __y = (y);                              \
+      !isunordered (__x, __y) && (__x < __y || __y < __x); }))
 # endif
 
 /* Return nonzero value if arguments are unordered.  */
 # ifndef isunordered
-#  define isunordered(x, y) \
-     (fpclassify (x) == FP_NAN || fpclassify (y) == FP_NAN)
+#  define isunordered(u, v) \
+  (__extension__                                                             \
+   ({ __typeof__(u) __u = (u); __typeof__(v) __v = (v);                              \
+      fpclassify (__u) == FP_NAN || fpclassify (__v) == FP_NAN; }))
 # endif
 
 #endif