mathcalls.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365
  1. /* Prototype declarations for math functions; helper file for <math.h>.
  2. Copyright (C) 1996-2002, 2003, 2006 Free Software Foundation, Inc.
  3. This file is part of the GNU C Library.
  4. The GNU C Library is free software; you can redistribute it and/or
  5. modify it under the terms of the GNU Lesser General Public
  6. License as published by the Free Software Foundation; either
  7. version 2.1 of the License, or (at your option) any later version.
  8. The GNU C Library is distributed in the hope that it will be useful,
  9. but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  11. Lesser General Public License for more details.
  12. You should have received a copy of the GNU Lesser General Public
  13. License along with the GNU C Library; if not, write to the Free
  14. Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  15. 02111-1307 USA. */
  16. /* NOTE: Because of the special way this file is used by <math.h>, this
  17. file must NOT be protected from multiple inclusion as header files
  18. usually are.
  19. This file provides prototype declarations for the math functions.
  20. Most functions are declared using the macro:
  21. __MATHCALL (NAME,[_r], (ARGS...));
  22. This means there is a function `NAME' returning `double' and a function
  23. `NAMEf' returning `float'. Each place `_Mdouble_' appears in the
  24. prototype, that is actually `double' in the prototype for `NAME' and
  25. `float' in the prototype for `NAMEf'. Reentrant variant functions are
  26. called `NAME_r' and `NAMEf_r'.
  27. Functions returning other types like `int' are declared using the macro:
  28. __MATHDECL (TYPE, NAME,[_r], (ARGS...));
  29. This is just like __MATHCALL but for a function returning `TYPE'
  30. instead of `_Mdouble_'. In all of these cases, there is still
  31. both a `NAME' and a `NAMEf' that takes `float' arguments.
  32. Note that there must be no whitespace before the argument passed for
  33. NAME, to make token pasting work with -traditional. */
  34. #ifndef _MATH_H
  35. # error "Never include <bits/mathcalls.h> directly; include <math.h> instead."
  36. #endif
  37. /* Trigonometric functions. */
  38. _Mdouble_BEGIN_NAMESPACE
  39. /* Arc cosine of X. */
  40. __MATHCALL (acos,, (_Mdouble_ __x));
  41. /* Arc sine of X. */
  42. __MATHCALL (asin,, (_Mdouble_ __x));
  43. /* Arc tangent of X. */
  44. __MATHCALL (atan,, (_Mdouble_ __x));
  45. /* Arc tangent of Y/X. */
  46. __MATHCALL (atan2,, (_Mdouble_ __y, _Mdouble_ __x));
  47. /* Cosine of X. */
  48. __MATHCALL (cos,, (_Mdouble_ __x));
  49. /* Sine of X. */
  50. __MATHCALL (sin,, (_Mdouble_ __x));
  51. /* Tangent of X. */
  52. __MATHCALL (tan,, (_Mdouble_ __x));
  53. /* Hyperbolic functions. */
  54. /* Hyperbolic cosine of X. */
  55. __MATHCALL (cosh,, (_Mdouble_ __x));
  56. /* Hyperbolic sine of X. */
  57. __MATHCALL (sinh,, (_Mdouble_ __x));
  58. /* Hyperbolic tangent of X. */
  59. __MATHCALL (tanh,, (_Mdouble_ __x));
  60. _Mdouble_END_NAMESPACE
  61. #if 0 /*def __USE_GNU*/
  62. /* Cosine and sine of X. */
  63. __MATHDECL (void,sincos,,
  64. (_Mdouble_ __x, _Mdouble_ *__sinx, _Mdouble_ *__cosx));
  65. #endif
  66. #if defined __USE_MISC || defined __USE_XOPEN_EXTENDED || defined __USE_ISOC99
  67. __BEGIN_NAMESPACE_C99
  68. /* Hyperbolic arc cosine of X. */
  69. __MATHCALL (acosh,, (_Mdouble_ __x));
  70. /* Hyperbolic arc sine of X. */
  71. __MATHCALL (asinh,, (_Mdouble_ __x));
  72. /* Hyperbolic arc tangent of X. */
  73. __MATHCALL (atanh,, (_Mdouble_ __x));
  74. __END_NAMESPACE_C99
  75. #endif
  76. /* Exponential and logarithmic functions. */
  77. _Mdouble_BEGIN_NAMESPACE
  78. /* Exponential function of X. */
  79. __MATHCALL (exp,, (_Mdouble_ __x));
  80. /* Break VALUE into a normalized fraction and an integral power of 2. */
  81. __MATHCALL (frexp,, (_Mdouble_ __x, int *__exponent));
  82. /* X times (two to the EXP power). */
  83. __MATHCALL (ldexp,, (_Mdouble_ __x, int __exponent));
  84. /* Natural logarithm of X. */
  85. __MATHCALL (log,, (_Mdouble_ __x));
  86. /* Base-ten logarithm of X. */
  87. __MATHCALL (log10,, (_Mdouble_ __x));
  88. /* Break VALUE into integral and fractional parts. */
  89. __MATHCALL (modf,, (_Mdouble_ __x, _Mdouble_ *__iptr));
  90. _Mdouble_END_NAMESPACE
  91. #if 0 /*def __USE_GNU*/
  92. /* A function missing in all standards: compute exponent to base ten. */
  93. __MATHCALL (exp10,, (_Mdouble_ __x));
  94. /* Another name occasionally used. */
  95. __MATHCALL (pow10,, (_Mdouble_ __x));
  96. #endif
  97. #if defined __USE_MISC || defined __USE_XOPEN_EXTENDED || defined __USE_ISOC99
  98. __BEGIN_NAMESPACE_C99
  99. /* Return exp(X) - 1. */
  100. __MATHCALL (expm1,, (_Mdouble_ __x));
  101. /* Return log(1 + X). */
  102. __MATHCALL (log1p,, (_Mdouble_ __x));
  103. /* Return the base 2 signed integral exponent of X. */
  104. __MATHCALL (logb,, (_Mdouble_ __x));
  105. __END_NAMESPACE_C99
  106. #endif
  107. #ifdef __USE_ISOC99
  108. __BEGIN_NAMESPACE_C99
  109. /* Compute base-2 exponential of X. */
  110. __MATHCALL (exp2,, (_Mdouble_ __x));
  111. /* Compute base-2 logarithm of X. */
  112. __MATHCALL (log2,, (_Mdouble_ __x));
  113. __END_NAMESPACE_C99
  114. #endif
  115. /* Power functions. */
  116. _Mdouble_BEGIN_NAMESPACE
  117. /* Return X to the Y power. */
  118. __MATHCALL (pow,, (_Mdouble_ __x, _Mdouble_ __y));
  119. /* Return the square root of X. */
  120. __MATHCALL (sqrt,, (_Mdouble_ __x));
  121. _Mdouble_END_NAMESPACE
  122. #if defined __USE_MISC || defined __USE_XOPEN || defined __USE_ISOC99
  123. __BEGIN_NAMESPACE_C99
  124. /* Return `sqrt(X*X + Y*Y)'. */
  125. __MATHCALL (hypot,, (_Mdouble_ __x, _Mdouble_ __y));
  126. __END_NAMESPACE_C99
  127. #endif
  128. #if defined __USE_MISC || defined __USE_XOPEN_EXTENDED || defined __USE_ISOC99
  129. __BEGIN_NAMESPACE_C99
  130. /* Return the cube root of X. */
  131. __MATHCALL (cbrt,, (_Mdouble_ __x));
  132. __END_NAMESPACE_C99
  133. #endif
  134. /* Nearest integer, absolute value, and remainder functions. */
  135. _Mdouble_BEGIN_NAMESPACE
  136. /* Smallest integral value not less than X. */
  137. __MATHCALLX (ceil,, (_Mdouble_ __x), (__const__));
  138. /* Absolute value of X. */
  139. __MATHCALLX (fabs,, (_Mdouble_ __x), (__const__));
  140. /* Largest integer not greater than X. */
  141. __MATHCALLX (floor,, (_Mdouble_ __x), (__const__));
  142. /* Floating-point modulo remainder of X/Y. */
  143. __MATHCALL (fmod,, (_Mdouble_ __x, _Mdouble_ __y));
  144. /* Return 0 if VALUE is finite or NaN, +1 if it
  145. is +Infinity, -1 if it is -Infinity. */
  146. __MATHDECL_1 (int,__isinf,, (_Mdouble_ __value)) __attribute__ ((__const__));
  147. /* Return nonzero if VALUE is finite and not NaN. */
  148. __MATHDECL_1 (int,__finite,, (_Mdouble_ __value)) __attribute__ ((__const__));
  149. _Mdouble_END_NAMESPACE
  150. #ifdef __USE_MISC
  151. /* Return 0 if VALUE is finite or NaN, +1 if it
  152. is +Infinity, -1 if it is -Infinity. */
  153. __MATHDECL_1 (int,isinf,, (_Mdouble_ __value)) __attribute__ ((__const__));
  154. /* Return nonzero if VALUE is finite and not NaN. */
  155. __MATHDECL_1 (int,finite,, (_Mdouble_ __value)) __attribute__ ((__const__));
  156. /* Return the remainder of X/Y. */
  157. __MATHCALL (drem,, (_Mdouble_ __x, _Mdouble_ __y));
  158. /* Return the fractional part of X after dividing out `ilogb (X)'. */
  159. __MATHCALL (significand,, (_Mdouble_ __x));
  160. #endif /* Use misc. */
  161. #if defined __USE_MISC || defined __USE_ISOC99
  162. __BEGIN_NAMESPACE_C99
  163. /* Return X with its signed changed to Y's. */
  164. __MATHCALLX (copysign,, (_Mdouble_ __x, _Mdouble_ __y), (__const__));
  165. __END_NAMESPACE_C99
  166. #endif
  167. #ifdef __USE_ISOC99
  168. __BEGIN_NAMESPACE_C99
  169. /* Return representation of NaN for double type. */
  170. __MATHCALLX (nan,, (__const char *__tagb), (__const__));
  171. __END_NAMESPACE_C99
  172. #endif
  173. /* Return nonzero if VALUE is not a number. */
  174. __MATHDECL_1 (int,__isnan,, (_Mdouble_ __value)) __attribute__ ((__const__));
  175. #if defined __USE_MISC || defined __USE_XOPEN
  176. /* Return nonzero if VALUE is not a number. */
  177. __MATHDECL_1 (int,isnan,, (_Mdouble_ __value)) __attribute__ ((__const__));
  178. /* Bessel functions. */
  179. __MATHCALL (j0,, (_Mdouble_));
  180. __MATHCALL (j1,, (_Mdouble_));
  181. __MATHCALL (jn,, (int, _Mdouble_));
  182. __MATHCALL (y0,, (_Mdouble_));
  183. __MATHCALL (y1,, (_Mdouble_));
  184. __MATHCALL (yn,, (int, _Mdouble_));
  185. #endif
  186. #if defined __USE_MISC || defined __USE_XOPEN || defined __USE_ISOC99
  187. __BEGIN_NAMESPACE_C99
  188. /* Error and gamma functions. */
  189. __MATHCALL (erf,, (_Mdouble_));
  190. __MATHCALL (erfc,, (_Mdouble_));
  191. __MATHCALL (lgamma,, (_Mdouble_));
  192. __END_NAMESPACE_C99
  193. #endif
  194. #ifdef __USE_ISOC99
  195. __BEGIN_NAMESPACE_C99
  196. /* True gamma function. */
  197. __MATHCALL (tgamma,, (_Mdouble_));
  198. __END_NAMESPACE_C99
  199. #endif
  200. #if defined __USE_MISC || defined __USE_XOPEN
  201. /* Obsolete alias for `lgamma'. */
  202. __MATHCALL (gamma,, (_Mdouble_));
  203. #endif
  204. #ifdef __USE_MISC
  205. /* Reentrant version of lgamma. This function uses the global variable
  206. `signgam'. The reentrant version instead takes a pointer and stores
  207. the value through it. */
  208. __MATHCALL (lgamma,_r, (_Mdouble_, int *__signgamp));
  209. #endif
  210. #if defined __USE_MISC || defined __USE_XOPEN_EXTENDED || defined __USE_ISOC99
  211. __BEGIN_NAMESPACE_C99
  212. /* Return the integer nearest X in the direction of the
  213. prevailing rounding mode. */
  214. __MATHCALL (rint,, (_Mdouble_ __x));
  215. /* Return X + epsilon if X < Y, X - epsilon if X > Y. */
  216. __MATHCALLX (nextafter,, (_Mdouble_ __x, _Mdouble_ __y), (__const__));
  217. # if defined __USE_ISOC99 && !defined __LDBL_COMPAT
  218. __MATHCALLX (nexttoward,, (_Mdouble_ __x, long double __y), (__const__));
  219. # endif
  220. /* Return the remainder of integer divison X / Y with infinite precision. */
  221. __MATHCALL (remainder,, (_Mdouble_ __x, _Mdouble_ __y));
  222. # if defined __USE_MISC || defined __USE_ISOC99
  223. /* Return X times (2 to the Nth power). */
  224. __MATHCALL (scalbn,, (_Mdouble_ __x, int __n));
  225. # endif
  226. /* Return the binary exponent of X, which must be nonzero. */
  227. __MATHDECL (int,ilogb,, (_Mdouble_ __x));
  228. #endif
  229. #ifdef __USE_ISOC99
  230. /* Return X times (2 to the Nth power). */
  231. __MATHCALL (scalbln,, (_Mdouble_ __x, long int __n));
  232. /* Round X to integral value in floating-point format using current
  233. rounding direction, but do not raise inexact exception. */
  234. __MATHCALL (nearbyint,, (_Mdouble_ __x));
  235. /* Round X to nearest integral value, rounding halfway cases away from
  236. zero. */
  237. __MATHCALLX (round,, (_Mdouble_ __x), (__const__));
  238. /* Round X to the integral value in floating-point format nearest but
  239. not larger in magnitude. */
  240. __MATHCALLX (trunc,, (_Mdouble_ __x), (__const__));
  241. /* Compute remainder of X and Y and put in *QUO a value with sign of x/y
  242. and magnitude congruent `mod 2^n' to the magnitude of the integral
  243. quotient x/y, with n >= 3. */
  244. __MATHCALL (remquo,, (_Mdouble_ __x, _Mdouble_ __y, int *__quo));
  245. /* Conversion functions. */
  246. /* Round X to nearest integral value according to current rounding
  247. direction. */
  248. __MATHDECL (long int,lrint,, (_Mdouble_ __x));
  249. __MATHDECL (long long int,llrint,, (_Mdouble_ __x));
  250. /* Round X to nearest integral value, rounding halfway cases away from
  251. zero. */
  252. __MATHDECL (long int,lround,, (_Mdouble_ __x));
  253. __MATHDECL (long long int,llround,, (_Mdouble_ __x));
  254. /* Return positive difference between X and Y. */
  255. __MATHCALL (fdim,, (_Mdouble_ __x, _Mdouble_ __y));
  256. /* Return maximum numeric value from X and Y. */
  257. __MATHCALL (fmax,, (_Mdouble_ __x, _Mdouble_ __y));
  258. /* Return minimum numeric value from X and Y. */
  259. __MATHCALL (fmin,, (_Mdouble_ __x, _Mdouble_ __y));
  260. /* Classify given number. */
  261. __MATHDECL_1 (int, __fpclassify,, (_Mdouble_ __value))
  262. __attribute__ ((__const__));
  263. /* Test for negative number. */
  264. __MATHDECL_1 (int, __signbit,, (_Mdouble_ __value))
  265. __attribute__ ((__const__));
  266. /* Multiply-add function computed as a ternary operation. */
  267. __MATHCALL (fma,, (_Mdouble_ __x, _Mdouble_ __y, _Mdouble_ __z));
  268. #endif /* Use ISO C99. */
  269. #if defined __USE_MISC || defined __USE_XOPEN_EXTENDED || defined __USE_ISOC99
  270. __END_NAMESPACE_C99
  271. #endif
  272. #if defined __USE_MISC || defined __USE_XOPEN_EXTENDED
  273. /* Return X times (2 to the Nth power). */
  274. __MATHCALL (scalb,, (_Mdouble_ __x, _Mdouble_ __n));
  275. #endif