1/* Prototype declarations for math functions; helper file for <math.h>.
2   Copyright (C) 1996,1997,1998,1999,2000,2001 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 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.
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   Lesser General Public License for more details.
14
15   You should have received a copy of the GNU Lesser General Public
16   License along with the GNU C Library; if not, write to the Free
17   Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
18   02111-1307 USA.  */
19
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
22   usually are.
23
24   This file provides prototype declarations for the math functions.
25   Most functions are declared using the macro:
26
27   __MATHCALL (NAME,[_r], (ARGS...));
28
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'.
34
35   Functions returning other types like `int' are declared using the macro:
36
37   __MATHDECL (TYPE, NAME,[_r], (ARGS...));
38
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.
42
43   Note that there must be no whitespace before the argument passed for
44   NAME, to make token pasting work with -traditional.  */
45
46#ifndef _MATH_H
47 #error "Never include <bits/mathcalls.h> directly; include <math.h> instead."
48#endif
49
50
51/* Trigonometric functions.  */
52
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.  */
63__MATHCALL (cos,, (_Mdouble_ __x));
64/* Sine of X.  */
65__MATHCALL (sin,, (_Mdouble_ __x));
66/* Tangent of X.  */
67__MATHCALL (tan,, (_Mdouble_ __x));
68
69#ifdef __USE_GNU
70/* Cosine and sine of X.  */
71__MATHDECL (void,sincos,,
72	    (_Mdouble_ __x, _Mdouble_ *__sinx, _Mdouble_ *__cosx));
73#endif
74
75/* Hyperbolic functions.  */
76
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));
83
84#if defined __USE_MISC || defined __USE_XOPEN_EXTENDED || defined __USE_ISOC99
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));
91#endif
92
93/* Exponential and logarithmic functions.  */
94
95/* Exponential function of X.  */
96__MATHCALL (exp,, (_Mdouble_ __x));
97
98#ifdef __USE_GNU
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));
103#endif
104
105/* Break VALUE into a normalized fraction and an integral power of 2.  */
106__MATHCALL (frexp,, (_Mdouble_ __x, int *__exponent));
107
108/* X times (two to the EXP power).  */
109__MATHCALL (ldexp,, (_Mdouble_ __x, int __exponent));
110
111/* Natural logarithm of X.  */
112__MATHCALL (log,, (_Mdouble_ __x));
113
114/* Base-ten logarithm of X.  */
115__MATHCALL (log10,, (_Mdouble_ __x));
116
117/* Break VALUE into integral and fractional parts.  */
118__MATHCALL (modf,, (_Mdouble_ __x, _Mdouble_ *__iptr));
119
120#if defined __USE_MISC || defined __USE_XOPEN_EXTENDED || defined __USE_ISOC99
121/* Return exp(X) - 1.  */
122__MATHCALL (expm1,, (_Mdouble_ __x));
123
124/* Return log(1 + X).  */
125__MATHCALL (log1p,, (_Mdouble_ __x));
126
127/* Return the base 2 signed integral exponent of X.  */
128__MATHCALL (logb,, (_Mdouble_ __x));
129#endif
130
131#ifdef __USE_ISOC99
132/* Compute base-2 exponential of X.  */
133__MATHCALL (exp2,, (_Mdouble_ __x));
134
135/* Compute base-2 logarithm of X.  */
136__MATHCALL (log2,, (_Mdouble_ __x));
137#endif
138
139
140/* Power functions.  */
141
142/* Return X to the Y power.  */
143__MATHCALL (pow,, (_Mdouble_ __x, _Mdouble_ __y));
144
145/* Return the square root of X.  */
146__MATHCALL (sqrt,, (_Mdouble_ __x));
147
148#if defined __USE_MISC || defined __USE_XOPEN || defined __USE_ISOC99
149/* Return `sqrt(X*X + Y*Y)'.  */
150__MATHCALL (hypot,, (_Mdouble_ __x, _Mdouble_ __y));
151#endif
152
153#if defined __USE_MISC || defined __USE_XOPEN_EXTENDED || defined __USE_ISOC99
154/* Return the cube root of X.  */
155__MATHCALL (cbrt,, (_Mdouble_ __x));
156#endif
157
158
159/* Nearest integer, absolute value, and remainder functions.  */
160
161/* Smallest integral value not less than X.  */
162__MATHCALL (ceil,, (_Mdouble_ __x));
163
164/* Absolute value of X.  */
165__MATHCALLX (fabs,, (_Mdouble_ __x), (__const__));
166
167/* Largest integer not greater than X.  */
168__MATHCALL (floor,, (_Mdouble_ __x));
169
170/* Floating-point modulo remainder of X/Y.  */
171__MATHCALL (fmod,, (_Mdouble_ __x, _Mdouble_ __y));
172
173
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__));
177
178/* Return nonzero if VALUE is finite and not NaN.  */
179__MATHDECL_1 (int,__finite,, (_Mdouble_ __value)) __attribute__ ((__const__));
180
181#ifdef __USE_MISC
182
183#ifndef __cplusplus
184/* Return 0 if VALUE is finite or NaN, +1 if it
185   is +Infinity, -1 if it is -Infinity.  */
186__MATHDECL_1 (int,isinf,, (_Mdouble_ __value)) __attribute__ ((__const__));
187#endif
188
189/* Return nonzero if VALUE is finite and not NaN.  */
190__MATHDECL_1 (int,finite,, (_Mdouble_ __value)) __attribute__ ((__const__));
191
192/* Return the remainder of X/Y.  */
193__MATHCALL (drem,, (_Mdouble_ __x, _Mdouble_ __y));
194
195
196/* Return the fractional part of X after dividing out `ilogb (X)'.  */
197__MATHCALL (significand,, (_Mdouble_ __x));
198#endif /* Use misc.  */
199
200#if defined __USE_MISC || defined __USE_ISOC99
201/* Return X with its signed changed to Y's.  */
202__MATHCALLX (copysign,, (_Mdouble_ __x, _Mdouble_ __y), (__const__));
203#endif
204
205#ifdef __USE_ISOC99
206/* Return representation of NaN for double type.  */
207__MATHCALLX (nan,, (__const char *__tagb), (__const__));
208#endif
209
210
211/* Return nonzero if VALUE is not a number.  */
212__MATHDECL_1 (int,__isnan,, (_Mdouble_ __value)) __attribute__ ((__const__));
213
214#if defined __USE_MISC || defined __USE_XOPEN
215
216#ifndef __cplusplus
217/* Return nonzero if VALUE is not a number.  */
218__MATHDECL_1 (int,isnan,, (_Mdouble_ __value)) __attribute__ ((__const__));
219#endif
220
221/* Bessel functions.  */
222__MATHCALL (j0,, (_Mdouble_));
223__MATHCALL (j1,, (_Mdouble_));
224__MATHCALL (jn,, (int, _Mdouble_));
225__MATHCALL (y0,, (_Mdouble_));
226__MATHCALL (y1,, (_Mdouble_));
227__MATHCALL (yn,, (int, _Mdouble_));
228#endif
229
230
231#if defined __USE_MISC || defined __USE_XOPEN || defined __USE_ISOC99
232/* Error and gamma functions.  */
233__MATHCALL (erf,, (_Mdouble_));
234__MATHCALL (erfc,, (_Mdouble_));
235__MATHCALL (lgamma,, (_Mdouble_));
236#endif
237
238#ifdef __USE_ISOC99
239__MATHCALL (tgamma,, (_Mdouble_));
240#endif
241
242#if defined __USE_MISC || defined __USE_XOPEN
243/* Obsolete alias for `lgamma'.  */
244__MATHCALL (gamma,, (_Mdouble_));
245#endif
246
247#ifdef __USE_MISC
248/* Reentrant version of lgamma.  This function uses the global variable
249   `signgam'.  The reentrant version instead takes a pointer and stores
250   the value through it.  */
251__MATHCALL (lgamma,_r, (_Mdouble_, int *__signgamp));
252#endif
253
254
255#if defined __USE_MISC || defined __USE_XOPEN_EXTENDED || defined __USE_ISOC99
256/* Return the integer nearest X in the direction of the
257   prevailing rounding mode.  */
258__MATHCALL (rint,, (_Mdouble_ __x));
259
260/* Return X + epsilon if X < Y, X - epsilon if X > Y.  */
261__MATHCALLX (nextafter,, (_Mdouble_ __x, _Mdouble_ __y), (__const__));
262# ifdef __USE_ISOC99
263__MATHCALLX (nexttoward,, (_Mdouble_ __x, long double __y), (__const__));
264# endif
265
266/* Return the remainder of integer divison X / Y with infinite precision.  */
267__MATHCALL (remainder,, (_Mdouble_ __x, _Mdouble_ __y));
268
269# if defined __USE_MISC || defined __USE_XOPEN_EXTENDED
270/* Return X times (2 to the Nth power).  */
271__MATHCALL (scalb,, (_Mdouble_ __x, _Mdouble_ __n));
272# endif
273
274# if defined __USE_MISC || defined __USE_ISOC99
275/* Return X times (2 to the Nth power).  */
276__MATHCALL (scalbn,, (_Mdouble_ __x, int __n));
277# endif
278
279/* Return the binary exponent of X, which must be nonzero.  */
280__MATHDECL (int,ilogb,, (_Mdouble_ __x));
281#endif
282
283#ifdef __USE_ISOC99
284/* Return X times (2 to the Nth power).  */
285__MATHCALL (scalbln,, (_Mdouble_ __x, long int __n));
286
287/* Round X to integral value in floating-point format using current
288   rounding direction, but do not raise inexact exception.  */
289__MATHCALL (nearbyint,, (_Mdouble_ __x));
290
291/* Round X to nearest integral value, rounding halfway cases away from
292   zero.  */
293__MATHCALL (round,, (_Mdouble_ __x));
294
295/* Round X to the integral value in floating-point format nearest but
296   not larger in magnitude.  */
297__MATHCALLX (trunc,, (_Mdouble_ __x), (__const__));
298
299/* Compute remainder of X and Y and put in *QUO a value with sign of x/y
300   and magnitude congruent `mod 2^n' to the magnitude of the integral
301   quotient x/y, with n >= 3.  */
302__MATHCALL (remquo,, (_Mdouble_ __x, _Mdouble_ __y, int *__quo));
303
304
305/* Conversion functions.  */
306
307/* Round X to nearest integral value according to current rounding
308   direction.  */
309__MATHDECL (long int,lrint,, (_Mdouble_ __x));
310__MATHDECL (long long int,llrint,, (_Mdouble_ __x));
311
312/* Round X to nearest integral value, rounding halfway cases away from
313   zero.  */
314__MATHDECL (long int,lround,, (_Mdouble_ __x));
315__MATHDECL (long long int,llround,, (_Mdouble_ __x));
316
317
318/* Return positive difference between X and Y.  */
319__MATHCALL (fdim,, (_Mdouble_ __x, _Mdouble_ __y));
320
321/* Return maximum numeric value from X and Y.  */
322__MATHCALL (fmax,, (_Mdouble_ __x, _Mdouble_ __y));
323
324/* Return minimum numeric value from X and Y.  */
325__MATHCALL (fmin,, (_Mdouble_ __x, _Mdouble_ __y));
326
327
328/* Classify given number.  */
329__MATHDECL_1 (int, __fpclassify,, (_Mdouble_ __value))
330     __attribute__ ((__const__));
331
332/* Test for negative number.  */
333__MATHDECL_1 (int, __signbit,, (_Mdouble_ __value))
334     __attribute__ ((__const__));
335
336
337/* Multiply-add function computed as a ternary operation.  */
338__MATHCALL (fma,, (_Mdouble_ __x, _Mdouble_ __y, _Mdouble_ __z));
339#endif /* Use ISO C99.  */
340