Undefine __MATHDECL_1, __MATHDECL, and __MATHCALL after use.
[kopensolaris-gnu/glibc.git] / math / math.h
index 9a782b0..22274f0 100644 (file)
@@ -1,23 +1,24 @@
-/* Copyright (C) 1991, 1992, 1993 Free Software Foundation, Inc.
-This file is part of the GNU C Library.
+/* Declarations for math functions.
+   Copyright (C) 1991, 92, 93, 95, 96, 97 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
-modify it under the terms of the GNU Library General Public License as
-published by the Free Software Foundation; either version 2 of the
-License, or (at your option) any later version.
+   The GNU C Library is free software; you can redistribute it and/or
+   modify it under the terms of the GNU Library General Public License as
+   published by the Free Software Foundation; either version 2 of the
+   License, or (at your option) any later version.
 
-The GNU C Library 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
-Library General Public License for more details.
+   The GNU C Library 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
+   Library General Public License for more details.
 
-You should have received a copy of the GNU Library General Public
-License along with the GNU C Library; see the file COPYING.LIB.  If
-not, write to the, 1992 Free Software Foundation, Inc., 675 Mass Ave,
-Cambridge, MA 02139, USA.  */
+   You should have received a copy of the GNU Library General Public
+   License along with the GNU C Library; see the file COPYING.LIB.  If not,
+   write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+   Boston, MA 02111-1307, USA.  */
 
 /*
- *     ANSI Standard: 4.5 MATHEMATICS  <math.h>
+ *     ISO C Standard: 4.5 MATHEMATICS <math.h>
  */
 
 #ifndef        _MATH_H
@@ -27,10 +28,8 @@ Cambridge, MA 02139, USA.  */
 
 __BEGIN_DECLS
 
-#define        __need_Emath
-#include <errno.h>
-
-/* Get machine-dependent HUGE_VAL value (returned on overflow).  */
+/* Get machine-dependent HUGE_VAL value (returned on overflow).
+   On all IEEE754 machines, this is +Infinity.  */
 #include <huge_val.h>
 
 /* Get machine-dependent NAN value (returned for some domain errors).  */
@@ -39,246 +38,260 @@ __BEGIN_DECLS
 #endif
 
 
-#ifndef        __CONSTVALUE
-#ifdef __GNUC__
-/* The `const' keyword tells GCC that a function's return value is
-   based solely on its arguments, and there are no side-effects.  */
-#define        __CONSTVALUE    __const
-#else
-#define        __CONSTVALUE
-#endif /* GCC.  */
-#endif /* __CONSTVALUE not defined.  */
+/* The file <mathcalls.h> contains the prototypes for all the actual
+   math functions.  These macros are used for those prototypes, so
+   we can easily declare each function as both `name' and `__name',
+   and can declare the float versions `namef' and `__namef'.  */
 
+#define __MATHCALL(function,suffix, args)      \
+  __MATHDECL (_Mdouble_,function,suffix, args)
+#define __MATHDECL(type, function,suffix, args) \
+  __MATHDECL_1(type, function,suffix, args); \
+  __MATHDECL_1(type, __CONCAT(__,function),suffix, args)
+#define __MATHDECL_1(type, function,suffix, args) \
+  extern type __MATH_PRECNAME(function,suffix) args
 
-/* Trigonometric functions.  */
+#define _Mdouble_              double
+#define __MATH_PRECNAME(name,r)        __CONCAT(name,r)
+#include <mathcalls.h>
+#undef _Mdouble_
+#undef __MATH_PRECNAME
 
-/* Arc cosine of X.  */
-extern __CONSTVALUE double acos __P ((double __x));
-/* Arc sine of X.  */
-extern __CONSTVALUE double asin __P ((double __x));
-/* Arc tangent of X.  */
-extern __CONSTVALUE double atan __P ((double __x));
-/* Arc tangent of Y/X.  */
-extern __CONSTVALUE double atan2 __P ((double __y, double __x));
+#if defined __USE_MISC || defined __USE_ISOC9X
 
