]>
git.ipfire.org Git - thirdparty/glibc.git/blob - math/bits/mathcalls.h
1 /* Prototype declarations for math functions; helper file for <math.h>.
2 Copyright (C) 1996, 1997, 1998, 1999 Free Software Foundation, Inc.
3 This file is part of the GNU C Library.
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.
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.
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. */
20 /* NOTE: Because of the special way this file is used by <math.h>, this
21 file must NOT be protected from multiple inclusion as header files
24 This file provides prototype declarations for the math functions.
25 Most functions are declared using the macro:
27 __MATHCALL (NAME,[_r], (ARGS...));
29 This means there is a function `NAME' returning `double' and a function
30 `NAMEf' returning `float'. Each place `_Mdouble_' appears in the
31 prototype, that is actually `double' in the prototype for `NAME' and
32 `float' in the prototype for `NAMEf'. Reentrant variant functions are
33 called `NAME_r' and `NAMEf_r'.
35 Functions returning other types like `int' are declared using the macro:
37 __MATHDECL (TYPE, NAME,[_r], (ARGS...));
39 This is just like __MATHCALL but for a function returning `TYPE'
40 instead of `_Mdouble_'. In all of these cases, there is still
41 both a `NAME' and a `NAMEf' that takes `float' arguments.
43 Note that there must be no whitespace before the argument passed for
44 NAME, to make token pasting work with -traditional. */
47 #error "Never include <bits/mathcalls.h> directly; include <math.h> instead."
51 /* Trigonometric functions. */
53 /* Arc cosine of X. */
54 __MATHCALL (acos
,, (_Mdouble_ __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
));
63 __MATHCALL (cos
,, (_Mdouble_ __x
));
65 __MATHCALL (sin
,, (_Mdouble_ __x
));
67 __MATHCALL (tan
,, (_Mdouble_ __x
));
70 /* Cosine and sine of X. */
71 __MATHDECL (void,sincos
,,
72 (_Mdouble_ __x
, _Mdouble_
*__sinx
, _Mdouble_
*__cosx
));
75 /* Hyperbolic functions. */
77 /* Hyperbolic cosine of X. */
78 __MATHCALL (cosh
,, (_Mdouble_ __x
));
79 /* Hyperbolic sine of X. */
80 __MATHCALL (sinh
,, (_Mdouble_ __x
));
81 /* Hyperbolic tangent of X. */
82 __MATHCALL (tanh
,, (_Mdouble_ __x
));
84 #if defined __USE_MISC || defined __USE_XOPEN_EXTENDED || defined __USE_ISOC9X
85 /* Hyperbolic arc cosine of X. */
86 __MATHCALL (acosh
,, (_Mdouble_ __x
));
87 /* Hyperbolic arc sine of X. */
88 __MATHCALL (asinh
,, (_Mdouble_ __x
));
89 /* Hyperbolic arc tangent of X. */
90 __MATHCALL (atanh
,, (_Mdouble_ __x
));
93 /* Exponential and logarithmic functions. */
95 /* Exponential function of X. */
96 __MATHCALL (exp
,, (_Mdouble_ __x
));
99 /* A function missing in all standards: compute exponent to base ten. */
100 __MATHCALL (exp10
,, (_Mdouble_ __x
));
101 /* Another name occasionally used. */
102 __MATHCALL (pow10
,, (_Mdouble_ __x
));
105 /* Break VALUE into a normalized fraction and an integral power of 2. */
106 __MATHCALL (frexp
,, (_Mdouble_ __x
, int *__exponent
));
108 /* X times (two to the EXP power). */
109 __MATHCALL (ldexp
,, (_Mdouble_ __x
, int __exponent
));
111 /* Natural logarithm of X. */
112 __MATHCALL (log
,, (_Mdouble_ __x
));
114 /* Base-ten logarithm of X. */
115 __MATHCALL (log10
,, (_Mdouble_ __x
));
117 /* Break VALUE into integral and fractional parts. */
118 __MATHCALL (modf
,, (_Mdouble_ __x
, _Mdouble_
*__iptr
));
120 #if defined __USE_MISC || defined __USE_XOPEN_EXTENDED || defined __USE_ISOC9X
121 /* Return exp(X) - 1. */
122 __MATHCALL (expm1
,, (_Mdouble_ __x
));
124 /* Return log(1 + X). */
125 __MATHCALL (log1p
,, (_Mdouble_ __x
));
127 /* Return the base 2 signed integral exponent of X. */
128 __MATHCALL (logb
,, (_Mdouble_ __x
));
132 /* Compute base-2 exponential of X. */
133 __MATHCALL (exp2
,, (_Mdouble_ __x
));
135 /* Compute base-2 logarithm of X. */
136 __MATHCALL (log2
,, (_Mdouble_ __x
));
140 /* Power functions. */
142 /* Return X to the Y power. */
143 __MATHCALL (pow
,, (_Mdouble_ __x
, _Mdouble_ __y
));
145 /* Return the square root of X. */
146 __MATHCALL (sqrt
,, (_Mdouble_ __x
));
148 #if defined __USE_MISC || defined __USE_XOPEN || defined __USE_ISOC9X
149 /* Return `sqrt(X*X + Y*Y)'. */
150 __MATHCALL (hypot
,, (_Mdouble_ __x
, _Mdouble_ __y
));
153 #if defined __USE_MISC || defined __USE_XOPEN_EXTENDED || defined __USE_ISOC9X
154 /* Return the cube root of X. */
155 __MATHCALL (cbrt
,, (_Mdouble_ __x
));
159 /* Nearest integer, absolute value, and remainder functions. */
161 /* Smallest integral value not less than X. */
162 __MATHCALL (ceil
,, (_Mdouble_ __x
));
164 /* Absolute value of X. */
165 __MATHCALLX (fabs
,, (_Mdouble_ __x
), (__const__
));
167 /* Largest integer not greater than X. */
168 __MATHCALL (floor
,, (_Mdouble_ __x
));
170 /* Floating-point modulo remainder of X/Y. */
171 __MATHCALL (fmod
,, (_Mdouble_ __x
, _Mdouble_ __y
));
174 /* Return 0 if VALUE is finite or NaN, +1 if it
175 is +Infinity, -1 if it is -Infinity. */
176 __MATHDECL_1 (int,__isinf
,, (_Mdouble_ __value
)) __attribute__ ((__const__
));
179 /* Return 0 if VALUE is finite or NaN, +1 if it
180 is +Infinity, -1 if it is -Infinity. */
181 __MATHDECL_1 (int,isinf
,, (_Mdouble_ __value
)) __attribute__ ((__const__
));
183 /* Return nonzero if VALUE is finite and not NaN. */
184 __MATHDECLX (int,finite
,, (_Mdouble_ __value
), (__const__
));
186 /* Deal with an infinite or NaN result.
187 If ERROR is ERANGE, result is +Inf;
188 if ERROR is - ERANGE, result is -Inf;
189 otherwise result is NaN.
190 This will set `errno' to either ERANGE or EDOM,
191 and may return an infinity or NaN, or may do something else. */
192 __MATHCALLX (infnan
,, (int __error
), (__const__
));
194 /* Return the remainder of X/Y. */
195 __MATHCALL (drem
,, (_Mdouble_ __x
, _Mdouble_ __y
));
198 /* Return the fractional part of X after dividing out `ilogb (X)'. */
199 __MATHCALL (significand
,, (_Mdouble_ __x
));
200 #endif /* Use misc. */
202 #if defined __USE_MISC || defined __USE_ISOC9X
203 /* Return X with its signed changed to Y's. */
204 __MATHCALLX (copysign
,, (_Mdouble_ __x
, _Mdouble_ __y
), (__const__
));
208 /* Return representation of NaN for double type. */
209 __MATHCALLX (nan
,, (__const
char *__tagb
), (__const__
));
213 /* Return nonzero if VALUE is not a number. */
214 __MATHDECLX (int,__isnan
,, (_Mdouble_ __value
), (__const__
));
216 #if defined __USE_MISC || defined __USE_XOPEN
217 /* Return nonzero if VALUE is not a number. */
218 __MATHDECLX (int,isnan
,, (_Mdouble_ __value
), (__const__
));
220 /* Bessel functions. */
221 __MATHCALL (j0
,, (_Mdouble_
));
222 __MATHCALL (j1
,, (_Mdouble_
));
223 __MATHCALL (jn
,, (int, _Mdouble_
));
224 __MATHCALL (y0
,, (_Mdouble_
));
225 __MATHCALL (y1
,, (_Mdouble_
));
226 __MATHCALL (yn
,, (int, _Mdouble_
));
230 #if defined __USE_MISC || defined __USE_XOPEN || defined __USE_ISOC9X
231 /* Error and gamma functions. */
232 __MATHCALL (erf
,, (_Mdouble_
));
233 __MATHCALL (erfc
,, (_Mdouble_
));
234 __MATHCALL (lgamma
,, (_Mdouble_
));
235 __MATHCALL (tgamma
,, (_Mdouble_
));
238 #if defined __USE_MISC || defined __USE_XOPEN
239 /* Obsolete alias for `lgamma'. */
240 __MATHCALL (gamma
,, (_Mdouble_
));
244 /* Reentrant version of lgamma. This function uses the global variable
245 `signgam'. The reentrant version instead takes a pointer and stores
246 the value through it. */
247 __MATHCALL (lgamma
,_r
, (_Mdouble_
, int *__signgamp
));
251 #if defined __USE_MISC || defined __USE_XOPEN_EXTENDED || defined __USE_ISOC9X
252 /* Return the integer nearest X in the direction of the
253 prevailing rounding mode. */
254 __MATHCALL (rint
,, (_Mdouble_ __x
));
256 /* Return X + epsilon if X < Y, X - epsilon if X > Y. */
257 __MATHCALLX (nextafter
,, (_Mdouble_ __x
, _Mdouble_ __y
), (__const__
));
259 __MATHCALLX (nexttoward
,, (_Mdouble_ __x
, long double __y
), (__const__
));
262 /* Return the remainder of integer divison X / Y with infinite precision. */
263 __MATHCALL (remainder
,, (_Mdouble_ __x
, _Mdouble_ __y
));
265 # if defined __USE_MISC || defined __USE_XOPEN_EXTENDED
266 /* Return X times (2 to the Nth power). */
267 __MATHCALL (scalb
,, (_Mdouble_ __x
, _Mdouble_ __n
));
270 /* Return X times (2 to the Nth power). */
271 __MATHCALL (scalbn
,, (_Mdouble_ __x
, int __n
));
273 /* Return the binary exponent of X, which must be nonzero. */
274 __MATHDECL (int,ilogb
,, (_Mdouble_ __x
));
278 /* Return X times (2 to the Nth power). */
279 __MATHCALL (scalbln
,, (_Mdouble_ __x
, long int __n
));
281 /* Round X to integral value in floating-point format using current
282 rounding direction, but do not raise inexact exception. */
283 __MATHCALL (nearbyint
,, (_Mdouble_ __x
));
285 /* Round X to nearest integral value, rounding halfway cases away from
287 __MATHCALL (round
,, (_Mdouble_ __x
));
289 /* Round X to the integral value in floating-point format nearest but
290 not larger in magnitude. */
291 __MATHCALLX (trunc
,, (_Mdouble_ __x
), (__const__
));
293 /* Compute remainder of X and Y and put in *QUO a value with sign of x/y
294 and magnitude congruent `mod 2^n' to the magnitude of the integral
295 quotient x/y, with n >= 3. */
296 __MATHCALL (remquo
,, (_Mdouble_ __x
, _Mdouble_ __y
, int *__quo
));
299 /* Conversion functions. */
301 /* Round X to nearest integral value according to current rounding
303 __MATHDECL (long int,lrint
,, (_Mdouble_ __x
));
304 __MATHDECL (long long int,llrint
,, (_Mdouble_ __x
));
306 /* Round X to nearest integral value, rounding halfway cases away from
308 __MATHDECL (long int,lround
,, (_Mdouble_ __x
));
309 __MATHDECL (long long int,llround
,, (_Mdouble_ __x
));
312 /* Return positive difference between X and Y. */
313 __MATHCALL (fdim
,, (_Mdouble_ __x
, _Mdouble_ __y
));
315 /* Return maximum numeric value from X and Y. */
316 __MATHCALL (fmax
,, (_Mdouble_ __x
, _Mdouble_ __y
));
318 /* Return minimum numeric value from X and Y. */
319 __MATHCALL (fmin
,, (_Mdouble_ __x
, _Mdouble_ __y
));
322 /* Classify given number. */
323 __MATHDECL_1 (int, __fpclassify
,, (_Mdouble_ __value
))
324 __attribute__ ((__const__
));
326 /* Test for negative number. */
327 __MATHDECL_1 (int, __signbit
,, (_Mdouble_ __value
))
328 __attribute__ ((__const__
));
331 /* Multiply-add function computed as a ternary operation. */
332 __MATHCALL (fma
,, (_Mdouble_ __x
, _Mdouble_ __y
, _Mdouble_ __z
));
333 #endif /* Use ISO C 9X. */