1 /* Declarations for math functions.
2 Copyright (C) 1991-1993, 1995-1999, 2001, 2002, 2004, 2006
3 Free Software Foundation, Inc.
4 This file is part of the GNU C Library.
6 The GNU C Library is free software; you can redistribute it and/or
7 modify it under the terms of the GNU Lesser General Public
8 License as published by the Free Software Foundation; either
9 version 2.1 of the License, or (at your option) any later version.
11 The GNU C Library is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Lesser General Public License for more details.
16 You should have received a copy of the GNU Lesser General Public
17 License along with the GNU C Library; if not, write to the Free
18 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
22 * ISO C99 Standard: 7.12 Mathematics <math.h>
32 /* Get machine-dependent HUGE_VAL value (returned on overflow).
33 On all IEEE754 machines, this is +Infinity. */
34 #include <bits/huge_val.h>
36 # include <bits/huge_valf.h>
37 # include <bits/huge_vall.h>
39 /* Get machine-dependent INFINITY value. */
40 # include <bits/inf.h>
42 /* Get machine-dependent NAN value (returned for some domain errors). */
43 # include <bits/nan.h>
44 #endif /* __USE_ISOC99 */
46 /* Get general and ISO C99 specific information. */
47 #include <bits/mathdef.h>
49 #if !(defined _LIBC && (defined NOT_IN_libc && defined IS_IN_libm))
50 # define libm_hidden_proto(name, attrs...)
53 /* The file <bits/mathcalls.h> contains the prototypes for all the
54 actual math functions. These macros are used for those prototypes,
55 so we can easily declare each function as both `name' and `__name',
56 and can declare the float versions `namef' and `__namef'. */
58 #define __MATHCALL(function,suffix, args) \
59 __MATHDECL (_Mdouble_,function,suffix, args)
60 #define __MATHDECL(type, function,suffix, args) \
61 __MATHDECL_1(type, function,suffix, args);
62 #define __MATHCALLX(function,suffix, args, attrib) \
63 __MATHDECLX (_Mdouble_,function,suffix, args, attrib)
64 #define __MATHDECLX(type, function,suffix, args, attrib) \
65 __MATHDECL_1(type, function,suffix, args) __attribute__ (attrib); \
66 __MATHDECLI_MAINVARIANT(function)
67 #define __MATHDECL_1(type, function,suffix, args) \
68 extern type __MATH_PRECNAME(function,suffix) args __THROW
69 /* Decls which are also used internally in libm.
70 Only the main variant is used internally, no need to try to avoid relocs
71 for the {l,f} variants. */
72 #define __MATHCALLI(function,suffix, args) \
73 __MATHDECLI (_Mdouble_,function,suffix, args)
74 #define __MATHDECLI(type, function,suffix, args) \
75 __MATHDECL_1(type, function,suffix, args); \
76 __MATHDECLI_MAINVARIANT(function)
77 /* Private helpers for purely macro impls below.
78 Only make __foo{,f,l} visible but not (the macro-only) foo. */
79 #define __MATHDECL_PRIV(type, function,suffix, args, attrib) \
80 __MATHDECL_1(type, __CONCAT(__,function),suffix, args) \
81 __attribute__ (attrib); \
82 libm_hidden_proto(__MATH_PRECNAME(__##function,suffix))
84 #define __MATHDECLI_MAINVARIANT libm_hidden_proto
85 #define _Mdouble_ double
86 #define __MATH_PRECNAME(name,r) __CONCAT(name,r)
87 # define _Mdouble_BEGIN_NAMESPACE __BEGIN_NAMESPACE_STD
88 # define _Mdouble_END_NAMESPACE __END_NAMESPACE_STD
89 #include <bits/mathcalls.h>
91 #undef _Mdouble_BEGIN_NAMESPACE
92 #undef _Mdouble_END_NAMESPACE
93 #undef __MATH_PRECNAME
94 #undef __MATHDECLI_MAINVARIANT
95 #define __MATHDECLI_MAINVARIANT(x)
97 #if defined __USE_MISC || defined __USE_ISOC99
100 /* Include the file of declarations again, this time using `float'
101 instead of `double' and appending f to each function name. */
104 # define _Mfloat_ float
106 # define _Mdouble_ _Mfloat_
108 # define __MATH_PRECNAME(name,r) name##f##r
110 # define __MATH_PRECNAME(name,r) name/**/f/**/r
112 # define _Mdouble_BEGIN_NAMESPACE __BEGIN_NAMESPACE_C99
113 # define _Mdouble_END_NAMESPACE __END_NAMESPACE_C99
114 # include <bits/mathcalls.h>
116 # undef _Mdouble_BEGIN_NAMESPACE
117 # undef _Mdouble_END_NAMESPACE
118 # undef __MATH_PRECNAME
120 # if (__STDC__ - 0 || __GNUC__ - 0) \
121 && (!defined __NO_LONG_DOUBLE_MATH || defined __LDBL_COMPAT)
122 # ifdef __LDBL_COMPAT
125 extern float __nldbl_nexttowardf (float __x
, long double __y
)
126 __THROW
__attribute__ ((__const__
));
127 # ifdef __REDIRECT_NTH
128 extern float __REDIRECT_NTH (nexttowardf
, (float __x
, long double __y
),
130 __attribute__ ((__const__
));
131 extern double __REDIRECT_NTH (nexttoward
, (double __x
, long double __y
),
132 nextafter
) __attribute__ ((__const__
));
133 extern long double __REDIRECT_NTH (nexttowardl
,
134 (long double __x
, long double __y
),
135 nextafter
) __attribute__ ((__const__
));
139 /* Include the file of declarations again, this time using `long double'
140 instead of `double' and appending l to each function name. */
143 # define __MATHDECL_2(type, function,suffix, args, alias) \
144 extern type __REDIRECT_NTH(__MATH_PRECNAME(function,suffix), \
146 # define __MATHDECL_1(type, function,suffix, args) \
147 __MATHDECL_2(type, function,suffix, args, __CONCAT(function,suffix))
150 # ifndef _Mlong_double_
151 # define _Mlong_double_ long double
153 # define _Mdouble_ _Mlong_double_
155 # define __MATH_PRECNAME(name,r) name##l##r
157 # define __MATH_PRECNAME(name,r) name/**/l/**/r
159 # define _Mdouble_BEGIN_NAMESPACE __BEGIN_NAMESPACE_C99
160 # define _Mdouble_END_NAMESPACE __END_NAMESPACE_C99
161 # include <bits/mathcalls.h>
163 # undef _Mdouble_BEGIN_NAMESPACE
164 # undef _Mdouble_END_NAMESPACE
165 # undef __MATH_PRECNAME
167 # endif /* __STDC__ || __GNUC__ */
169 #endif /* Use misc or ISO C99. */
175 #if defined __USE_MISC || defined __USE_XOPEN
176 /* This variable is used by `gamma' and `lgamma'. */
181 /* ISO C99 defines some generic macros which work on any data type. */
182 #if defined(__USE_ISOC99) || defined(__USE_BSD)
184 /* Get the architecture specific values describing the floating-point
185 evaluation. The following symbols will get defined:
187 float_t floating-point type at least as wide as `float' used
188 to evaluate `float' expressions
189 double_t floating-point type at least as wide as `double' used
190 to evaluate `double' expressions
194 0 if `float_t' is `float' and `double_t' is `double'
195 1 if `float_t' and `double_t' are `double'
196 2 if `float_t' and `double_t' are `long double'
197 else `float_t' and `double_t' are unspecified
199 INFINITY representation of the infinity value of type `float'
204 If defined it indicates that the `fma' function
205 generally executes about as fast as a multiply and an add.
206 This macro is defined only iff the `fma' function is
207 implemented directly with a hardware multiply-add instructions.
209 FP_ILOGB0 Expands to a value returned by `ilogb (0.0)'.
210 FP_ILOGBNAN Expands to a value returned by `ilogb (NAN)'.
212 DECIMAL_DIG Number of decimal digits supported by conversion between
213 decimal and all internal floating-point formats.
217 /* All floating-point numbers can be put in one of these categories. */
221 # define FP_NAN FP_NAN
223 # define FP_INFINITE FP_INFINITE
225 # define FP_ZERO FP_ZERO
227 # define FP_SUBNORMAL FP_SUBNORMAL
229 # define FP_NORMAL FP_NORMAL
232 /* Return number of classification appropriate for X. */
233 # ifdef __NO_LONG_DOUBLE_MATH
234 # define fpclassify(x) \
235 (sizeof (x) == sizeof (float) ? __fpclassifyf (x) : __fpclassify (x))
237 # define fpclassify(x) \
238 (sizeof (x) == sizeof (float) \
239 ? __fpclassifyf (x) \
240 : sizeof (x) == sizeof (double) \
241 ? __fpclassify (x) : __fpclassifyl (x))
244 /* Return nonzero value if sign of X is negative. */
245 # ifdef __NO_LONG_DOUBLE_MATH
246 # define signbit(x) \
247 (sizeof (x) == sizeof (float) ? __signbitf (x) : __signbit (x))
249 # define signbit(x) \
250 (sizeof (x) == sizeof (float) \
252 : sizeof (x) == sizeof (double) \
253 ? __signbit (x) : __signbitl (x))
256 /* Return nonzero value if X is not +-Inf or NaN. */
257 # ifdef __NO_LONG_DOUBLE_MATH
258 # define isfinite(x) \
259 (sizeof (x) == sizeof (float) ? __finitef (x) : __finite (x))
261 # define isfinite(x) \
262 (sizeof (x) == sizeof (float) \
264 : sizeof (x) == sizeof (double) \
265 ? __finite (x) : __finitel (x))
268 /* Return nonzero value if X is neither zero, subnormal, Inf, nor NaN. */
269 # define isnormal(x) (fpclassify (x) == FP_NORMAL)
271 /* Return nonzero value if X is a NaN. We could use `fpclassify' but
272 we already have this functions `__isnan' and it is faster. */
273 # ifdef __NO_LONG_DOUBLE_MATH
275 (sizeof (x) == sizeof (float) ? __isnanf (x) : __isnan (x))
278 (sizeof (x) == sizeof (float) \
280 : sizeof (x) == sizeof (double) \
281 ? __isnan (x) : __isnanl (x))
284 /* Return nonzero value is X is positive or negative infinity. */
285 # ifdef __NO_LONG_DOUBLE_MATH
287 (sizeof (x) == sizeof (float) ? __isinff (x) : __isinf (x))
290 (sizeof (x) == sizeof (float) \
292 : sizeof (x) == sizeof (double) \
293 ? __isinf (x) : __isinfl (x))
296 /* Bitmasks for the math_errhandling macro. */
297 # define MATH_ERRNO 1 /* errno set by math functions. */
298 # define MATH_ERREXCEPT 2 /* Exceptions raised by math functions. */
300 #endif /* Use ISO C99. */
303 #define finite(x) __finite(x)
304 #define finitef(x) __finitef(x)
305 #define finitel(x) __finitel(x)
308 /* Support for various different standard error handling behaviors. */
311 _IEEE_
= -1, /* According to IEEE 754/IEEE 854. */
312 _SVID_
, /* According to System V, release 4. */
313 _XOPEN_
, /* Nowadays also Unix98. */
315 _ISOC_
/* Actually this is ISO C99. */
318 /* This variable can be changed at run-time to any of the values above to
319 affect floating point error handling behavior (it may also be necessary
320 to change the hardware FPU exception settings). */
321 extern _LIB_VERSION_TYPE _LIB_VERSION
;
326 /* In SVID error handling, `matherr' is called with this description
327 of the exceptional condition.
329 We have a problem when using C++ since `exception' is a reserved
345 extern int matherr (struct __exception
*__exc
) throw ();
347 extern int matherr (struct exception
*__exc
);
350 # define X_TLOSS 1.41484755040568800000e+16
352 /* Types of exceptions in the `type' field. */
360 /* SVID mode specifies returning this large value instead of infinity. */
361 # define HUGE 3.40282347e+38F
366 /* X/Open wants another strange constant. */
367 # define MAXFLOAT 3.40282347e+38F
373 /* Some useful constants. */
374 #if defined __USE_BSD || defined __USE_XOPEN
375 # define M_E 2.7182818284590452354 /* e */
376 # define M_LOG2E 1.4426950408889634074 /* log_2 e */
377 # define M_LOG10E 0.43429448190325182765 /* log_10 e */
378 # define M_LN2 0.69314718055994530942 /* log_e 2 */
379 # define M_LN10 2.30258509299404568402 /* log_e 10 */
380 # define M_PI 3.14159265358979323846 /* pi */
381 # define M_PI_2 1.57079632679489661923 /* pi/2 */
382 # define M_PI_4 0.78539816339744830962 /* pi/4 */
383 # define M_1_PI 0.31830988618379067154 /* 1/pi */
384 # define M_2_PI 0.63661977236758134308 /* 2/pi */
385 # define M_2_SQRTPI 1.12837916709551257390 /* 2/sqrt(pi) */
386 # define M_SQRT2 1.41421356237309504880 /* sqrt(2) */
387 # define M_SQRT1_2 0.70710678118654752440 /* 1/sqrt(2) */
390 /* The above constants are not adequate for computation using `long double's.
391 Therefore we provide as an extension constants with similar names as a
392 GNU extension. Provide enough digits for the 128-bit IEEE quad. */
394 # define M_El 2.7182818284590452353602874713526625L /* e */
395 # define M_LOG2El 1.4426950408889634073599246810018921L /* log_2 e */
396 # define M_LOG10El 0.4342944819032518276511289189166051L /* log_10 e */
397 # define M_LN2l 0.6931471805599453094172321214581766L /* log_e 2 */
398 # define M_LN10l 2.3025850929940456840179914546843642L /* log_e 10 */
399 # define M_PIl 3.1415926535897932384626433832795029L /* pi */
400 # define M_PI_2l 1.5707963267948966192313216916397514L /* pi/2 */
401 # define M_PI_4l 0.7853981633974483096156608458198757L /* pi/4 */
402 # define M_1_PIl 0.3183098861837906715377675267450287L /* 1/pi */
403 # define M_2_PIl 0.6366197723675813430755350534900574L /* 2/pi */
404 # define M_2_SQRTPIl 1.1283791670955125738961589031215452L /* 2/sqrt(pi) */
405 # define M_SQRT2l 1.4142135623730950488016887242096981L /* sqrt(2) */
406 # define M_SQRT1_2l 0.7071067811865475244008443621048490L /* 1/sqrt(2) */
410 /* When compiling in strict ISO C compatible mode we must not use the
411 inline functions since they, among other things, do not set the
412 `errno' variable correctly. */
413 #if defined __STRICT_ANSI__ && !defined __NO_MATH_INLINES
414 # define __NO_MATH_INLINES 1
417 #if defined __USE_ISOC99 && __GNUC_PREREQ(2,97)
418 /* ISO C99 defines some macros to compare number while taking care for
419 unordered numbers. Many FPUs provide special instructions to support
420 these operations. Generic support in GCC for these as builtins went
421 in before 3.0.0, but not all cpus added their patterns. We define
422 versions that use the builtins here, and <bits/mathinline.h> will
423 undef/redefine as appropriate for the specific GCC version in use. */
424 # define isgreater(x, y) __builtin_isgreater(x, y)
425 # define isgreaterequal(x, y) __builtin_isgreaterequal(x, y)
426 # define isless(x, y) __builtin_isless(x, y)
427 # define islessequal(x, y) __builtin_islessequal(x, y)
428 # define islessgreater(x, y) __builtin_islessgreater(x, y)
429 # define isunordered(u, v) __builtin_isunordered(u, v)
432 /* Get machine-dependent inline versions (if there are any). */
433 #ifdef __USE_EXTERN_INLINES
434 # include <bits/mathinline.h>
438 /* If we've still got undefined comparison macros, provide defaults. */
440 /* Return nonzero value if X is greater than Y. */
442 # define isgreater(x, y) \
444 ({ __typeof__(x) __x = (x); __typeof__(y) __y = (y); \
445 !isunordered (__x, __y) && __x > __y; }))
448 /* Return nonzero value if X is greater than or equal to Y. */
449 # ifndef isgreaterequal
450 # define isgreaterequal(x, y) \
452 ({ __typeof__(x) __x = (x); __typeof__(y) __y = (y); \
453 !isunordered (__x, __y) && __x >= __y; }))
456 /* Return nonzero value if X is less than Y. */
458 # define isless(x, y) \
460 ({ __typeof__(x) __x = (x); __typeof__(y) __y = (y); \
461 !isunordered (__x, __y) && __x < __y; }))
464 /* Return nonzero value if X is less than or equal to Y. */
466 # define islessequal(x, y) \
468 ({ __typeof__(x) __x = (x); __typeof__(y) __y = (y); \
469 !isunordered (__x, __y) && __x <= __y; }))
472 /* Return nonzero value if either X is less than Y or Y is less than X. */
473 # ifndef islessgreater
474 # define islessgreater(x, y) \
476 ({ __typeof__(x) __x = (x); __typeof__(y) __y = (y); \
477 !isunordered (__x, __y) && (__x < __y || __y < __x); }))
480 /* Return nonzero value if arguments are unordered. */
482 # define isunordered(u, v) \
484 ({ __typeof__(u) __u = (u); __typeof__(v) __v = (v); \
485 fpclassify (__u) == FP_NAN || fpclassify (__v) == FP_NAN; }))