update from main archive 970304
[kopensolaris-gnu/glibc.git] / math / math.h
1 /* Declarations for math functions.
2    Copyright (C) 1991, 92, 93, 95, 96, 97 Free Software Foundation, Inc.
3    This file is part of the GNU C Library.
4
5    The GNU C Library is free software; you can redistribute it and/or
6    modify it under the terms of the GNU Library General Public License as
7    published by the Free Software Foundation; either version 2 of the
8    License, or (at your option) any later version.
9
10    The GNU C Library is distributed in the hope that it will be useful,
11    but WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13    Library General Public License for more details.
14
15    You should have received a copy of the GNU Library General Public
16    License along with the GNU C Library; see the file COPYING.LIB.  If not,
17    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18    Boston, MA 02111-1307, USA.  */
19
20 /*
21  *      ISO C Standard: 4.5 MATHEMATICS <math.h>
22  */
23
24 #ifndef _MATH_H
25
26 #define _MATH_H 1
27 #include <features.h>
28
29 __BEGIN_DECLS
30
31 /* Get machine-dependent HUGE_VAL value (returned on overflow).
32    On all IEEE754 machines, this is +Infinity.  */
33 #include <huge_val.h>
34
35 /* Get machine-dependent NAN value (returned for some domain errors).  */
36 #ifdef   __USE_GNU
37 #include <nan.h>
38 #endif
39
40
41 /* The file <mathcalls.h> contains the prototypes for all the actual
42    math functions.  These macros are used for those prototypes, so
43    we can easily declare each function as both `name' and `__name',
44    and can declare the float versions `namef' and `__namef'.  */
45
46 #define __MATHCALL(function,suffix, args)       \
47   __MATHDECL (_Mdouble_,function,suffix, args)
48 #define __MATHDECL(type, function,suffix, args) \
49   __MATHDECL_1(type, function,suffix, args); \
50   __MATHDECL_1(type, __CONCAT(__,function),suffix, args)
51 #define __MATHDECL_1(type, function,suffix, args) \
52   extern type __MATH_PRECNAME(function,suffix) args
53
54 #define _Mdouble_               double
55 #define __MATH_PRECNAME(name,r) __CONCAT(name,r)
56 #include <mathcalls.h>
57 #undef  _Mdouble_
58 #undef  __MATH_PRECNAME
59
60 #if defined __USE_MISC || defined __USE_ISOC9X
61
62
63 /* Include the file of declarations again, this time using `float'
64    instead of `double' and appending f to each function name.  */
65
66 #ifndef _Mfloat_
67 #define _Mfloat_                float
68 #endif
69 #define _Mdouble_               _Mfloat_
70 #ifdef __STDC__
71 #define __MATH_PRECNAME(name,r) name##f##r
72 #else
73 #define __MATH_PRECNAME(name,r) name/**/f/**/r
74 #endif
75 #include <mathcalls.h>
76 #undef  _Mdouble_
77 #undef  __MATH_PRECNAME
78
79 #if __STDC__ - 0 || __GNUC__ - 0
80 /* Include the file of declarations again, this time using `long double'
81    instead of `double' and appending l to each function name.  */
82
83 #ifndef _Mlong_double_
84 #define _Mlong_double_          long double
85 #endif
86 #define _Mdouble_               _Mlong_double_
87 #ifdef __STDC__
88 #define __MATH_PRECNAME(name,r) name##l##r
89 #else
90 #define __MATH_PRECNAME(name,r) name/**/l/**/r
91 #endif
92 #include <mathcalls.h>
93 #undef  _Mdouble_
94 #undef  __MATH_PRECNAME
95
96 #endif /* __STDC__ || __GNUC__ */
97
98 #endif  /* Use misc or ISO C 9X.  */
99
100
101 /* ISO C 9X defines some generic macros which work on any data type.  */
102 #if __USE_ISOC9X
103
104 /* All floating-point numbers can be put in one of these categories.  */
105 enum
106   {
107     FP_NAN,
108 #define FP_NAN FP_NAN
109     FP_INFINITE,
110 #define FP_INFINITE FP_INFINITE
111     FP_ZERO,
112 #define FP_ZERO FP_ZERO
113     FP_SUBNORMAL,
114 #define FP_SUBNORMAL FP_SUBNORMAL
115     FP_NORMAL
116 #define FP_NORMAL FP_NORMAL
117   };
118
119 /* Return number of classification appropriate for X.  */
120 #define fpclassify(x) \
121      (sizeof (x) == sizeof (float) ?                                          \
122         __finitef (x)                                                         \
123       : sizeof (x) == sizeof (double) ?                                       \
124         __finite (x) : __finitel (x))
125
126 /* Return nonzero value if sign of X is negative.  */
127 #define signbit(x) \
128      (sizeof (x) == sizeof (float) ?                                          \
129         __signbitf (x)                                                        \
130       : sizeof (x) == sizeof (double) ?                                       \
131         __signbit (x) : __signbitl (x))
132
133 /* Return nonzero value if X is not +-Inf or NaN.  */
134 #define isfinite(x) (fpclassify (x) >= FP_ZERO)
135
136 /* Return nonzero value if X is neither zero, subnormal, Inf, nor NaN.  */
137 #define isnormal(x) (fpclassify (x) == FP_NORMAL)
138
139 /* Return nonzero value if X is a NaN.  We could use `fpclassify' but
140    we already have this functions `__isnan' and it is faster.  */
141 #define isnan(x) \
142      (sizeof (x) == sizeof (float) ?                                          \
143         __isnanf (x)                                                          \
144       : sizeof (x) == sizeof (double) ?                                       \
145         __isnan (x) : __isnanl (x))
146
147
148 /* Conversion functions.  */
149
150 /* Round X to nearest integral value according to current rounding
151    direction.  */
152 extern long int rinttol __P ((double __x));
153 extern long long int rinttoll __P ((double __x));
154
155 /* Round X to nearest integral value, rounding halfway cases away from
156    zero.  */
157 extern long int roundtol __P ((double __x));
158 extern long long int roundtoll __P ((double __x));
159
160
161 /* Comparison macros.  */
162
163 /* Return nonzero value if X is greater than Y.  */
164 #define isgreater(x, y) (!isunordered ((x), (y)) && (x) > (y))
165
166 /* Return nonzero value if X is greater than or equal to Y.  */
167 #define isgreaterequal(x, y) (!isunordered ((x), (y)) && (x) >= (y))
168
169 /* Return nonzero value if X is less than Y.  */
170 #define isless(x, y) (!isunordered ((x), (y)) && (x) < (y))
171
172 /* Return nonzero value if X is less than or equal to Y.  */
173 #define islessequal(x, y) (!isunordered ((x), (y)) && (x) <= (y))
174
175 /* Return nonzero value if either X is less than Y or Y is less than X.  */
176 #define islessgreater(x, y) \
177      (!isunordered ((x), (y)) && ((x) < (y) || (y) < (x)))
178
179 /* Return nonzero value if arguments are unordered.  */
180 #define isunordered(x, y) \
181      (fpclassify (x) == FP_NAN || fpclassify (y) == FP_NAN)
182
183 #endif /* Use ISO C 9X.  */
184
185 #ifdef  __USE_MISC
186 /* Support for various different standard error handling behaviors.  */
187
188 typedef enum { _IEEE_ = -1, _SVID_, _XOPEN_, _POSIX_ } _LIB_VERSION_TYPE;
189
190 /* This variable can be changed at run-time to any of the values above to
191    affect floating point error handling behavior (it may also be necessary
192    to change the hardware FPU exception settings).  */
193 extern _LIB_VERSION_TYPE _LIB_VERSION;
194 #endif
195
196
197 #ifdef __USE_SVID
198 /* In SVID error handling, `matherr' is called with this description
199    of the exceptional condition.
200
201    We have a problem when using C++ since `exception' is reserved in
202    C++.  */
203 #ifdef __cplusplus
204 struct __exception
205 #else
206 struct exception
207 #endif
208   {
209     int type;
210     char *name;
211     double arg1;
212     double arg2;
213     double retval;
214   };
215
216 #ifdef __cplusplus
217 extern int __matherr __P ((struct __exception *));
218 extern int matherr __P ((struct __exception *));
219 #else
220 extern int __matherr __P ((struct exception *));
221 extern int matherr __P ((struct exception *));
222 #endif
223
224 #define X_TLOSS         1.41484755040568800000e+16
225
226 /* Types of exceptions in the `type' field.  */
227 #define DOMAIN          1
228 #define SING            2
229 #define OVERFLOW        3
230 #define UNDERFLOW       4
231 #define TLOSS           5
232 #define PLOSS           6
233
234 /* SVID mode specifies returning this large value instead of infinity.  */
235 #define HUGE            FLT_MAX
236 #include <float.h>              /* Defines FLT_MAX.  */
237
238 #else   /* !SVID */
239
240 #ifdef __USE_XOPEN
241 /* X/Open wants another strange constant.  */
242 #define MAXFLOAT        FLT_MAX
243 #include <float.h>
244 #endif
245
246 #endif  /* SVID */
247
248
249 #ifdef __USE_BSD
250
251 /* Some useful constants.  */
252 #define M_E             _Mldbl(2.7182818284590452354)   /* e */
253 #define M_LOG2E         _Mldbl(1.4426950408889634074)   /* log 2e */
254 #define M_LOG10E        _Mldbl(0.43429448190325182765)  /* log 10e */
255 #define M_LN2           _Mldbl(0.69314718055994530942)  /* log e2 */
256 #define M_LN10          _Mldbl(2.30258509299404568402)  /* log e10 */
257 #define M_PI            _Mldbl(3.14159265358979323846)  /* pi */
258 #define M_PI_2          _Mldbl(1.57079632679489661923)  /* pi/2 */
259 #define M_PI_4          _Mldbl(0.78539816339744830962)  /* pi/4 */
260 #define M_1_PI          _Mldbl(0.31830988618379067154)  /* 1/pi */
261 #define M_2_PI          _Mldbl(0.63661977236758134308)  /* 2/pi */
262 #define M_2_SQRTPI      _Mldbl(1.12837916709551257390)  /* 2/sqrt(pi) */
263 #define M_SQRT2         _Mldbl(1.41421356237309504880)  /* sqrt(2) */
264 #define M_SQRT1_2       _Mldbl(0.70710678118654752440)  /* 1/sqrt(2) */
265
266 /* Our constants might specify more precision than `double' can represent.
267    Use `long double' constants in standard and GNU C, where they are
268    supported and the cast to `double'.  */
269 #if __STDC__ - 0 || __GNUC__ - 0
270 #define _Mldbl(x) x##L
271 #else   /* Traditional C.  */
272 #define _Mldbl(x) x
273 #endif  /* Standard or GNU C.  */
274
275 #endif
276
277
278 /* Get machine-dependent inline versions (if there are any).  */
279 #if (!defined __NO_MATH_INLINES && defined __OPTIMIZE__) \
280     || defined __LIBC_M81_MATH_INLINES
281 #include <__math.h>
282 #endif
283
284
285 __END_DECLS
286
287
288 #endif /* math.h  */