-/* Cosine of X.  */
-extern __CONSTVALUE double cos __P ((double __x));
-/* Sine of X.  */
-extern __CONSTVALUE double sin __P ((double __x));
-/* Tangent of X.  */
-extern __CONSTVALUE double tan __P ((double __x));
 
+/* Include the file of declarations again, this time using `float'
+   instead of `double' and appending f to each function name.  */
 
-/* Hyperbolic functions.  */
+#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 <mathcalls.h>
+#undef _Mdouble_
+#undef __MATH_PRECNAME
 
-/* Hyperbolic cosine of X.  */
-extern __CONSTVALUE double cosh __P ((double __x));
-/* Hyperbolic sine of X.  */
-extern __CONSTVALUE double sinh __P ((double __x));
-/* Hyperbolic tangent of X.  */
-extern __CONSTVALUE double tanh __P ((double __x));
+#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.  */
 
-#ifdef __USE_MISC
-/* Hyperbolic arc cosine of X.  */
-extern __CONSTVALUE double acosh __P ((double __x));
-/* Hyperbolic arc sine of X.  */
-extern __CONSTVALUE double asinh __P ((double __x));
-/* Hyperbolic arc tangent of X.  */
-extern __CONSTVALUE double atanh __P ((double __x));
+#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 <mathcalls.h>
+#undef _Mdouble_
+#undef __MATH_PRECNAME
 
-/* Exponential and logarithmic functions.  */
+#endif /* __STDC__ || __GNUC__ */
 
-/* Exponentional function of X.  */
-extern __CONSTVALUE double exp __P ((double __x));
+#endif /* Use misc or ISO C 9X.  */
+#undef __MATHDECL_1
+#undef __MATHDECL
+#undef __MATHCALL
 
-/* Break VALUE into a normalized fraction and an integral power of 2.  */
-extern double frexp __P ((double __value, int *__exp));
 
-/* X times (two to the EXP power).  */
-extern __CONSTVALUE double ldexp __P ((double __x, int __exp));
+#if defined __USE_MISC || defined __USE_XOPEN || defined __USE_ISOC9X
+/* This variable is used by `gamma' and `lgamma'.  */
+extern int signgam;
+#endif
 
-/* Natural logarithm of X.  */
-extern __CONSTVALUE double log __P ((double __x));
 
-/* Base-ten logarithm of X.  */
-extern __CONSTVALUE double log10 __P ((double __x));
+/* ISO C 9X defines some generic macros which work on any data type.  */
+#if __USE_ISOC9X
 
-#ifdef __USE_MISC
-/* Return exp(X) - 1.  */
-extern __CONSTVALUE double __expm1 __P ((double __x));
-extern __CONSTVALUE double expm1 __P ((double __x));
+/* All floating-point numbers can be put in one of these categories.  */
+enum
+  {
+    FP_NAN,
+#define FP_NAN FP_NAN
+    FP_INFINITE,
+#define FP_INFINITE FP_INFINITE
+    FP_ZERO,
+#define FP_ZERO FP_ZERO
+    FP_SUBNORMAL,
+#define FP_SUBNORMAL FP_SUBNORMAL
+    FP_NORMAL
+#define FP_NORMAL FP_NORMAL
+  };
 
-/* Return log(1 + X).  */
-extern __CONSTVALUE double log1p __P ((double __x));
-#endif
+/* Return number of classification appropriate for X.  */
+#define fpclassify(x) \
+     (sizeof (x) == sizeof (float) ?                                         \
+        __finitef (x)                                                        \
+      : sizeof (x) == sizeof (double) ?                                              \
+        __finite (x) : __finitel (x))
 
-/* Break VALUE into integral and fractional parts.  */
-extern double modf __P ((double __value, double *__iptr));
+/* 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))
 
+/* Return nonzero value if X is not +-Inf or NaN.  */
+#define isfinite(x) (fpclassify (x) >= FP_ZERO)
 
