Mon Sep 18 12:39:22 1995 Paul Eggert <eggert@twinsun.com>
[platform/upstream/glibc.git] / math / math.h
1 /* Copyright (C) 1991, 1992, 1993, 1995 Free Software Foundation, Inc.
2 This file is part of the GNU C Library.
3
4 The GNU C Library is free software; you can redistribute it and/or
5 modify it under the terms of the GNU Library General Public License as
6 published by the Free Software Foundation; either version 2 of the
7 License, or (at your option) any later version.
8
9 The GNU C Library is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12 Library General Public License for more details.
13
14 You should have received a copy of the GNU Library General Public
15 License along with the GNU C Library; see the file COPYING.LIB.  If
16 not, write to the, 1992 Free Software Foundation, Inc., 675 Mass Ave,
17 Cambridge, MA 02139, USA.  */
18
19 /*
20  *      ANSI Standard: 4.5 MATHEMATICS  <math.h>
21  */
22
23 #ifndef _MATH_H
24
25 #define _MATH_H 1
26 #include <features.h>
27
28 __BEGIN_DECLS
29
30 #define __need_Emath
31 #include <errno.h>
32
33 /* Get machine-dependent HUGE_VAL value (returned on overflow).  */
34 #include <huge_val.h>
35
36 /* Get machine-dependent NAN value (returned for some domain errors).  */
37 #ifdef   __USE_GNU
38 #include <nan.h>
39 #endif
40
41
42 /* Trigonometric functions.  */
43
44 /* Arc cosine of X.  */
45 extern double acos __P ((double __x)) __attribute__ ((__const__));
46 /* Arc sine of X.  */
47 extern double asin __P ((double __x)) __attribute__ ((__const__));
48 /* Arc tangent of X.  */
49 extern double atan __P ((double __x)) __attribute__ ((__const__));
50 /* Arc tangent of Y/X.  */
51 extern double atan2 __P ((double __y, double __x)) __attribute__ ((__const__));
52
53 /* Cosine of X.  */
54 extern double cos __P ((double __x)) __attribute__ ((__const__));
55 /* Sine of X.  */
56 extern double sin __P ((double __x)) __attribute__ ((__const__));
57 /* Tangent of X.  */
58 extern double tan __P ((double __x)) __attribute__ ((__const__));
59
60
61 /* Hyperbolic functions.  */
62
63 /* Hyperbolic cosine of X.  */
64 extern double cosh __P ((double __x)) __attribute__ ((__const__));
65 /* Hyperbolic sine of X.  */
66 extern double sinh __P ((double __x)) __attribute__ ((__const__));
67 /* Hyperbolic tangent of X.  */
68 extern double tanh __P ((double __x)) __attribute__ ((__const__));
69
70 #ifdef  __USE_MISC
71 /* Hyperbolic arc cosine of X.  */
72 extern double acosh __P ((double __x)) __attribute__ ((__const__));
73 /* Hyperbolic arc sine of X.  */
74 extern double asinh __P ((double __x)) __attribute__ ((__const__));
75 /* Hyperbolic arc tangent of X.  */
76 extern double atanh __P ((double __x)) __attribute__ ((__const__));
77 #endif
78
79 /* Exponential and logarithmic functions.  */
80
81 /* Exponentional function of X.  */
82 extern double exp __P ((double __x)) __attribute__ ((__const__));
83
84 /* Break VALUE into a normalized fraction and an integral power of 2.  */
85 extern double frexp __P ((double __value, int *__exp));
86
87 /* X times (two to the EXP power).  */
88 extern double ldexp __P ((double __x, int __exp)) __attribute__ ((__const__));
89
90 /* Natural logarithm of X.  */
91 extern double log __P ((double __x)) __attribute__ ((__const__));
92
93 /* Base-ten logarithm of X.  */
94 extern double log10 __P ((double __x)) __attribute__ ((__const__));
95
96 #ifdef  __USE_MISC
97 /* Return exp(X) - 1.  */
98 extern double __expm1 __P ((double __x)) __attribute__ ((__const__));
99 extern double expm1 __P ((double __x)) __attribute__ ((__const__));
100
101 /* Return log(1 + X).  */
102 extern double log1p __P ((double __x)) __attribute__ ((__const__));
103 #endif
104
105 /* Break VALUE into integral and fractional parts.  */
106 extern double modf __P ((double __value, double *__iptr));
107
108
109 /* Power functions.  */
110
111 /* Return X to the Y power.  */
112 extern double pow __P ((double __x, double __y)) __attribute__ ((__const__));
113
114 /* Return the square root of X.  */
115 extern double sqrt __P ((double __x)) __attribute__ ((__const__));
116
117 #ifdef  __USE_MISC
118 /* Return the cube root of X.  */
119 extern double cbrt __P ((double __x)) __attribute__ ((__const__));
120 #endif
121
122
123 /* Nearest integer, absolute value, and remainder functions.  */
124
125 /* Smallest integral value not less than X.  */
126 extern double ceil __P ((double __x)) __attribute__ ((__const__));
127
128 /* Absolute value of X.  */
129 extern double fabs __P ((double __x)) __attribute__ ((__const__));
130
131 /* Largest integer not greater than X.  */
132 extern double floor __P ((double __x)) __attribute__ ((__const__));
133
134 /* Floating-point modulo remainder of X/Y.  */
135 extern double fmod __P ((double __x, double __y)) __attribute__ ((__const__));
136
137
138 /* Return 0 if VALUE is finite or NaN, +1 if it
139    is +Infinity, -1 if it is -Infinity.  */
140 extern int __isinf __P ((double __value)) __attribute__ ((__const__));
141
142 /* Return nonzero if VALUE is not a number.  */
143 extern int __isnan __P ((double __value)) __attribute__ ((__const__));
144
145 /* Return nonzero if VALUE is finite and not NaN.  */
146 extern int __finite __P ((double __value)) __attribute__ ((__const__));
147 #ifdef  __OPTIMIZE__
148 #define __finite(value) (!__isinf(value))
149 #endif
150
151 /* Deal with an infinite or NaN result.
152    If ERROR is ERANGE, result is +Inf;
153    if ERROR is - ERANGE, result is -Inf;
154    otherwise result is NaN.
155    This will set `errno' to either ERANGE or EDOM,
156    and may return an infinity or NaN, or may do something else.  */
157 extern double __infnan __P ((int __error));
158
159 /* Return X with its signed changed to Y's.  */
160 extern double __copysign __P ((double __x, double __y))
161      __attribute__ ((__const__));
162
163 /* Return X times (2 to the Nth power).  */
164 extern double __scalb __P ((double __x, int __n))
165      __attribute__ ((__const__));
166
167 #ifdef  __OPTIMIZE__
168 #define __scalb(x, n)   ldexp ((x), (n))
169 #endif
170
171 /* Return the remainder of X/Y.  */
172 extern double __drem __P ((double __x, double __y))
173      __attribute__ ((__const__));
174
175 /* Return the base 2 signed integral exponent of X.  */
176 extern double __logb __P ((double __x)) __attribute__ ((__const__));
177
178 #ifdef  __USE_MISC
179
180 /* Return the integer nearest X in the direction of the
181    prevailing rounding mode.  */
182 extern double __rint __P ((double __x)) __attribute__ ((__const__));
183 extern double rint __P ((double __x)) __attribute__ ((__const__));
184
185 /* Return `sqrt(X*X + Y*Y)'.  */
186 extern double hypot __P ((double __x, double __y)) __attribute__ ((__const__));
187
188 struct __cabs_complex
189 {
190   double __x, __y;
191 };
192
193 /* Return `sqrt(X*X + Y*Y)'.  */
194 extern double cabs __P ((struct __cabs_complex)) __attribute__ ((__const__));
195
196 extern int isinf __P ((double __value)) __attribute__ ((__const__));
197 extern int isnan __P ((double __value)) __attribute__ ((__const__));
198 extern int finite __P ((double __value)) __attribute__ ((__const__));
199 extern double infnan __P ((int __error)) __attribute__ ((__const__));
200 extern double copysign __P ((double __x, double __y))
201      __attribute__ ((__const__));
202 extern double scalb __P ((double __x, int __n)) __attribute__ ((__const__));
203 extern double drem __P ((double __x, double __y)) __attribute__ ((__const__));
204 extern double logb __P ((double __x)) __attribute__ ((__const__));
205
206 #ifdef  __OPTIMIZE__
207 #define isinf(value)    __isinf(value)
208 #define isnan(value)    __isnan(value)
209 #define infnan(error)   __infnan(error)
210 #define finite(value)   __finite(value)
211 #define copysign(x, y)  __copysign((x), (y))
212 #define scalb(x, n)     __scalb((x), (n))
213 #define drem(x, y)      __drem((x), (y))
214 #define logb(x)         __logb(x)
215 #endif /* Optimizing.  */
216
217 #endif /* Use misc.  */
218
219
220 #if 0
221 /* The "Future Library Directions" section of the
222    ANSI Standard reserves these as `float' and
223    `long double' versions of the above functions.  */
224
225 extern float acosf __P ((float __x)) __attribute__ ((__const__));
226 extern float asinf __P ((float __x)) __attribute__ ((__const__));
227 extern float atanf __P ((float __x)) __attribute__ ((__const__));
228 extern float atan2f __P ((float __y, float __x)) __attribute__ ((__const__));
229 extern float cosf __P ((float __x)) __attribute__ ((__const__));
230 extern float sinf __P ((float __x)) __attribute__ ((__const__));
231 extern float tanf __P ((float __x)) __attribute__ ((__const__));
232 extern float coshf __P ((float __x)) __attribute__ ((__const__));
233 extern float sinhf __P ((float __x)) __attribute__ ((__const__));
234 extern float tanhf __P ((float __x)) __attribute__ ((__const__));
235 extern float expf __P ((float __x)) __attribute__ ((__const__));
236 extern float frexpf __P ((float __value, int *__exp));
237 extern float ldexpf __P ((float __x, int __exp)) __attribute__ ((__const__));
238 extern float logf __P ((float __x)) __attribute__ ((__const__));
239 extern float log10f __P ((float __x)) __attribute__ ((__const__));
240 extern float modff __P ((float __value, float *__iptr));
241 extern float powf __P ((float __x, float __y)) __attribute__ ((__const__));
242 extern float sqrtf __P ((float __x)) __attribute__ ((__const__));
243 extern float ceilf __P ((float __x)) __attribute__ ((__const__));
244 extern float fabsf __P ((float __x)) __attribute__ ((__const__));
245 extern float floorf __P ((float __x)) __attribute__ ((__const__));
246 extern float fmodf __P ((float __x, float __y)) __attribute__ ((__const__));
247
248 extern __long_double_t acosl __P ((__long_double_t __x))
249      __attribute__ ((__const__));
250 extern __long_double_t asinl __P ((__long_double_t __x))
251      __attribute__ ((__const__));
252 extern __long_double_t atanl __P ((__long_double_t __x))
253      __attribute__ ((__const__));
254 extern __long_double_t atan2l __P ((__long_double_t __y, __long_double_t __x))
255      __attribute__ ((__const__));
256 extern __long_double_t cosl __P ((__long_double_t __x))
257      __attribute__ ((__const__));
258 extern __long_double_t sinl __P ((__long_double_t __x))
259      __attribute__ ((__const__));
260 extern __long_double_t tanl __P ((__long_double_t __x))
261      __attribute__ ((__const__));
262 extern __long_double_t coshl __P ((__long_double_t __x))
263      __attribute__ ((__const__));
264 extern __long_double_t sinhl __P ((__long_double_t __x))
265      __attribute__ ((__const__));
266 extern __long_double_t tanhl __P ((__long_double_t __x))
267      __attribute__ ((__const__));
268 extern __long_double_t expl __P ((__long_double_t __x))
269      __attribute__ ((__const__));
270 extern __long_double_t frexpl __P ((__long_double_t __value, int *__exp));
271 extern __long_double_t ldexpl __P ((__long_double_t __x, int __exp))
272      __attribute__ ((__const__));
273 extern __long_double_t logl __P ((__long_double_t __x))
274      __attribute__ ((__const__));
275 extern __long_double_t log10l __P ((__long_double_t __x))
276      __attribute__ ((__const__));
277 extern __long_double_t modfl __P ((__long_double_t __value,
278                                    __long_double_t *__ip));
279 extern __long_double_t powl __P ((__long_double_t __x, __long_double_t __y))
280      __attribute__ ((__const__));
281 extern __long_double_t sqrtl __P ((__long_double_t __x))
282      __attribute__ ((__const__));
283 extern __long_double_t ceill __P ((__long_double_t __x))
284      __attribute__ ((__const__));
285 extern __long_double_t fabsl __P ((__long_double_t __x))
286      __attribute__ ((__const__));
287 extern __long_double_t floorl __P ((__long_double_t __x))
288      __attribute__ ((__const__));
289 extern __long_double_t fmodl __P ((__long_double_t __x, __long_double_t __y))
290      __attribute__ ((__const__));
291 #endif /* 0 */
292
293 /* Get machine-dependent inline versions (if there are any).  */
294 #include <__math.h>
295
296 __END_DECLS
297
298
299 #ifdef __USE_BSD
300 /* Some useful constants.  */
301 #define M_E             2.7182818284590452354   /* e */
302 #define M_LOG2E         1.4426950408889634074   /* log 2e */
303 #define M_LOG10E        0.43429448190325182765  /* log 10e */
304 #define M_LN2           0.69314718055994530942  /* log e2 */
305 #define M_LN10          2.30258509299404568402  /* log e10 */
306 #define M_PI            3.14159265358979323846  /* pi */
307 #define M_PI_2          1.57079632679489661923  /* pi/2 */
308 #define M_PI_4          0.78539816339744830962  /* pi/4 */
309 #define M_1_PI          0.31830988618379067154  /* 1/pi */
310 #define M_2_PI          0.63661977236758134308  /* 2/pi */
311 #define M_2_SQRTPI      1.12837916709551257390  /* 2/sqrt(pi) */
312 #define M_SQRT2         1.41421356237309504880  /* sqrt(2) */
313 #define M_SQRT1_2       0.70710678118654752440  /* 1/sqrt(2) */
314 #endif
315
316
317 #endif /* math.h  */