(INT8_C, INT16_C, INT32_C, INT64_C, UINT8_C, UINT16_C, UINT32_C,
[kopensolaris-gnu/glibc.git] / math / math.h
1 /* Declarations for math functions.
2    Copyright (C) 1991, 92, 93, 95, 96, 97, 98 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 #define _MATH_H 1
26
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 <bits/huge_val.h>
34
35 /* Get machine-dependent NAN value (returned for some domain errors).  */
36 #ifdef   __USE_ISOC9X
37 # include <bits/nan.h>
38 #endif
39 /* Get general and ISO C 9X specific information.  */
40 #include <bits/mathdef.h>
41
42
43 /* The file <bits/mathcalls.h> contains the prototypes for all the
44    actual math functions.  These macros are used for those prototypes,
45    so we can easily declare each function as both `name' and `__name',
46    and can declare the float versions `namef' and `__namef'.  */
47
48 #define __MATHCALL(function,suffix, args)       \
49   __MATHDECL (_Mdouble_,function,suffix, args)
50 #define __MATHDECL(type, function,suffix, args) \
51   __MATHDECL_1(type, function,suffix, args); \
52   __MATHDECL_1(type, __CONCAT(__,function),suffix, args)
53 #define __MATHCALLX(function,suffix, args, attrib)      \
54   __MATHDECLX (_Mdouble_,function,suffix, args, attrib)
55 #define __MATHDECLX(type, function,suffix, args, attrib) \
56   __MATHDECL_1(type, function,suffix, args) __attribute__ (attrib); \
57   __MATHDECL_1(type, __CONCAT(__,function),suffix, args) __attribute__ (attrib)
58 #define __MATHDECL_1(type, function,suffix, args) \
59   extern type __MATH_PRECNAME(function,suffix) args
60
61 #define _Mdouble_               double
62 #define __MATH_PRECNAME(name,r) __CONCAT(name,r)
63 #include <bits/mathcalls.h>
64 #undef  _Mdouble_
65 #undef  __MATH_PRECNAME
66
67 #if defined __USE_MISC || defined __USE_ISOC9X
68
69
70 /* Include the file of declarations again, this time using `float'
71    instead of `double' and appending f to each function name.  */
72
73 # ifndef _Mfloat_
74 #  define _Mfloat_              float
75 # endif
76 # define _Mdouble_              _Mfloat_
77 # ifdef __STDC__
78 #  define __MATH_PRECNAME(name,r) name##f##r
79 # else
80 #  define __MATH_PRECNAME(name,r) name/**/f/**/r
81 # endif
82 # include <bits/mathcalls.h>
83 # undef _Mdouble_
84 # undef __MATH_PRECNAME
85
86 # if (__STDC__ - 0 || __GNUC__ - 0) && !defined __NO_LONG_DOUBLE_MATH
87 /* Include the file of declarations again, this time using `long double'
88    instead of `double' and appending l to each function name.  */
89
90 #  ifndef _Mlong_double_
91 #   define _Mlong_double_       long double
92 #  endif
93 #  define _Mdouble_             _Mlong_double_
94 #  ifdef __STDC__
95 #   define __MATH_PRECNAME(name,r) name##l##r
96 #  else
97 #   define __MATH_PRECNAME(name,r) name/**/l/**/r
98 #  endif
99 #  include <bits/mathcalls.h>
100 #  undef _Mdouble_
101 #  undef __MATH_PRECNAME
102
103 # endif /* __STDC__ || __GNUC__ */
104
105 #endif  /* Use misc or ISO C 9X.  */
106 #undef  __MATHDECL_1
107 #undef  __MATHDECL
108 #undef  __MATHCALL
109
110
111 #if defined __USE_MISC || defined __USE_XOPEN || defined __USE_ISOC9X
112 /* This variable is used by `gamma' and `lgamma'.  */
113 extern int signgam;
114 #endif
115
116
117 /* ISO C 9X defines some generic macros which work on any data type.  */
118 #if __USE_ISOC9X
119
120 /* Get the architecture specific values describing the floating-point
121    evaluation.  The following symbols will get defined:
122
123     float_t     floating-point type at least as wide as `float' used
124                 to evaluate `float' expressions
125     double_t    floating-point type at least as wide as `double' used
126                 to evaluate `double' expressions
127
128     FLT_EVAL_METHOD
129                 Defined to
130                   0     if `float_t' is `float' and `double_t' is `double'
131                   1     if `float_t' and `double_t' are `double'
132                   2     if `float_t' and `double_t' are `long double'
133                   else  `float_t' and `double_t' are unspecified
134
135     INFINITY    representation of the infinity value of type `float'
136
137     FP_FAST_FMA
138     FP_FAST_FMAF
139     FP_FAST_FMAL
140                 If defined it indicates that the `fma' function
141                 generally executes about as fast as a multiply and an add.
142                 This macro is defined only iff the `fma' function is
143                 implemented directly with a hardware multiply-add instructions.
144
145     FP_ILOGB0   Expands to a value returned by `ilogb (0.0)'.
146     FP_ILOGBNAN Expands to a value returned by `ilogb (NAN)'.
147
148     DECIMAL_DIG Number of decimal digits supported by conversion between
149                 decimal and all internal floating-point formats.
150
151 */
152
153 /* All floating-point numbers can be put in one of these categories.  */
154 enum
155   {
156     FP_NAN,
157 # define FP_NAN FP_NAN
158     FP_INFINITE,
159 # define FP_INFINITE FP_INFINITE
160     FP_ZERO,
161 # define FP_ZERO FP_ZERO
162     FP_SUBNORMAL,
163 # define FP_SUBNORMAL FP_SUBNORMAL
164     FP_NORMAL
165 # define FP_NORMAL FP_NORMAL
166   };
167
168 /* Return number of classification appropriate for X.  */
169 #ifdef __NO_LONG_DOUBLE_MATH
170 # define fpclassify(x) \
171      (sizeof (x) == sizeof (float) ? __fpclassifyf (x) : __fpclassify (x))
172 #else
173 # define fpclassify(x) \
174      (sizeof (x) == sizeof (float) ?                                          \
175         __fpclassifyf (x)                                                     \
176       : sizeof (x) == sizeof (double) ?                                       \
177         __fpclassify (x) : __fpclassifyl (x))
178 #endif
179
180 /* Return nonzero value if sign of X is negative.  */
181 #ifdef __NO_LONG_DOUBLE_MATH
182 # define signbit(x) \
183      (sizeof (x) == sizeof (float) ? __signbitf (x) : __signbit (x))
184 #else
185 # define signbit(x) \
186      (sizeof (x) == sizeof (float) ?                                          \
187         __signbitf (x)                                                        \
188       : sizeof (x) == sizeof (double) ?                                       \
189         __signbit (x) : __signbitl (x))
190 #endif
191
192 /* Return nonzero value if X is not +-Inf or NaN.  */
193 #ifdef __NO_LONG_DOUBLE_MATH
194 # define isfinite(x) \
195      (sizeof (x) == sizeof (float) ? __finitef (x) : __finite (x))
196 #else
197 # define isfinite(x) \
198      (sizeof (x) == sizeof (float) ?                                          \
199         __finitef (x)                                                         \
200       : sizeof (x) == sizeof (double) ?                                       \
201         __finite (x) : __finitel (x))
202 #endif
203
204 /* Return nonzero value if X is neither zero, subnormal, Inf, nor NaN.  */
205 # define isnormal(x) (fpclassify (x) == FP_NORMAL)
206
207 /* Return nonzero value if X is a NaN.  We could use `fpclassify' but
208    we already have this functions `__isnan' and it is faster.  */
209 #ifdef __NO_LONG_DOUBLE_MATH
210 # define isnan(x) \
211      (sizeof (x) == sizeof (float) ? __isnanf (x) : __isnan (x))
212 #else
213 # define isnan(x) \
214      (sizeof (x) == sizeof (float) ?                                          \
215         __isnanf (x)                                                          \
216       : sizeof (x) == sizeof (double) ?                                       \
217         __isnan (x) : __isnanl (x))
218 #endif
219
220 /* Return nonzero value is X is positive or negative infinity.  */
221 #ifdef __NO_LONG_DOUBLE_MATH
222 # define isinf(x) \
223      (sizeof (x) == sizeof (float) ? __isinff (x) : __isinf (x))
224 #else
225 # define isinf(x) \
226      (sizeof (x) == sizeof (float) ?                                          \
227         __isinff (x)                                                          \
228       : sizeof (x) == sizeof (double) ?                                       \
229         __isinf (x) : __isinfl (x))
230 #endif
231
232 #endif /* Use ISO C 9X.  */
233
234 #ifdef  __USE_MISC
235 /* Support for various different standard error handling behaviors.  */
236 typedef enum
237 {
238   _IEEE_ = -1,  /* According to IEEE 754/IEEE 854.  */
239   _SVID_,       /* According to System V, release 4.  */
240   _XOPEN_,      /* Nowadays also Unix98.  */
241   _POSIX_,
242   _ISOC_        /* Actually this is ISO C 9X.  */
243 } _LIB_VERSION_TYPE;
244
245 /* This variable can be changed at run-time to any of the values above to
246    affect floating point error handling behavior (it may also be necessary
247    to change the hardware FPU exception settings).  */
248 extern _LIB_VERSION_TYPE _LIB_VERSION;
249 #endif
250
251
252 #ifdef __USE_SVID
253 /* In SVID error handling, `matherr' is called with this description
254    of the exceptional condition.
255
256    We have a problem when using C++ since `exception' is a reserved
257    name in C++.  */
258 # ifdef __cplusplus
259 struct __exception
260 # else
261 struct exception
262 # endif
263   {
264     int type;
265     char *name;
266     double arg1;
267     double arg2;
268     double retval;
269   };
270
271 # ifdef __cplusplus
272 extern int matherr __P ((struct __exception *__exc));
273 # else
274 extern int matherr __P ((struct exception *__exc));
275 # endif
276
277 # define X_TLOSS        1.41484755040568800000e+16
278
279 /* Types of exceptions in the `type' field.  */
280 # define DOMAIN         1
281 # define SING           2
282 # define OVERFLOW       3
283 # define UNDERFLOW      4
284 # define TLOSS          5
285 # define PLOSS          6
286
287 /* SVID mode specifies returning this large value instead of infinity.  */
288 # define HUGE           FLT_MAX
289 # include <float.h>             /* Defines FLT_MAX.  */
290
291 #else   /* !SVID */
292
293 # ifdef __USE_XOPEN
294 /* X/Open wants another strange constant.  */
295 #  define MAXFLOAT      FLT_MAX
296 #  include <float.h>
297 # endif
298
299 #endif  /* SVID */
300
301
302 /* Some useful constants.  */
303 #if defined __USE_BSD || defined __USE_XOPEN
304 # define M_E            2.7182818284590452354   /* e */
305 # define M_LOG2E        1.4426950408889634074   /* log_2 e */
306 # define M_LOG10E       0.43429448190325182765  /* log_10 e */
307 # define M_LN2          0.69314718055994530942  /* log_e 2 */
308 # define M_LN10         2.30258509299404568402  /* log_e 10 */
309 # define M_PI           3.14159265358979323846  /* pi */
310 # define M_PI_2         1.57079632679489661923  /* pi/2 */
311 # define M_PI_4         0.78539816339744830962  /* pi/4 */
312 # define M_1_PI         0.31830988618379067154  /* 1/pi */
313 # define M_2_PI         0.63661977236758134308  /* 2/pi */
314 # define M_2_SQRTPI     1.12837916709551257390  /* 2/sqrt(pi) */
315 # define M_SQRT2        1.41421356237309504880  /* sqrt(2) */
316 # define M_SQRT1_2      0.70710678118654752440  /* 1/sqrt(2) */
317 #endif
318
319 /* The above constants are not adequate for computation using `long double's.
320    Therefore we provide as an extension constants with similar names as a
321    GNU extension.  Provide enough digits for the 128-bit IEEE quad.  */
322 #ifdef __USE_GNU
323 # define M_El           2.7182818284590452353602874713526625L  /* e */
324 # define M_LOG2El       1.4426950408889634073599246810018922L  /* log_2 e */
325 # define M_LOG10El      0.4342944819032518276511289189166051L  /* log_10 e */
326 # define M_LN2l         0.6931471805599453094172321214581766L  /* log_e 2 */
327 # define M_LN10l        2.3025850929940456840179914546843642L  /* log_e 10 */
328 # define M_PIl          3.1415926535897932384626433832795029L  /* pi */
329 # define M_PI_2l        1.5707963267948966192313216916397514L  /* pi/2 */
330 # define M_PI_4l        0.7853981633974483096156608458198757L  /* pi/4 */
331 # define M_1_PIl        0.3183098861837906715377675267450287L  /* 1/pi */
332 # define M_2_PIl        0.6366197723675813430755350534900574L  /* 2/pi */
333 # define M_2_SQRTPIl    1.1283791670955125738961589031215452L  /* 2/sqrt(pi) */
334 # define M_SQRT2l       1.4142135623730950488016887242096981L  /* sqrt(2) */
335 # define M_SQRT1_2l     0.7071067811865475244008443621048490L  /* 1/sqrt(2) */
336 #endif
337
338
339 /* When compiling in strict ISO C compatible mode we must not use the
340    inline functions since they, among other things, do not set the
341    `errno' variable correctly.  */
342 #if defined __STRICT_ANSI__ && !defined __NO_MATH_INLINES
343 # define __NO_MATH_INLINES      1
344 #endif
345
346 /* Get machine-dependent inline versions (if there are any).  */
347 #ifdef __USE_EXTERN_INLINES
348 # include <bits/mathinline.h>
349 #endif
350
351
352 #if __USE_ISOC9X
353 /* ISO C 9X defines some macros to compare number while taking care
354    for unordered numbers.  Since many FPUs provide special
355    instructions to support these operations and these tests are
356    defined in <bits/mathinline.h>, we define the generic macros at
357    this late point and only if they are not defined yet.  */
358
359 /* Return nonzero value if X is greater than Y.  */
360 # ifndef isgreater
361 #  define isgreater(x, y) \
362   (__extension__                                                              \
363    ({ __typeof__(x) __x = (x); __typeof__(y) __y = (y);                       \
364       !isunordered (__x, __y) && __x > __y; }))
365 # endif
366
367 /* Return nonzero value if X is greater than or equal to Y.  */
368 # ifndef isgreaterequal
369 #  define isgreaterequal(x, y) \
370   (__extension__                                                              \
371    ({ __typeof__(x) __x = (x); __typeof__(y) __y = (y);                       \
372       !isunordered (__x, __y) && __x >= __y; }))
373 # endif
374
375 /* Return nonzero value if X is less than Y.  */
376 # ifndef isless
377 #  define isless(x, y) \
378   (__extension__                                                              \
379    ({ __typeof__(x) __x = (x); __typeof__(y) __y = (y);                       \
380       !isunordered (__x, __y) && __x < __y; }))
381 # endif
382
383 /* Return nonzero value if X is less than or equal to Y.  */
384 # ifndef islessequal
385 #  define islessequal(x, y) \
386   (__extension__                                                              \
387    ({ __typeof__(x) __x = (x); __typeof__(y) __y = (y);                       \
388       !isunordered (__x, __y) && __x <= __y; }))
389 # endif
390
391 /* Return nonzero value if either X is less than Y or Y is less than X.  */
392 # ifndef islessgreater
393 #  define islessgreater(x, y) \
394   (__extension__                                                              \
395    ({ __typeof__(x) __x = (x); __typeof__(y) __y = (y);                       \
396       !isunordered (__x, __y) && (__x < __y || __y < __x); }))
397 # endif
398
399 /* Return nonzero value if arguments are unordered.  */
400 # ifndef isunordered
401 #  define isunordered(u, v) \
402   (__extension__                                                              \
403    ({ __typeof__(u) __u = (u); __typeof__(v) __v = (v);                       \
404       fpclassify (__u) == FP_NAN || fpclassify (__v) == FP_NAN; }))
405 # endif
406
407 #endif
408
409 __END_DECLS
410
411
412 #endif /* math.h  */