-/* Power functions.  */
+/* Return nonzero value if X is neither zero, subnormal, Inf, nor NaN.  */
+#define isnormal(x) (fpclassify (x) == FP_NORMAL)
 
-/* Return X to the Y power.  */
-extern __CONSTVALUE double pow __P ((double __x, double __y));
+/* 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))
 
-/* Return the square root of X.  */
-extern __CONSTVALUE double sqrt __P ((double __x));
 
-#ifdef __USE_MISC
-/* Return the cube root of X.  */
-extern __CONSTVALUE double cbrt __P ((double __x));
-#endif
+/* Conversion functions.  */
 
+/* Round X to nearest integral value according to current rounding
+   direction.  */
+extern long int rinttol __P ((double __x));
+extern long long int rinttoll __P ((double __x));
 
-/* Nearest integer, absolute value, and remainder functions.  */
+/* Round X to nearest integral value, rounding halfway cases away from
+   zero.  */
+extern long int roundtol __P ((double __x));
+extern long long int roundtoll __P ((double __x));
 
-/* Smallest integral value not less than X.  */
-extern __CONSTVALUE double ceil __P ((double __x));
 
-/* Absolute value of X.  */
-extern __CONSTVALUE double fabs __P ((double __x));
+/* Comparison macros.  */
 
-/* Largest integer not greater than X.  */
-extern __CONSTVALUE double floor __P ((double __x));
+/* Return nonzero value if X is greater than Y.  */
+#define isgreater(x, y) (!isunordered ((x), (y)) && (x) > (y))
 
-/* Floating-point modulo remainder of X/Y.  */
-extern __CONSTVALUE double fmod __P ((double __x, double __y));
+/* Return nonzero value if X is greater than or equal to Y.  */
+#define isgreaterequal(x, y) (!isunordered ((x), (y)) && (x) >= (y))
 
+/* Return nonzero value if X is less than Y.  */
+#define isless(x, y) (!isunordered ((x), (y)) && (x) < (y))
 
-/* Return 0 if VALUE is finite or NaN, +1 if it
-   is +Infinity, -1 if it is -Infinity.  */
-extern __CONSTVALUE int __isinf __P ((double __value));
+/* Return nonzero value if X is less than or equal to Y.  */
+#define islessequal(x, y) (!isunordered ((x), (y)) && (x) <= (y))
 
-/* Return nonzero if VALUE is not a number.  */
-extern __CONSTVALUE int __isnan __P ((double __value));
+/* Return nonzero value if either X is less than Y or Y is less than X.  */
+#define islessgreater(x, y) \
+     (!isunordered ((x), (y)) && ((x) < (y) || (y) < (x)))
 
-/* Return nonzero if VALUE is finite and not NaN.  */
-extern __CONSTVALUE int __finite __P ((double __value));
-#ifdef __OPTIMIZE__
-#define        __finite(value) (!__isinf(value))
-#endif
+/* Return nonzero value if arguments are unordered.  */
+#define isunordered(x, y) \
+     (fpclassify (x) == FP_NAN || fpclassify (y) == FP_NAN)
 
-/* Deal with an infinite or NaN result.
-   If ERROR is ERANGE, result is +Inf;
-   if ERROR is - ERANGE, result is -Inf;
-   otherwise result is NaN.
-   This will set `errno' to either ERANGE or EDOM,
-   and may return an infinity or NaN, or may do something else.  */
-extern double __infnan __P ((int __error));
+#endif /* Use ISO C 9X.  */
 
-/* Return X with its signed changed to Y's.  */
-extern __CONSTVALUE double __copysign __P ((double __x, double __y));
+#ifdef __USE_MISC
+/* Support for various different standard error handling behaviors.  */
 
-/* Return X times (2 to the Nth power).  */
-extern __CONSTVALUE double __scalb __P ((double __x, int __n));
+typedef enum { _IEEE_ = -1, _SVID_, _XOPEN_, _POSIX_ } _LIB_VERSION_TYPE;
 
