Mon Jun 24 19:57:01 1996 Roland McGrath <roland@delasyd.gnu.ai.mit.edu>
[kopensolaris-gnu/glibc.git] / math / mathcalls.h
1 /* Prototype declarations for math functions; helper file for <math.h>.
2 Copyright (C) 1996 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
17 not, write to the Free Software Foundation, Inc., 675 Mass Ave,
18 Cambridge, MA 02139, 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 #ifndef _MATH_H
44  #error "Never include mathcalls.h directly; include <math.h> instead."
45 #endif
46
47
48 /* Trigonometric functions.  */
49
50 /* Arc cosine of X.  */
51 __MATHCALL (acos,, (_Mdouble_ __x));
52 /* Arc sine of X.  */
53 __MATHCALL (asin,, (_Mdouble_ __x));
54 /* Arc tangent of X.  */
55 __MATHCALL (atan,, (_Mdouble_ __x));
56 /* Arc tangent of Y/X.  */
57 __MATHCALL (atan2,, (_Mdouble_ __y, _Mdouble_ __x));
58
59 /* Cosine of X.  */
60 __MATHCALL (cos,, (_Mdouble_ __x));
61 /* Sine of X.  */
62 __MATHCALL (sin,, (_Mdouble_ __x));
63 /* Tangent of X.  */
64 __MATHCALL (tan,, (_Mdouble_ __x));
65
66
67 /* Hyperbolic functions.  */
68
69 /* Hyperbolic cosine of X.  */
70 __MATHCALL (cosh,, (_Mdouble_ __x));
71 /* Hyperbolic sine of X.  */
72 __MATHCALL (sinh,, (_Mdouble_ __x));
73 /* Hyperbolic tangent of X.  */
74 __MATHCALL (tanh,, (_Mdouble_ __x));
75
76 #ifdef  __USE_MISC
77 /* Hyperbolic arc cosine of X.  */
78 __MATHCALL (acosh,, (_Mdouble_ __x));
79 /* Hyperbolic arc sine of X.  */
80 __MATHCALL (asinh,, (_Mdouble_ __x));
81 /* Hyperbolic arc tangent of X.  */
82 __MATHCALL (atanh,, (_Mdouble_ __x));
83 #endif
84
85 /* Exponential and logarithmic functions.  */
86
87 /* Exponentional function of X.  */
88 __MATHCALL (exp,, (_Mdouble_ __x));
89
90 /* Break VALUE into a normalized fraction and an integral power of 2.  */
91 __MATHCALL (frexp,, (_Mdouble_ __value, int *__exp));
92
93 /* X times (two to the EXP power).  */
94 __MATHCALL (ldexp,, (_Mdouble_ __x, int __exp));
95
96 /* Natural logarithm of X.  */
97 __MATHCALL (log,, (_Mdouble_ __x));
98
99 /* Base-ten logarithm of X.  */
100 __MATHCALL (log10,, (_Mdouble_ __x));
101
102 #ifdef  __USE_MISC
103 /* Return exp(X) - 1.  */
104 __MATHCALL (expm1,, (_Mdouble_ __x));
105
106 /* Return log(1 + X).  */
107 __MATHCALL (log1p,, (_Mdouble_ __x));
108 #endif
109
110 /* Break VALUE into integral and fractional parts.  */
111 __MATHCALL (modf,, (_Mdouble_ __value, _Mdouble_ *__iptr));
112
113
114 /* Power functions.  */
115
116 /* Return X to the Y power.  */
117 __MATHCALL (pow,, (_Mdouble_ __x, _Mdouble_ __y));
118
119 /* Return the square root of X.  */
120 __MATHCALL (sqrt,, (_Mdouble_ __x));
121
122 #ifdef  __USE_MISC
123 /* Return the cube root of X.  */
124 __MATHCALL (cbrt,, (_Mdouble_ __x));
125 #endif
126
127
128 /* Nearest integer, absolute value, and remainder functions.  */
129
130 /* Smallest integral value not less than X.  */
131 __MATHCALL (ceil,, (_Mdouble_ __x));
132
133 /* Absolute value of X.  */
134 __MATHCALL (fabs,, (_Mdouble_ __x));
135
136 /* Largest integer not greater than X.  */
137 __MATHCALL (floor,, (_Mdouble_ __x));
138
139 /* Floating-point modulo remainder of X/Y.  */
140 __MATHCALL (fmod,, (_Mdouble_ __x, _Mdouble_ __y));
141
142
143 #ifdef __USE_MISC
144
145 /* Return 0 if VALUE is finite or NaN, +1 if it
146    is +Infinity, -1 if it is -Infinity.  */
147 __MATHDECL (int, isinf,, (_Mdouble_ __value));
148
149 /* Return nonzero if VALUE is not a number.  */
150 __MATHDECL (int, isnan,, (_Mdouble_ __value));
151
152 /* Return nonzero if VALUE is finite and not NaN.  */
153 __MATHDECL (int, finite,, (_Mdouble_ __value));
154
155 /* Deal with an infinite or NaN result.
156    If ERROR is ERANGE, result is +Inf;
157    if ERROR is - ERANGE, result is -Inf;
158    otherwise result is NaN.
159    This will set `errno' to either ERANGE or EDOM,
160    and may return an infinity or NaN, or may do something else.  */
161 __MATHCALL (infnan,, (int __error));
162
163 /* Return X with its signed changed to Y's.  */
164 __MATHCALL (copysign,, (_Mdouble_ __x, _Mdouble_ __y));
165
166 /* Return X times (2 to the Nth power).  */
167 __MATHCALL (scalb,, (_Mdouble_ __x, _Mdouble_ __n));
168
169 /* Return X times (2 to the Nth power).  */
170 __MATHCALL (scalbn,, (_Mdouble_ __x, int __n));
171
172 /* Return the remainder of X/Y.  */
173 __MATHCALL (drem,, (_Mdouble_ __x, _Mdouble_ __y));
174
175 /* Return the base 2 signed integral exponent of X.  */
176 __MATHCALL (logb,, (_Mdouble_ __x));
177
178 /* Return the integer nearest X in the direction of the
179    prevailing rounding mode.  */
180 __MATHCALL (rint,, (_Mdouble_ __x));
181
182 /* Return `sqrt(X*X + Y*Y)'.  */
183 __MATHCALL (hypot,, (_Mdouble_ __x, _Mdouble_ __y));
184
185 struct __MATH_PRECNAME(__cabs_complex,)
186 {
187   _Mdouble_ x, y;
188 };
189
190 /* Return `sqrt(X*X + Y*Y)'.  */
191 __MATHCALL (cabs,, (struct __MATH_PRECNAME(__cabs_complex,)));
192
193
194 /* Return X + epsilon if X < Y, X - epsilon if X > Y.  */
195 __MATHCALL (nextafter,, (_Mdouble_ __x, _Mdouble_ __y));
196
197 /* Return the remainder of integer divison X / Y with infinite precision.  */
198 __MATHCALL (remainder,, (_Mdouble_ __x, _Mdouble_ __y));
199
200 /* Return the binary exponent of X, which must be nonzero.  */
201 __MATHDECL (int, ilogb,, (_Mdouble_ __x));
202
203 /* Return the fractional part of X after dividing out `ilogb (X)'.  */
204 __MATHCALL (significand,, (_Mdouble_ __x));
205
206
207
208 /* Error, gamma, and Bessel functions.  */
209 __MATHCALL (erf,, (_Mdouble_));
210 __MATHCALL (erfc,, (_Mdouble_));
211 __MATHCALL (gamma,, (_Mdouble_));
212 __MATHCALL (j0,, (_Mdouble_));
213 __MATHCALL (j1,, (_Mdouble_));
214 __MATHCALL (jn,, (int, _Mdouble_));
215 __MATHCALL (lgamma,, (_Mdouble_));
216 __MATHCALL (y0,, (_Mdouble_));
217 __MATHCALL (y1,, (_Mdouble_));
218 __MATHCALL (yn,, (int, _Mdouble_));
219
220 /* This variable is used by `gamma' and `lgamma'.  */
221 extern int signgam;
222
223 #ifdef __USE_REENTRANT
224
225 /* Reentrant versions of gamma and lgamma.  Those functions use the global
226    variable `signgam'.  The reentrant versions instead take a pointer and
227    store the value through it.  */
228 __MATHCALL (gamma,_r, (_Mdouble_, int *));
229 __MATHCALL (lgamma,_r, (_Mdouble_, int *));
230 #endif
231
232 #endif /* Use misc.  */