]> git.ipfire.org Git - thirdparty/glibc.git/blame - math/bits/mathcalls.h
Add setpayloadsig, setpayloadsigf, setpayloadsigl.
[thirdparty/glibc.git] / math / bits / mathcalls.h
CommitLineData
f7eac6eb 1/* Prototype declarations for math functions; helper file for <math.h>.
f7a9f785 2 Copyright (C) 1996-2016 Free Software Foundation, Inc.
2c6fe0bd 3 This file is part of the GNU C Library.
f7eac6eb 4
2c6fe0bd 5 The GNU C Library is free software; you can redistribute it and/or
41bdb6e2
AJ
6 modify it under the terms of the GNU Lesser General Public
7 License as published by the Free Software Foundation; either
8 version 2.1 of the License, or (at your option) any later version.
f7eac6eb 9
2c6fe0bd
UD
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
41bdb6e2 13 Lesser General Public License for more details.
f7eac6eb 14
41bdb6e2 15 You should have received a copy of the GNU Lesser General Public
59ba27a6
PE
16 License along with the GNU C Library; if not, see
17 <http://www.gnu.org/licenses/>. */
f7eac6eb
RM
18
19/* NOTE: Because of the special way this file is used by <math.h>, this
20 file must NOT be protected from multiple inclusion as header files
21 usually are.
22
23 This file provides prototype declarations for the math functions.
24 Most functions are declared using the macro:
25
26 __MATHCALL (NAME,[_r], (ARGS...));
27
28 This means there is a function `NAME' returning `double' and a function
29 `NAMEf' returning `float'. Each place `_Mdouble_' appears in the
30 prototype, that is actually `double' in the prototype for `NAME' and
31 `float' in the prototype for `NAMEf'. Reentrant variant functions are
32 called `NAME_r' and `NAMEf_r'.
33
34 Functions returning other types like `int' are declared using the macro:
35
36 __MATHDECL (TYPE, NAME,[_r], (ARGS...));
37
38 This is just like __MATHCALL but for a function returning `TYPE'
39 instead of `_Mdouble_'. In all of these cases, there is still
af6f3906 40 both a `NAME' and a `NAMEf' that takes `float' arguments.
4bbac92a 41
af6f3906
UD
42 Note that there must be no whitespace before the argument passed for
43 NAME, to make token pasting work with -traditional. */
f7eac6eb
RM
44
45#ifndef _MATH_H
7a5affeb 46# error "Never include <bits/mathcalls.h> directly; include <math.h> instead."
f7eac6eb
RM
47#endif
48
49
50/* Trigonometric functions. */
51
7a5affeb 52_Mdouble_BEGIN_NAMESPACE
f7eac6eb
RM
53/* Arc cosine of X. */
54__MATHCALL (acos,, (_Mdouble_ __x));
55/* Arc sine of X. */
56__MATHCALL (asin,, (_Mdouble_ __x));
57/* Arc tangent of X. */
58__MATHCALL (atan,, (_Mdouble_ __x));
59/* Arc tangent of Y/X. */
60__MATHCALL (atan2,, (_Mdouble_ __y, _Mdouble_ __x));
61
62/* Cosine of X. */
21933112 63__MATHCALL_VEC (cos,, (_Mdouble_ __x));
f7eac6eb 64/* Sine of X. */
4b9c2b70 65__MATHCALL_VEC (sin,, (_Mdouble_ __x));
f7eac6eb
RM
66/* Tangent of X. */
67__MATHCALL (tan,, (_Mdouble_ __x));
68
f7eac6eb
RM
69/* Hyperbolic functions. */
70
71/* Hyperbolic cosine of X. */
72__MATHCALL (cosh,, (_Mdouble_ __x));
73/* Hyperbolic sine of X. */
74__MATHCALL (sinh,, (_Mdouble_ __x));
75/* Hyperbolic tangent of X. */
76__MATHCALL (tanh,, (_Mdouble_ __x));
7a5affeb
UD
77_Mdouble_END_NAMESPACE
78
79#ifdef __USE_GNU
80/* Cosine and sine of X. */
c9a8c526
AS
81__MATHDECL_VEC (void,sincos,,
82 (_Mdouble_ __x, _Mdouble_ *__sinx, _Mdouble_ *__cosx));
7a5affeb 83#endif
f7eac6eb 84
acd7f096 85#if defined __USE_XOPEN_EXTENDED || defined __USE_ISOC99
7a5affeb 86__BEGIN_NAMESPACE_C99
f7eac6eb
RM
87/* Hyperbolic arc cosine of X. */
88__MATHCALL (acosh,, (_Mdouble_ __x));
89/* Hyperbolic arc sine of X. */
90__MATHCALL (asinh,, (_Mdouble_ __x));
91/* Hyperbolic arc tangent of X. */
92__MATHCALL (atanh,, (_Mdouble_ __x));
7a5affeb 93__END_NAMESPACE_C99
f7eac6eb
RM
94#endif
95
96/* Exponential and logarithmic functions. */
97
7a5affeb 98_Mdouble_BEGIN_NAMESPACE
6d52618b 99/* Exponential function of X. */
9c02f663 100__MATHCALL_VEC (exp,, (_Mdouble_ __x));
f7eac6eb
RM
101
102/* Break VALUE into a normalized fraction and an integral power of 2. */
afd4eb37 103__MATHCALL (frexp,, (_Mdouble_ __x, int *__exponent));
f7eac6eb
RM
104
105/* X times (two to the EXP power). */
afd4eb37 106__MATHCALL (ldexp,, (_Mdouble_ __x, int __exponent));
f7eac6eb
RM
107
108/* Natural logarithm of X. */
6af25acc 109__MATHCALL_VEC (log,, (_Mdouble_ __x));
f7eac6eb
RM
110
111/* Base-ten logarithm of X. */
112__MATHCALL (log10,, (_Mdouble_ __x));
113
377a515b 114/* Break VALUE into integral and fractional parts. */
9c89fca6 115__MATHCALL (modf,, (_Mdouble_ __x, _Mdouble_ *__iptr)) __nonnull ((2));
7a5affeb
UD
116_Mdouble_END_NAMESPACE
117
412cb261
JM
118#if __GLIBC_USE (IEC_60559_FUNCS_EXT)
119/* Compute exponent to base ten. */
7a5affeb 120__MATHCALL (exp10,, (_Mdouble_ __x));
412cb261
JM
121#endif
122#ifdef __USE_GNU
7a5affeb
UD
123/* Another name occasionally used. */
124__MATHCALL (pow10,, (_Mdouble_ __x));
125#endif
377a515b 126
acd7f096 127#if defined __USE_XOPEN_EXTENDED || defined __USE_ISOC99
7a5affeb 128__BEGIN_NAMESPACE_C99
f7eac6eb
RM
129/* Return exp(X) - 1. */
130__MATHCALL (expm1,, (_Mdouble_ __x));
131
132/* Return log(1 + X). */
133__MATHCALL (log1p,, (_Mdouble_ __x));
2c6fe0bd
UD
134
135/* Return the base 2 signed integral exponent of X. */
136__MATHCALL (logb,, (_Mdouble_ __x));
7a5affeb 137__END_NAMESPACE_C99
f7eac6eb
RM
138#endif
139
ec751a23 140#ifdef __USE_ISOC99
7a5affeb 141__BEGIN_NAMESPACE_C99
377a515b
UD
142/* Compute base-2 exponential of X. */
143__MATHCALL (exp2,, (_Mdouble_ __x));
144
145/* Compute base-2 logarithm of X. */
146__MATHCALL (log2,, (_Mdouble_ __x));
7a5affeb 147__END_NAMESPACE_C99
377a515b 148#endif
f7eac6eb
RM
149
150
151/* Power functions. */
152
7a5affeb 153_Mdouble_BEGIN_NAMESPACE
f7eac6eb 154/* Return X to the Y power. */
c10b9b13 155__MATHCALL_VEC (pow,, (_Mdouble_ __x, _Mdouble_ __y));
f7eac6eb
RM
156
157/* Return the square root of X. */
158__MATHCALL (sqrt,, (_Mdouble_ __x));
7a5affeb 159_Mdouble_END_NAMESPACE
f7eac6eb 160
acd7f096 161#if defined __USE_XOPEN || defined __USE_ISOC99
7a5affeb 162__BEGIN_NAMESPACE_C99
377a515b
UD
163/* Return `sqrt(X*X + Y*Y)'. */
164__MATHCALL (hypot,, (_Mdouble_ __x, _Mdouble_ __y));
7a5affeb 165__END_NAMESPACE_C99
e918a7fe 166#endif
377a515b 167
acd7f096 168#if defined __USE_XOPEN_EXTENDED || defined __USE_ISOC99
7a5affeb 169__BEGIN_NAMESPACE_C99
f7eac6eb
RM
170/* Return the cube root of X. */
171__MATHCALL (cbrt,, (_Mdouble_ __x));
7a5affeb 172__END_NAMESPACE_C99
f7eac6eb
RM
173#endif
174
175
176/* Nearest integer, absolute value, and remainder functions. */
177
7a5affeb 178_Mdouble_BEGIN_NAMESPACE
f7eac6eb 179/* Smallest integral value not less than X. */
f4efd068 180__MATHCALLX (ceil,, (_Mdouble_ __x), (__const__));
f7eac6eb
RM
181
182/* Absolute value of X. */
3e5f5557 183__MATHCALLX (fabs,, (_Mdouble_ __x), (__const__));
f7eac6eb
RM
184
185/* Largest integer not greater than X. */
f4efd068 186__MATHCALLX (floor,, (_Mdouble_ __x), (__const__));
f7eac6eb
RM
187
188/* Floating-point modulo remainder of X/Y. */
189__MATHCALL (fmod,, (_Mdouble_ __x, _Mdouble_ __y));
190
191
bfce746a
UD
192/* Return 0 if VALUE is finite or NaN, +1 if it
193 is +Infinity, -1 if it is -Infinity. */
194__MATHDECL_1 (int,__isinf,, (_Mdouble_ __value)) __attribute__ ((__const__));
195
a1648746
UD
196/* Return nonzero if VALUE is finite and not NaN. */
197__MATHDECL_1 (int,__finite,, (_Mdouble_ __value)) __attribute__ ((__const__));
7a5affeb 198_Mdouble_END_NAMESPACE
a1648746 199
f7eac6eb 200#ifdef __USE_MISC
3c47c83a
CD
201# if (!defined __cplusplus \
202 || __cplusplus < 201103L /* isinf conflicts with C++11. */ \
203 || __MATH_DECLARING_DOUBLE == 0) /* isinff or isinfl don't. */
f7eac6eb
RM
204/* Return 0 if VALUE is finite or NaN, +1 if it
205 is +Infinity, -1 if it is -Infinity. */
bfce746a 206__MATHDECL_1 (int,isinf,, (_Mdouble_ __value)) __attribute__ ((__const__));
d9b965fa 207# endif
f7eac6eb 208
f7eac6eb 209/* Return nonzero if VALUE is finite and not NaN. */
a1648746 210__MATHDECL_1 (int,finite,, (_Mdouble_ __value)) __attribute__ ((__const__));
f7eac6eb 211
f7eac6eb
RM
212/* Return the remainder of X/Y. */
213__MATHCALL (drem,, (_Mdouble_ __x, _Mdouble_ __y));
214
f7eac6eb 215
2c6fe0bd
UD
216/* Return the fractional part of X after dividing out `ilogb (X)'. */
217__MATHCALL (significand,, (_Mdouble_ __x));
218#endif /* Use misc. */
f7eac6eb 219
acd7f096 220#ifdef __USE_ISOC99
7a5affeb 221__BEGIN_NAMESPACE_C99
377a515b 222/* Return X with its signed changed to Y's. */
3e5f5557 223__MATHCALLX (copysign,, (_Mdouble_ __x, _Mdouble_ __y), (__const__));
7a5affeb 224__END_NAMESPACE_C99
377a515b
UD
225#endif
226
ec751a23 227#ifdef __USE_ISOC99
7a5affeb 228__BEGIN_NAMESPACE_C99
67e971f1 229/* Return representation of qNaN for double type. */
a784e502 230__MATHCALLX (nan,, (const char *__tagb), (__const__));
7a5affeb 231__END_NAMESPACE_C99
377a515b 232#endif
2c6fe0bd 233
2c6fe0bd 234
68337808 235/* Return nonzero if VALUE is not a number. */
a1648746 236__MATHDECL_1 (int,__isnan,, (_Mdouble_ __value)) __attribute__ ((__const__));
68337808 237
de20571d 238#if defined __USE_MISC || (defined __USE_XOPEN && !defined __USE_XOPEN2K)
3c47c83a
CD
239# if (!defined __cplusplus \
240 || __cplusplus < 201103L /* isnan conflicts with C++11. */ \
241 || __MATH_DECLARING_DOUBLE == 0) /* isnanf or isnanl don't. */
2c6fe0bd 242/* Return nonzero if VALUE is not a number. */
a1648746 243__MATHDECL_1 (int,isnan,, (_Mdouble_ __value)) __attribute__ ((__const__));
d9b965fa 244# endif
de20571d 245#endif
f7eac6eb 246
1f11365a 247#if defined __USE_MISC || (defined __USE_XOPEN && __MATH_DECLARING_DOUBLE)
377a515b
UD
248/* Bessel functions. */
249__MATHCALL (j0,, (_Mdouble_));
250__MATHCALL (j1,, (_Mdouble_));
251__MATHCALL (jn,, (int, _Mdouble_));
252__MATHCALL (y0,, (_Mdouble_));
253__MATHCALL (y1,, (_Mdouble_));
254__MATHCALL (yn,, (int, _Mdouble_));
255#endif
f7eac6eb
RM
256
257
acd7f096 258#if defined __USE_XOPEN || defined __USE_ISOC99
7a5affeb 259__BEGIN_NAMESPACE_C99
7d6a8338 260/* Error and gamma functions. */
f7eac6eb
RM
261__MATHCALL (erf,, (_Mdouble_));
262__MATHCALL (erfc,, (_Mdouble_));
f7eac6eb 263__MATHCALL (lgamma,, (_Mdouble_));
7a5affeb 264__END_NAMESPACE_C99
0ed99ce4
UD
265#endif
266
267#ifdef __USE_ISOC99
7a5affeb
UD
268__BEGIN_NAMESPACE_C99
269/* True gamma function. */
e852e889 270__MATHCALL (tgamma,, (_Mdouble_));
7a5affeb 271__END_NAMESPACE_C99
e852e889
UD
272#endif
273
de20571d 274#if defined __USE_MISC || (defined __USE_XOPEN && !defined __USE_XOPEN2K)
7d6a8338 275/* Obsolete alias for `lgamma'. */
e852e889 276__MATHCALL (gamma,, (_Mdouble_));
d705269e 277#endif
f7eac6eb 278
19361cb7 279#ifdef __USE_MISC
7d6a8338
UD
280/* Reentrant version of lgamma. This function uses the global variable
281 `signgam'. The reentrant version instead takes a pointer and stores
282 the value through it. */
283__MATHCALL (lgamma,_r, (_Mdouble_, int *__signgamp));
f7eac6eb
RM
284#endif
285
2c6fe0bd 286
acd7f096 287#if defined __USE_XOPEN_EXTENDED || defined __USE_ISOC99
7a5affeb 288__BEGIN_NAMESPACE_C99
2c6fe0bd
UD
289/* Return the integer nearest X in the direction of the
290 prevailing rounding mode. */
291__MATHCALL (rint,, (_Mdouble_ __x));
292
2c6fe0bd 293/* Return X + epsilon if X < Y, X - epsilon if X > Y. */
3e5f5557 294__MATHCALLX (nextafter,, (_Mdouble_ __x, _Mdouble_ __y), (__const__));
c6251f03 295# if defined __USE_ISOC99 && !defined __LDBL_COMPAT
36fe9ac9 296__MATHCALLX (nexttoward,, (_Mdouble_ __x, long double __y), (__const__));
bfce746a 297# endif
2c6fe0bd 298
bf91be88 299#if __GLIBC_USE (IEC_60559_BFP_EXT)
41a359e2
RS
300/* Return X - epsilon. */
301__MATHCALL (nextdown,, (_Mdouble_ __x));
302/* Return X + epsilon. */
303__MATHCALL (nextup,, (_Mdouble_ __x));
304# endif
305
2c6fe0bd
UD
306/* Return the remainder of integer divison X / Y with infinite precision. */
307__MATHCALL (remainder,, (_Mdouble_ __x, _Mdouble_ __y));
2c6fe0bd 308
acd7f096 309# ifdef __USE_ISOC99
d705269e 310/* Return X times (2 to the Nth power). */
dfd2257a 311__MATHCALL (scalbn,, (_Mdouble_ __x, int __n));
0ed99ce4 312# endif
d705269e
UD
313
314/* Return the binary exponent of X, which must be nonzero. */
315__MATHDECL (int,ilogb,, (_Mdouble_ __x));
377a515b
UD
316#endif
317
ec751a23 318#ifdef __USE_ISOC99
dfd2257a
UD
319/* Return X times (2 to the Nth power). */
320__MATHCALL (scalbln,, (_Mdouble_ __x, long int __n));
321
4caef86c 322/* Round X to integral value in floating-point format using current
377a515b
UD
323 rounding direction, but do not raise inexact exception. */
324__MATHCALL (nearbyint,, (_Mdouble_ __x));
325
326/* Round X to nearest integral value, rounding halfway cases away from
327 zero. */
27caaf41 328__MATHCALLX (round,, (_Mdouble_ __x), (__const__));
377a515b
UD
329
330/* Round X to the integral value in floating-point format nearest but
331 not larger in magnitude. */
3e5f5557 332__MATHCALLX (trunc,, (_Mdouble_ __x), (__const__));
377a515b
UD
333
334/* Compute remainder of X and Y and put in *QUO a value with sign of x/y
335 and magnitude congruent `mod 2^n' to the magnitude of the integral
336 quotient x/y, with n >= 3. */
337__MATHCALL (remquo,, (_Mdouble_ __x, _Mdouble_ __y, int *__quo));
338
339
dfd2257a
UD
340/* Conversion functions. */
341
342/* Round X to nearest integral value according to current rounding
343 direction. */
af6f3906 344__MATHDECL (long int,lrint,, (_Mdouble_ __x));
828beb13 345__extension__
af6f3906 346__MATHDECL (long long int,llrint,, (_Mdouble_ __x));
dfd2257a
UD
347
348/* Round X to nearest integral value, rounding halfway cases away from
349 zero. */
af6f3906 350__MATHDECL (long int,lround,, (_Mdouble_ __x));
828beb13 351__extension__
af6f3906 352__MATHDECL (long long int,llround,, (_Mdouble_ __x));
dfd2257a
UD
353
354
377a515b
UD
355/* Return positive difference between X and Y. */
356__MATHCALL (fdim,, (_Mdouble_ __x, _Mdouble_ __y));
357
4cca6b86 358/* Return maximum numeric value from X and Y. */
e58ef0f2 359__MATHCALLX (fmax,, (_Mdouble_ __x, _Mdouble_ __y), (__const__));
377a515b 360
4cca6b86 361/* Return minimum numeric value from X and Y. */
e58ef0f2 362__MATHCALLX (fmin,, (_Mdouble_ __x, _Mdouble_ __y), (__const__));
377a515b
UD
363
364
365/* Classify given number. */
3e5f5557
UD
366__MATHDECL_1 (int, __fpclassify,, (_Mdouble_ __value))
367 __attribute__ ((__const__));
377a515b
UD
368
369/* Test for negative number. */
3e5f5557
UD
370__MATHDECL_1 (int, __signbit,, (_Mdouble_ __value))
371 __attribute__ ((__const__));
dfd2257a
UD
372
373
374/* Multiply-add function computed as a ternary operation. */
375__MATHCALL (fma,, (_Mdouble_ __x, _Mdouble_ __y, _Mdouble_ __z));
d36421fa
RM
376#endif /* Use ISO C99. */
377
acd7f096 378#if defined __USE_XOPEN_EXTENDED || defined __USE_ISOC99
7a5affeb 379__END_NAMESPACE_C99
d36421fa 380#endif
7a5affeb 381
bf91be88 382#if __GLIBC_USE (IEC_60559_BFP_EXT)
1e7c8fcc
JM
383/* Test equality. */
384__MATHDECL_1 (int, __iseqsig,, (_Mdouble_ __x, _Mdouble_ __y));
385
57267616
TS
386/* Test for signaling NaN. */
387__MATHDECL_1 (int, __issignaling,, (_Mdouble_ __value))
388 __attribute__ ((__const__));
5e9d98a3
JM
389
390/* Total order operation. */
391__MATHDECL_1 (int, totalorder,, (_Mdouble_ __x, _Mdouble_ __y))
392 __attribute__ ((__const__));
cc6a8d74
JM
393
394/* Total order operation on absolute values. */
395__MATHDECL_1 (int, totalordermag,, (_Mdouble_ __x, _Mdouble_ __y))
396 __attribute__ ((__const__));
f8e8b8ed 397
eaf5ad0b
JM
398/* Canonicalize floating-point representation. */
399__MATHDECL_1 (int, canonicalize,, (_Mdouble_ *__cx, const _Mdouble_ *__x));
400
f8e8b8ed
JM
401/* Get NaN payload. */
402__MATHCALL (getpayload,, (const _Mdouble_ *__x));
eb3c12c7
JM
403
404/* Set quiet NaN payload. */
405__MATHDECL_1 (int, setpayload,, (_Mdouble_ *__x, _Mdouble_ __payload));
457663a7
JM
406
407/* Set signaling NaN payload. */
408__MATHDECL_1 (int, setpayloadsig,, (_Mdouble_ *__x, _Mdouble_ __payload));
57267616
TS
409#endif
410
de20571d
JM
411#if defined __USE_MISC || (defined __USE_XOPEN_EXTENDED \
412 && __MATH_DECLARING_DOUBLE \
413 && !defined __USE_XOPEN2K8)
7a5affeb
UD
414/* Return X times (2 to the Nth power). */
415__MATHCALL (scalb,, (_Mdouble_ __x, _Mdouble_ __n));
d36421fa 416#endif