Sat Apr 20 17:07:17 1996 Ulrich Drepper <drepper@cygnus.com>
[kopensolaris-gnu/glibc.git] / math / math.h
index ec90746..7bec130 100644 (file)
@@ -1,4 +1,5 @@
-/* Copyright (C) 1991 Free Software Foundation, Inc.
+/* Declarations for math functions.
+Copyright (C) 1991, 92, 93, 95, 96 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
@@ -25,249 +26,120 @@ Cambridge, MA 02139, USA.  */
 #define        _MATH_H 1
 #include <features.h>
 
+__BEGIN_DECLS
 
 #define        __need_Emath
 #include <errno.h>
 
-/* Get HUGE_VAL (returned on overflow) from <float.h>.  */
-#define        __need_HUGE_VAL
-#include <float.h>
+/* Get machine-dependent HUGE_VAL value (returned on overflow).
+   On all IEEE754 machines, this is +Infinity.  */
+#include <huge_val.h>
 
-
-#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.  */
-
-
-/* Trigonometric functions.  */
-
-/* Arc cosine of X.  */
-extern __CONSTVALUE double EXFUN(acos, (double __x));
-/* Arc sine of X.  */
-extern __CONSTVALUE double EXFUN(asin, (double __x));
-/* Arc tangent of X.  */
-extern __CONSTVALUE double EXFUN(atan, (double __x));
-/* Arc tangent of Y/X.  */
-extern __CONSTVALUE double EXFUN(atan2, (double __y, double __x));
-
-/* Cosine of X.  */
-extern __CONSTVALUE double EXFUN(cos, (double __x));
-/* Sine of X.  */
-extern __CONSTVALUE double EXFUN(sin, (double __x));
-/* Tangent of X.  */
-extern __CONSTVALUE double EXFUN(tan, (double __x));
-
-
-/* Hyperbolic functions.  */
-
-/* Hyperbolic cosine of X.  */
-extern __CONSTVALUE double EXFUN(cosh, (double __x));
-/* Hyperbolic sine of X.  */
-extern __CONSTVALUE double EXFUN(sinh, (double __x));
-/* Hyperbolic tangent of X.  */
-extern __CONSTVALUE double EXFUN(tanh, (double __x));
-
-#ifdef __USE_MISC
-/* Hyperbolic arc cosine of X.  */
-extern __CONSTVALUE double EXFUN(acosh, (double __x));
-/* Hyperbolic arc sine of X.  */
-extern __CONSTVALUE double EXFUN(asinh, (double __x));
-/* Hyperbolic arc tangent of X.  */
-extern __CONSTVALUE double EXFUN(atanh, (double __x));
+/* Get machine-dependent NAN value (returned for some domain errors).  */
+#ifdef  __USE_GNU
+#include <nan.h>
 #endif
 
-/* Exponential and logarithmic functions.  */
 
-/* Exponentional function of X.  */
-extern __CONSTVALUE double EXFUN(exp, (double __x));
-
-/* Break VALUE into a normalized fraction and an integral power of 2.  */
-extern double EXFUN(frexp, (double __value, int *__exp));
-
-/* X times (two to the EXP power).  */
-extern __CONSTVALUE double EXFUN(ldexp, (double __x, int __exp));
-
-/* Natural logarithm of X.  */
-extern __CONSTVALUE double EXFUN(log, (double __x));
-
-/* Base-ten logarithm of X.  */
-extern __CONSTVALUE double EXFUN(log10, (double __x));
-
-#ifdef __USE_MISC
-/* Return exp(X) - 1.  */
-extern __CONSTVALUE double EXFUN(expm1, (double __x));
-
-/* Return log(1 + X).  */
-extern __CONSTVALUE double EXFUN(log1p, (double __x));
+/* 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, __##function,suffix, args)
+#define __MATHDECL_1(type, function,suffix, args) \
+  extern type __MATH_PRECNAME(function,suffix) args
+
+#define _Mdouble_              double
+#define __MATH_PRECNAME(name,r)        name##r
+#include <mathcalls.h>
+#undef _Mdouble_
+#undef __MATH_PRECNAME
+
+#ifdef __USE_MISC
+/* Include the file of declarations again, this type using `float'
+   instead of `double' and appending f to each function name.  */
+
+#define _Mdouble_              float
+#define __MATH_PRECNAME(name,r)        name##f##r
+#include <mathcalls.h>
+#undef _Mdouble_
+#undef __MATH_PRECNAME
 #endif
 