-#ifdef __OPTIMIZE__
-#define        __scalb(x, n)   ldexp ((x), (n))
+/* 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
+   to change the hardware FPU exception settings).  */
+extern _LIB_VERSION_TYPE _LIB_VERSION;
 #endif
 
-/* Return the remainder of X/Y.  */
-extern __CONSTVALUE double __drem __P ((double __x, double __y));
 
-/* Return the base 2 signed integral exponent of X.  */
-extern __CONSTVALUE double __logb __P ((double __x));
+#ifdef __USE_SVID
+/* In SVID error handling, `matherr' is called with this description
+   of the exceptional condition.
 
-#ifdef __USE_MISC
+   We have a problem when using C++ since `exception' is reserved in
+   C++.  */
+#ifdef __cplusplus
+struct __exception
+#else
+struct exception
+#endif
+  {
+    int type;
+    char *name;
+    double arg1;
+    double arg2;
+    double retval;
+  };
+
+#ifdef __cplusplus
+extern int __matherr __P ((struct __exception *));
+extern int matherr __P ((struct __exception *));
+#else
+extern int __matherr __P ((struct exception *));
+extern int matherr __P ((struct exception *));
+#endif
+
+#define X_TLOSS                1.41484755040568800000e+16
+
+/* Types of exceptions in the `type' field.  */
+#define        DOMAIN          1
+#define        SING            2
+#define        OVERFLOW        3
+#define        UNDERFLOW       4
+#define        TLOSS           5
+#define        PLOSS           6
+
+/* SVID mode specifies returning this large value instead of infinity.  */
+#define HUGE           FLT_MAX
+#include <float.h>             /* Defines FLT_MAX.  */
+
+#else  /* !SVID */
+
+#ifdef __USE_XOPEN
+/* X/Open wants another strange constant.  */
+#define MAXFLOAT       FLT_MAX
+#include <float.h>
+#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) */
+
+/* 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 __STDC__ - 0 || __GNUC__ - 0
+#define _Mldbl(x) x##L
+#else  /* Traditional C.  */
+#define _Mldbl(x) x
+#endif /* Standard or GNU C.  */
+
+#endif
 
