mathcalls.h 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452
  1. /* Prototype declarations for math functions; helper file for <math.h>.
  2. Copyright (C) 1996-2017 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, see
  14. <http://www.gnu.org/licenses/>. */
  15. /* NOTE: Because of the special way this file is used by <math.h>, this
  16. file must NOT be protected from multiple inclusion as header files
  17. usually are.
  18. This file provides prototype declarations for the math functions.
  19. Most functions are declared using the macro:
  20. __MATHCALL (NAME,[_r], (ARGS...));
  21. This means there is a function `NAME' returning `double' and a function
  22. `NAMEf' returning `float'. Each place `_Mdouble_' appears in the
  23. prototype, that is actually `double' in the prototype for `NAME' and
  24. `float' in the prototype for `NAMEf'. Reentrant variant functions are
  25. called `NAME_r' and `NAMEf_r'.
  26. Functions returning other types like `int' are declared using the macro:
  27. __MATHDECL (TYPE, NAME,[_r], (ARGS...));
  28. This is just like __MATHCALL but for a function returning `TYPE'
  29. instead of `_Mdouble_'. In all of these cases, there is still
  30. both a `NAME' and a `NAMEf' that takes `float' arguments.
  31. Note that there must be no whitespace before the argument passed for
  32. NAME, to make token pasting work with -traditional. */
  33. #ifndef _MATH_H
  34. # error "Never include <bits/mathcalls.h> directly; include <math.h> instead."
  35. #endif
  36. /* Trigonometric functions. */
  37. _Mdouble_BEGIN_NAMESPACE
  38. /* Arc cosine of X. */
  39. __MATHCALL (acos,, (_Mdouble_ __x));
  40. /* Arc sine of X. */
  41. __MATHCALL (asin,, (_Mdouble_ __x));
  42. /* Arc tangent of X. */
  43. __MATHCALL (atan,, (_Mdouble_ __x));
  44. /* Arc tangent of Y/X. */
  45. __MATHCALL (atan2,, (_Mdouble_ __y, _Mdouble_ __x));
  46. /* Cosine of X. */
  47. __MATHCALL_VEC (cos,, (_Mdouble_ __x));
  48. /* Sine of X. */
  49. __MATHCALL_VEC (sin,, (_Mdouble_ __x));
  50. /* Tangent of X. */
  51. __MATHCALL (tan,, (_Mdouble_ __x));
  52. /* Hyperbolic functions. */
  53. /* Hyperbolic cosine of X. */
  54. __MATHCALL (cosh,, (_Mdouble_ __x));
  55. /* Hyperbolic sine of X. */
  56. __MATHCALL (sinh,, (_Mdouble_ __x));
  57. /* Hyperbolic tangent of X. */
  58. __MATHCALL (tanh,, (_Mdouble_ __x));
  59. _Mdouble_END_NAMESPACE
  60. #ifdef __USE_GNU
  61. /* Cosine and sine of X. */
  62. __MATHDECL_VEC (void,sincos,,
  63. (_Mdouble_ __x, _Mdouble_ *__sinx, _Mdouble_ *__cosx));
  64. #endif
  65. #if defined __USE_XOPEN_EXTENDED || defined __USE_ISOC99
  66. __BEGIN_NAMESPACE_C99
  67. /* Hyperbolic arc cosine of X. */
  68. __MATHCALL (acosh,, (_Mdouble_ __x));
  69. /* Hyperbolic arc sine of X. */
  70. __MATHCALL (asinh,, (_Mdouble_ __x));
  71. /* Hyperbolic arc tangent of X. */
  72. __MATHCALL (atanh,, (_Mdouble_ __x));
  73. __END_NAMESPACE_C99
  74. #endif
  75. /* Exponential and logarithmic functions. */
  76. _Mdouble_BEGIN_NAMESPACE
  77. /* Exponential function of X. */
  78. __MATHCALL_VEC (exp,, (_Mdouble_ __x));
  79. /* Break VALUE into a normalized fraction and an integral power of 2. */
  80. __MATHCALL (frexp,, (_Mdouble_ __x, int *__exponent));
  81. /* X times (two to the EXP power). */
  82. __MATHCALL (ldexp,, (_Mdouble_ __x, int __exponent));
  83. /* Natural logarithm of X. */
  84. __MATHCALL_VEC (log,, (_Mdouble_ __x));
  85. /* Base-ten logarithm of X. */
  86. __MATHCALL (log10,, (_Mdouble_ __x));
  87. /* Break VALUE into integral and fractional parts. */
  88. __MATHCALL (modf,, (_Mdouble_ __x, _Mdouble_ *__iptr)) __nonnull ((2));
  89. _Mdouble_END_NAMESPACE
  90. #if __GLIBC_USE (IEC_60559_FUNCS_EXT)
  91. /* Compute exponent to base ten. */
  92. __MATHCALL (exp10,, (_Mdouble_ __x));
  93. #endif
  94. #ifdef __USE_GNU
  95. /* Another name occasionally used. */
  96. __MATHCALL (pow10,, (_Mdouble_ __x));
  97. #endif
  98. #if defined __USE_XOPEN_EXTENDED || defined __USE_ISOC99
  99. __BEGIN_NAMESPACE_C99
  100. /* Return exp(X) - 1. */
  101. __MATHCALL (expm1,, (_Mdouble_ __x));
  102. /* Return log(1 + X). */
  103. __MATHCALL (log1p,, (_Mdouble_ __x));
  104. /* Return the base 2 signed integral exponent of X. */
  105. __MATHCALL (logb,, (_Mdouble_ __x));
  106. __END_NAMESPACE_C99
  107. #endif
  108. #ifdef __USE_ISOC99
  109. __BEGIN_NAMESPACE_C99
  110. /* Compute base-2 exponential of X. */
  111. __MATHCALL (exp2,, (_Mdouble_ __x));
  112. /* Compute base-2 logarithm of X. */
  113. __MATHCALL (log2,, (_Mdouble_ __x));
  114. __END_NAMESPACE_C99
  115. #endif
  116. /* Power functions. */
  117. _Mdouble_BEGIN_NAMESPACE
  118. /* Return X to the Y power. */
  119. __MATHCALL_VEC (pow,, (_Mdouble_ __x, _Mdouble_ __y));
  120. /* Return the square root of X. */
  121. __MATHCALL (sqrt,, (_Mdouble_ __x));
  122. _Mdouble_END_NAMESPACE
  123. #if defined __USE_XOPEN || defined __USE_ISOC99
  124. __BEGIN_NAMESPACE_C99
  125. /* Return `sqrt(X*X + Y*Y)'. */
  126. __MATHCALL (hypot,, (_Mdouble_ __x, _Mdouble_ __y));
  127. __END_NAMESPACE_C99
  128. #endif
  129. #if defined __USE_XOPEN_EXTENDED || defined __USE_ISOC99
  130. __BEGIN_NAMESPACE_C99
  131. /* Return the cube root of X. */
  132. __MATHCALL (cbrt,, (_Mdouble_ __x));
  133. __END_NAMESPACE_C99
  134. #endif
  135. /* Nearest integer, absolute value, and remainder functions. */
  136. _Mdouble_BEGIN_NAMESPACE
  137. /* Smallest integral value not less than X. */
  138. __MATHCALLX (ceil,, (_Mdouble_ __x), (__const__));
  139. /* Absolute value of X. */
  140. __MATHCALLX (fabs,, (_Mdouble_ __x), (__const__));
  141. /* Largest integer not greater than X. */
  142. __MATHCALLX (floor,, (_Mdouble_ __x), (__const__));
  143. /* Floating-point modulo remainder of X/Y. */
  144. __MATHCALL (fmod,, (_Mdouble_ __x, _Mdouble_ __y));
  145. /* Return 0 if VALUE is finite or NaN, +1 if it
  146. is +Infinity, -1 if it is -Infinity. */
  147. __MATHDECL_1 (int,__isinf,, (_Mdouble_ __value)) __attribute__ ((__const__));
  148. /* Return nonzero if VALUE is finite and not NaN. */
  149. __MATHDECL_1 (int,__finite,, (_Mdouble_ __value)) __attribute__ ((__const__));
  150. _Mdouble_END_NAMESPACE
  151. #ifdef __USE_MISC
  152. # if (!defined __cplusplus \
  153. || __cplusplus < 201103L /* isinf conflicts with C++11. */ \
  154. || __MATH_DECLARING_DOUBLE == 0) /* isinff or isinfl don't. */
  155. /* Return 0 if VALUE is finite or NaN, +1 if it
  156. is +Infinity, -1 if it is -Infinity. */
  157. __MATHDECL_1 (int,isinf,, (_Mdouble_ __value)) __attribute__ ((__const__));
  158. # endif
  159. /* Return nonzero if VALUE is finite and not NaN. */
  160. __MATHDECL_1 (int,finite,, (_Mdouble_ __value)) __attribute__ ((__const__));
  161. /* Return the remainder of X/Y. */
  162. __MATHCALL (drem,, (_Mdouble_ __x, _Mdouble_ __y));
  163. /* Return the fractional part of X after dividing out `ilogb (X)'. */
  164. __MATHCALL (significand,, (_Mdouble_ __x));
  165. #endif /* Use misc. */
  166. #ifdef __USE_ISOC99
  167. __BEGIN_NAMESPACE_C99
  168. /* Return X with its signed changed to Y's. */
  169. __MATHCALLX (copysign,, (_Mdouble_ __x, _Mdouble_ __y), (__const__));
  170. __END_NAMESPACE_C99
  171. #endif
  172. #ifdef __USE_ISOC99
  173. __BEGIN_NAMESPACE_C99
  174. /* Return representation of qNaN for double type. */
  175. __MATHCALLX (nan,, (const char *__tagb), (__const__));
  176. __END_NAMESPACE_C99
  177. #endif
  178. /* Return nonzero if VALUE is not a number. */
  179. __MATHDECL_1 (int,__isnan,, (_Mdouble_ __value)) __attribute__ ((__const__));
  180. #if defined __USE_MISC || (defined __USE_XOPEN && !defined __USE_XOPEN2K)
  181. # if (!defined __cplusplus \
  182. || __cplusplus < 201103L /* isnan conflicts with C++11. */ \
  183. || __MATH_DECLARING_DOUBLE == 0) /* isnanf or isnanl don't. */
  184. /* Return nonzero if VALUE is not a number. */
  185. __MATHDECL_1 (int,isnan,, (_Mdouble_ __value)) __attribute__ ((__const__));
  186. # endif
  187. #endif
  188. #if defined __USE_MISC || (defined __USE_XOPEN && __MATH_DECLARING_DOUBLE)
  189. /* Bessel functions. */
  190. __MATHCALL (j0,, (_Mdouble_));
  191. __MATHCALL (j1,, (_Mdouble_));
  192. __MATHCALL (jn,, (int, _Mdouble_));
  193. __MATHCALL (y0,, (_Mdouble_));
  194. __MATHCALL (y1,, (_Mdouble_));
  195. __MATHCALL (yn,, (int, _Mdouble_));
  196. #endif
  197. #if defined __USE_XOPEN || defined __USE_ISOC99
  198. __BEGIN_NAMESPACE_C99
  199. /* Error and gamma functions. */
  200. __MATHCALL (erf,, (_Mdouble_));
  201. __MATHCALL (erfc,, (_Mdouble_));
  202. __MATHCALL (lgamma,, (_Mdouble_));
  203. __END_NAMESPACE_C99
  204. #endif
  205. #ifdef __USE_ISOC99
  206. __BEGIN_NAMESPACE_C99
  207. /* True gamma function. */
  208. __MATHCALL (tgamma,, (_Mdouble_));
  209. __END_NAMESPACE_C99
  210. #endif
  211. #if defined __USE_MISC || (defined __USE_XOPEN && !defined __USE_XOPEN2K)
  212. /* Obsolete alias for `lgamma'. */
  213. __MATHCALL (gamma,, (_Mdouble_));
  214. #endif
  215. #ifdef __USE_MISC
  216. /* Reentrant version of lgamma. This function uses the global variable
  217. `signgam'. The reentrant version instead takes a pointer and stores
  218. the value through it. */
  219. __MATHCALL (lgamma,_r, (_Mdouble_, int *__signgamp));
  220. #endif
  221. #if defined __USE_XOPEN_EXTENDED || defined __USE_ISOC99
  222. __BEGIN_NAMESPACE_C99
  223. /* Return the integer nearest X in the direction of the
  224. prevailing rounding mode. */
  225. __MATHCALL (rint,, (_Mdouble_ __x));
  226. /* Return X + epsilon if X < Y, X - epsilon if X > Y. */
  227. __MATHCALLX (nextafter,, (_Mdouble_ __x, _Mdouble_ __y), (__const__));
  228. # if defined __USE_ISOC99 && !defined __LDBL_COMPAT
  229. __MATHCALLX (nexttoward,, (_Mdouble_ __x, long double __y), (__const__));
  230. # endif
  231. #if __GLIBC_USE (IEC_60559_BFP_EXT)
  232. /* Return X - epsilon. */
  233. __MATHCALL (nextdown,, (_Mdouble_ __x));
  234. /* Return X + epsilon. */
  235. __MATHCALL (nextup,, (_Mdouble_ __x));
  236. # endif
  237. /* Return the remainder of integer divison X / Y with infinite precision. */
  238. __MATHCALL (remainder,, (_Mdouble_ __x, _Mdouble_ __y));
  239. # ifdef __USE_ISOC99
  240. /* Return X times (2 to the Nth power). */
  241. __MATHCALL (scalbn,, (_Mdouble_ __x, int __n));
  242. # endif
  243. /* Return the binary exponent of X, which must be nonzero. */
  244. __MATHDECL (int,ilogb,, (_Mdouble_ __x));
  245. #endif
  246. #if __GLIBC_USE (IEC_60559_BFP_EXT)
  247. /* Like ilogb, but returning long int. */
  248. __MATHDECL (long int, llogb,, (_Mdouble_ __x));
  249. #endif
  250. #ifdef __USE_ISOC99
  251. /* Return X times (2 to the Nth power). */
  252. __MATHCALL (scalbln,, (_Mdouble_ __x, long int __n));
  253. /* Round X to integral value in floating-point format using current
  254. rounding direction, but do not raise inexact exception. */
  255. __MATHCALL (nearbyint,, (_Mdouble_ __x));
  256. /* Round X to nearest integral value, rounding halfway cases away from
  257. zero. */
  258. __MATHCALLX (round,, (_Mdouble_ __x), (__const__));
  259. /* Round X to the integral value in floating-point format nearest but
  260. not larger in magnitude. */
  261. __MATHCALLX (trunc,, (_Mdouble_ __x), (__const__));
  262. /* Compute remainder of X and Y and put in *QUO a value with sign of x/y
  263. and magnitude congruent `mod 2^n' to the magnitude of the integral
  264. quotient x/y, with n >= 3. */
  265. __MATHCALL (remquo,, (_Mdouble_ __x, _Mdouble_ __y, int *__quo));
  266. /* Conversion functions. */
  267. /* Round X to nearest integral value according to current rounding
  268. direction. */
  269. __MATHDECL (long int,lrint,, (_Mdouble_ __x));
  270. __extension__
  271. __MATHDECL (long long int,llrint,, (_Mdouble_ __x));
  272. /* Round X to nearest integral value, rounding halfway cases away from
  273. zero. */
  274. __MATHDECL (long int,lround,, (_Mdouble_ __x));
  275. __extension__
  276. __MATHDECL (long long int,llround,, (_Mdouble_ __x));
  277. /* Return positive difference between X and Y. */
  278. __MATHCALL (fdim,, (_Mdouble_ __x, _Mdouble_ __y));
  279. /* Return maximum numeric value from X and Y. */
  280. __MATHCALLX (fmax,, (_Mdouble_ __x, _Mdouble_ __y), (__const__));
  281. /* Return minimum numeric value from X and Y. */
  282. __MATHCALLX (fmin,, (_Mdouble_ __x, _Mdouble_ __y), (__const__));
  283. /* Classify given number. */
  284. __MATHDECL_1 (int, __fpclassify,, (_Mdouble_ __value))
  285. __attribute__ ((__const__));
  286. /* Test for negative number. */
  287. __MATHDECL_1 (int, __signbit,, (_Mdouble_ __value))
  288. __attribute__ ((__const__));
  289. /* Multiply-add function computed as a ternary operation. */
  290. __MATHCALL (fma,, (_Mdouble_ __x, _Mdouble_ __y, _Mdouble_ __z));
  291. #endif /* Use ISO C99. */
  292. #if defined __USE_XOPEN_EXTENDED || defined __USE_ISOC99
  293. __END_NAMESPACE_C99
  294. #endif
  295. #if __GLIBC_USE (IEC_60559_BFP_EXT)
  296. /* Round X to nearest integer value, rounding halfway cases to even. */
  297. __MATHCALLX (roundeven,, (_Mdouble_ __x), (__const__));
  298. /* Round X to nearest signed integer value, not raising inexact, with
  299. control of rounding direction and width of result. */
  300. __MATHDECL (__intmax_t, fromfp,, (_Mdouble_ __x, int __round,
  301. unsigned int __width));
  302. /* Round X to nearest unsigned integer value, not raising inexact,
  303. with control of rounding direction and width of result. */
  304. __MATHDECL (__uintmax_t, ufromfp,, (_Mdouble_ __x, int __round,
  305. unsigned int __width));
  306. /* Round X to nearest signed integer value, raising inexact for
  307. non-integers, with control of rounding direction and width of
  308. result. */
  309. __MATHDECL (__intmax_t, fromfpx,, (_Mdouble_ __x, int __round,
  310. unsigned int __width));
  311. /* Round X to nearest unsigned integer value, raising inexact for
  312. non-integers, with control of rounding direction and width of
  313. result. */
  314. __MATHDECL (__uintmax_t, ufromfpx,, (_Mdouble_ __x, int __round,
  315. unsigned int __width));
  316. /* Return value with maximum magnitude. */
  317. __MATHCALLX (fmaxmag,, (_Mdouble_ __x, _Mdouble_ __y), (__const__));
  318. /* Return value with minimum magnitude. */
  319. __MATHCALLX (fminmag,, (_Mdouble_ __x, _Mdouble_ __y), (__const__));
  320. /* Test equality. */
  321. __MATHDECL_1 (int, __iseqsig,, (_Mdouble_ __x, _Mdouble_ __y));
  322. /* Test for signaling NaN. */
  323. __MATHDECL_1 (int, __issignaling,, (_Mdouble_ __value))
  324. __attribute__ ((__const__));
  325. /* Total order operation. */
  326. __MATHDECL_1 (int, totalorder,, (_Mdouble_ __x, _Mdouble_ __y))
  327. __attribute__ ((__const__));
  328. /* Total order operation on absolute values. */
  329. __MATHDECL_1 (int, totalordermag,, (_Mdouble_ __x, _Mdouble_ __y))
  330. __attribute__ ((__const__));
  331. /* Canonicalize floating-point representation. */
  332. __MATHDECL_1 (int, canonicalize,, (_Mdouble_ *__cx, const _Mdouble_ *__x));
  333. /* Get NaN payload. */
  334. __MATHCALL (getpayload,, (const _Mdouble_ *__x));
  335. /* Set quiet NaN payload. */
  336. __MATHDECL_1 (int, setpayload,, (_Mdouble_ *__x, _Mdouble_ __payload));
  337. /* Set signaling NaN payload. */
  338. __MATHDECL_1 (int, setpayloadsig,, (_Mdouble_ *__x, _Mdouble_ __payload));
  339. #endif
  340. #if defined __USE_MISC || (defined __USE_XOPEN_EXTENDED \
  341. && __MATH_DECLARING_DOUBLE \
  342. && !defined __USE_XOPEN2K8)
  343. /* Return X times (2 to the Nth power). */
  344. __MATHCALL (scalb,, (_Mdouble_ __x, _Mdouble_ __n));
  345. #endif