-/* Break VALUE into integral and fractional parts.  */
-extern double EXFUN(modf, (double __value, double *__iptr));
-
-
-/* Power functions.  */
-
-/* Return X to the Y power.  */
-extern __CONSTVALUE double EXFUN(pow, (double __x, double __y));
-
-/* Return the square root of X.  */
-extern __CONSTVALUE double EXFUN(sqrt, (double __x));
 
 #ifdef __USE_MISC
-/* Return the cube root of X.  */
-extern __CONSTVALUE double EXFUN(cbrt, (double __x));
-#endif
+/* Support for various different standard error handling behaviors.  */
 
+typedef enum { _IEEE_ = -1, _SVID_, _XOPEN_, _POSIX_ } _LIB_VERSION_TYPE;
 
-/* Nearest integer, absolute value, and remainder functions.  */
-
-/* Smallest integral value not less than X.  */
-extern __CONSTVALUE double EXFUN(ceil, (double __x));
+/* 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
 
-/* Absolute value of X.  */
-extern __CONSTVALUE double EXFUN(fabs, (double __x));
 
-/* Largest integer not greater than X.  */
-extern __CONSTVALUE double EXFUN(floor, (double __x));
+#ifdef __USE_SVID
+/* In SVID error handling, `matherr' is called with this description
+   of the exceptional condition.  */
+struct exception
+  {
+    int type;
+    char *name;
+    double arg1;
+    double arg2;
+    double retval;
+  };
 
-/* Floating-point modulo remainder of X/Y.  */
-extern __CONSTVALUE double EXFUN(fmod, (double __x, double __y));
+extern int matherr __P ((struct exception *));
 
+#define X_TLOSS                1.41484755040568800000e+16
 
-/* Return 0 if VALUE is finite or NaN, +1 if it
-   is +Infinity, -1 if it is -Infinity.  */
-extern __CONSTVALUE int EXFUN(__isinf, (double __value));
+/* 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
 
-/* Return nonzero if VALUE is not a number.  */
-extern __CONSTVALUE int EXFUN(__isnan, (double __value));
+/* SVID mode specifies returning this large value instead of infinity.  */
+#define HUGE           FLT_MAX
+#include <float.h>             /* Defines FLT_MAX.  */
 
-/* Return nonzero if VALUE is finite (or NaN).  */
-extern __CONSTVALUE int EXFUN(__finite, (double __value));
-#ifdef __OPTIMIZE__
-#define        __finite(value) (!__isinf(value))
 #endif
 
-/* 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 EXFUN(__infnan, (int __error));
-
-/* Return X with its signed changed to Y's.  */
-extern __CONSTVALUE double EXFUN(__copysign, (double __x, double __y));
-
-/* Return X times (2 to the Nth power).  */
-extern __CONSTVALUE double EXFUN(__scalb, (double __x, int __n));
-
-/* Return the remainder of X/Y.  */
-extern __CONSTVALUE double EXFUN(__drem, (double __x, double __y));
 
-/* Return the base 2 signed integral exponent of X.  */
-extern __CONSTVALUE double EXFUN(__logb, (double __x));
+#ifdef __USE_BSD
+/* Some useful constants.  */
+#define        M_E             2.7182818284590452354   /* e */
+#define        M_LOG2E         1.4426950408889634074   /* log 2e */
+#define        M_LOG10E        0.43429448190325182765  /* log 10e */
+#define        M_LN2           0.69314718055994530942  /* log e2 */
+#define        M_LN10          2.30258509299404568402  /* log e10 */
+#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
 
-#ifdef __USE_MISC
 
-/* Return the integer nearest X in the direction of the
-   prevailing rounding mode.  */
-extern __CONSTVALUE double EXFUN(rint, (double __x));
+/* Get machine-dependent inline versions (if there are any).  */
+#if defined (__NO_MATH_INLINES) || defined (__OPTIMIZE__)
+#include <__math.h>
+#endif
 
-/* Return `sqrt(X*X + Y*Y)'.  */
-extern __CONSTVALUE double EXFUN(hypot, (double __x, double __y));
 