-/* Return the integer nearest X in the direction of the
-   prevailing rounding mode.  */
-extern __CONSTVALUE double __rint __P ((double __x));
-extern __CONSTVALUE double rint __P ((double __x));
-
-/* Return `sqrt(X*X + Y*Y)'.  */
-extern __CONSTVALUE double hypot __P ((double __x, double __y));
-
-struct __cabs_complex
-{
-  double __x, __y;
-};
-
-/* Return `sqrt(X*X + Y*Y)'.  */
-extern __CONSTVALUE double cabs __P ((struct __cabs_complex));
-
-extern __CONSTVALUE int isinf __P ((double __value));
-extern __CONSTVALUE int isnan __P ((double __value));
-extern __CONSTVALUE int finite __P ((double __value));
-extern __CONSTVALUE double infnan __P ((int __error));
-extern __CONSTVALUE double copysign __P ((double __x, double __y));
-extern __CONSTVALUE double scalb __P ((double __x, int __n));
-extern __CONSTVALUE double drem __P ((double __x, double __y));
-extern __CONSTVALUE double logb __P ((double __x));
-
-#ifdef __OPTIMIZE__
-#define        isinf(value)    __isinf(value)
-#define        isnan(value)    __isnan(value)
-#define        infnan(error)   __infnan(error)
-#define        finite(value)   __finite(value)
-#define        copysign(x, y)  __copysign((x), (y))
-#define        scalb(x, n)     __scalb((x), (n))
-#define        drem(x, y)      __drem((x), (y))
-#define        logb(x)         __logb(x)
-#endif /* Optimizing.  */
-
-#endif /* Use misc.  */
-
-
-#if 0
-/* The "Future Library Directions" section of the
-   ANSI Standard reserves these as `float' and
-   `long double' versions of the above functions.  */
-
-extern __CONSTVALUE float acosf __P ((float __x));
-extern __CONSTVALUE float asinf __P ((float __x));
-extern __CONSTVALUE float atanf __P ((float __x));
-extern __CONSTVALUE float atan2f __P ((float __y, float __x));
-extern __CONSTVALUE float cosf __P ((float __x));
-extern __CONSTVALUE float sinf __P ((float __x));
-extern __CONSTVALUE float tanf __P ((float __x));
-extern __CONSTVALUE float coshf __P ((float __x));
-extern __CONSTVALUE float sinhf __P ((float __x));
-extern __CONSTVALUE float tanhf __P ((float __x));
-extern __CONSTVALUE float expf __P ((float __x));
-extern float frexpf __P ((float __value, int *__exp));
-extern __CONSTVALUE float ldexpf __P ((float __x, int __exp));
-extern __CONSTVALUE float logf __P ((float __x));
-extern __CONSTVALUE float log10f __P ((float __x));
-extern float modff __P ((float __value, float *__iptr));
-extern __CONSTVALUE float powf __P ((float __x, float __y));
-extern __CONSTVALUE float sqrtf __P ((float __x));
-extern __CONSTVALUE float ceilf __P ((float __x));
-extern __CONSTVALUE float fabsf __P ((float __x));
-extern __CONSTVALUE float floorf __P ((float __x));
-extern __CONSTVALUE float fmodf __P ((float __x, float __y));
-
-extern __CONSTVALUE __long_double_t acosl __P ((__long_double_t __x));
-extern __CONSTVALUE __long_double_t asinl __P ((__long_double_t __x));
-extern __CONSTVALUE __long_double_t atanl __P ((__long_double_t __x));
-extern __CONSTVALUE __long_double_t atan2l __P ((__long_double_t __y, __long_double_t __x));
-extern __CONSTVALUE __long_double_t cosl __P ((__long_double_t __x));
-extern __CONSTVALUE __long_double_t sinl __P ((__long_double_t __x));
-extern __CONSTVALUE __long_double_t tanl __P ((__long_double_t __x));
-extern __CONSTVALUE __long_double_t coshl __P ((__long_double_t __x));
-extern __CONSTVALUE __long_double_t sinhl __P ((__long_double_t __x));
-extern __CONSTVALUE __long_double_t tanhl __P ((__long_double_t __x));
-extern __CONSTVALUE __long_double_t expl __P ((__long_double_t __x));
-extern __long_double_t frexpl __P ((__long_double_t __value, int *__exp));
-extern __CONSTVALUE __long_double_t ldexpl __P ((__long_double_t __x, int __exp));
-extern __CONSTVALUE __long_double_t logl __P ((__long_double_t __x));
-extern __CONSTVALUE __long_double_t log10l __P ((__long_double_t __x));
-extern __long_double_t modfl __P ((__long_double_t __value, __long_double_t * __ip));
-extern __CONSTVALUE __long_double_t powl __P ((__long_double_t __x, __long_double_t __y));
-extern __CONSTVALUE __long_double_t sqrtl __P ((__long_double_t __x));
-extern __CONSTVALUE __long_double_t ceill __P ((__long_double_t __x));
-extern __CONSTVALUE __long_double_t fabsl __P ((__long_double_t __x));
-extern __CONSTVALUE __long_double_t floorl __P ((__long_double_t __x));
-extern __CONSTVALUE __long_double_t fmodl __P ((__long_double_t __x, __long_double_t __y));
-#endif /* 0 */
 
 /* Get machine-dependent inline versions (if there are any).  */
+#if (!defined __NO_MATH_INLINES && defined __OPTIMIZE__) \
+    || defined __LIBC_M81_MATH_INLINES
 #include <__math.h>
+#endif
+
 
 __END_DECLS
 
+
 #endif /* math.h  */