-struct __complex
-  {
-    double __x, __y;
-  };
-/* Return `sqrt(X*X + Y*Y)'.  */
-extern __CONSTVALUE double EXFUN(cabs, (struct __complex));
-
-extern __CONSTVALUE int EXFUN(isinf, (double __value));
-extern __CONSTVALUE int EXFUN(isnan, (double __value));
-extern __CONSTVALUE int EXFUN(finite, (double __value));
-extern __CONSTVALUE double EXFUN(infnan, (int __error));
-extern __CONSTVALUE double EXFUN(copysign, (double __x, double __y));
-extern __CONSTVALUE double EXFUN(scalb, (double __x, int __n));
-extern __CONSTVALUE double EXFUN(drem, (double __x, double __y));
-extern __CONSTVALUE double EXFUN(logb, (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 EXFUN(acosf, (float __x));
-extern __CONSTVALUE float EXFUN(asinf, (float __x));
-extern __CONSTVALUE float EXFUN(atanf, (float __x));
-extern __CONSTVALUE float EXFUN(atan2f, (float __y, float __x));
-extern __CONSTVALUE float EXFUN(cosf, (float __x));
-extern __CONSTVALUE float EXFUN(sinf, (float __x));
-extern __CONSTVALUE float EXFUN(tanf, (float __x));
-extern __CONSTVALUE float EXFUN(coshf, (float __x));
-extern __CONSTVALUE float EXFUN(sinhf, (float __x));
-extern __CONSTVALUE float EXFUN(tanhf, (float __x));
-extern __CONSTVALUE float EXFUN(expf, (float __x));
-extern float EXFUN(frexpf, (float __value, int *__exp));
-extern __CONSTVALUE float EXFUN(ldexpf, (float __x, int __exp));
-extern __CONSTVALUE float EXFUN(logf, (float __x));
-extern __CONSTVALUE float EXFUN(log10f, (float __x));
-extern float EXFUN(modff, (float __value, float *__iptr));
-extern __CONSTVALUE float EXFUN(powf, (float __x, float __y));
-extern __CONSTVALUE float EXFUN(sqrtf, (float __x));
-extern __CONSTVALUE float EXFUN(ceilf, (float __x));
-extern __CONSTVALUE float EXFUN(fabsf, (float __x));
-extern __CONSTVALUE float EXFUN(floorf, (float __x));
-extern __CONSTVALUE float EXFUN(fmodf, (float __x, float __y));
-
-extern __CONSTVALUE LONG_DOUBLE EXFUN(acosl, (LONG_DOUBLE __x));
-extern __CONSTVALUE LONG_DOUBLE EXFUN(asinl, (LONG_DOUBLE __x));
-extern __CONSTVALUE LONG_DOUBLE EXFUN(atanl, (LONG_DOUBLE __x));
-extern __CONSTVALUE LONG_DOUBLE EXFUN(atan2l,
-                                     (LONG_DOUBLE __y, LONG_DOUBLE __x));
-extern __CONSTVALUE LONG_DOUBLE EXFUN(cosl, (LONG_DOUBLE __x));
-extern __CONSTVALUE LONG_DOUBLE EXFUN(sinl, (LONG_DOUBLE __x));
-extern __CONSTVALUE LONG_DOUBLE EXFUN(tanl, (LONG_DOUBLE __x));
-extern __CONSTVALUE LONG_DOUBLE EXFUN(coshl, (LONG_DOUBLE __x));
-extern __CONSTVALUE LONG_DOUBLE EXFUN(sinhl, (LONG_DOUBLE __x));
-extern __CONSTVALUE LONG_DOUBLE EXFUN(tanhl, (LONG_DOUBLE __x));
-extern __CONSTVALUE LONG_DOUBLE EXFUN(expl, (LONG_DOUBLE __x));
-extern LONG_DOUBLE EXFUN(frexpl, (LONG_DOUBLE __value, int *__exp));
-extern __CONSTVALUE LONG_DOUBLE EXFUN(ldexpl, (LONG_DOUBLE __x, int __exp));
-extern __CONSTVALUE LONG_DOUBLE EXFUN(logl, (LONG_DOUBLE __x));
-extern __CONSTVALUE LONG_DOUBLE EXFUN(log10l, (LONG_DOUBLE __x));
-extern LONG_DOUBLE EXFUN(modfl, (LONG_DOUBLE __value, LONG_DOUBLE *__ip));
-extern __CONSTVALUE LONG_DOUBLE EXFUN(powl,
-                                     (LONG_DOUBLE __x, LONG_DOUBLE __y));
-extern __CONSTVALUE LONG_DOUBLE EXFUN(sqrtl, (LONG_DOUBLE __x));
-extern __CONSTVALUE LONG_DOUBLE EXFUN(ceill, (LONG_DOUBLE __x));
-extern __CONSTVALUE LONG_DOUBLE EXFUN(fabsl, (LONG_DOUBLE __x));
-extern __CONSTVALUE LONG_DOUBLE EXFUN(floorl, (LONG_DOUBLE __x));
-extern __CONSTVALUE LONG_DOUBLE EXFUN(fmodl,
-                                     (LONG_DOUBLE __x, LONG_DOUBLE __y));
-#endif /* 0 */
+__END_DECLS
 
-/* Get machine-dependent inline versions (if there are any).  */
-#include <__math.h>
 
-#endif /* math.h  */
+#endif /* math.h  */