math.h 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489
  1. /* Declarations for math functions.
  2. Copyright (C) 1991-1993, 1995-1999, 2001, 2002, 2004, 2006
  3. Free Software Foundation, Inc.
  4. 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 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. The GNU C Library is distributed in the hope that it will be useful,
  10. but WITHOUT ANY WARRANTY; without even the implied warranty of
  11. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  12. Lesser General Public License for more details.
  13. You should have received a copy of the GNU Lesser General Public
  14. License along with the GNU C Library; if not, write to the Free
  15. Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  16. 02111-1307 USA. */
  17. /*
  18. * ISO C99 Standard: 7.12 Mathematics <math.h>
  19. */
  20. #ifndef _MATH_H
  21. #define _MATH_H 1
  22. #include <features.h>
  23. __BEGIN_DECLS
  24. /* Get machine-dependent HUGE_VAL value (returned on overflow).
  25. On all IEEE754 machines, this is +Infinity. */
  26. #include <bits/huge_val.h>
  27. #ifdef __USE_ISOC99
  28. # include <bits/huge_valf.h>
  29. # include <bits/huge_vall.h>
  30. /* Get machine-dependent INFINITY value. */
  31. # include <bits/inf.h>
  32. /* Get machine-dependent NAN value (returned for some domain errors). */
  33. # include <bits/nan.h>
  34. #endif /* __USE_ISOC99 */
  35. /* Get general and ISO C99 specific information. */
  36. #include <bits/mathdef.h>
  37. #if !(defined _LIBC && (defined NOT_IN_libc && defined IS_IN_libm))
  38. # define libm_hidden_proto(name, attrs...)
  39. #endif
  40. /* The file <bits/mathcalls.h> contains the prototypes for all the
  41. actual math functions. These macros are used for those prototypes,
  42. so we can easily declare each function as both `name' and `__name',
  43. and can declare the float versions `namef' and `__namef'. */
  44. #define __MATHCALL(function,suffix, args) \
  45. __MATHDECL (_Mdouble_,function,suffix, args)
  46. #define __MATHDECL(type, function,suffix, args) \
  47. __MATHDECL_1(type, function,suffix, args);
  48. #define __MATHCALLX(function,suffix, args, attrib) \
  49. __MATHDECLX (_Mdouble_,function,suffix, args, attrib)
  50. #define __MATHDECLX(type, function,suffix, args, attrib) \
  51. __MATHDECL_1(type, function,suffix, args) __attribute__ (attrib); \
  52. __MATHDECLI_MAINVARIANT(function)
  53. #define __MATHDECL_1(type, function,suffix, args) \
  54. extern type __MATH_PRECNAME(function,suffix) args __THROW
  55. /* Decls which are also used internally in libm.
  56. Only the main variant is used internally, no need to try to avoid relocs
  57. for the {l,f} variants. */
  58. #define __MATHCALLI(function,suffix, args) \
  59. __MATHDECLI (_Mdouble_,function,suffix, args)
  60. #define __MATHDECLI(type, function,suffix, args) \
  61. __MATHDECL_1(type, function,suffix, args); \
  62. __MATHDECLI_MAINVARIANT(function)
  63. /* Private helpers for purely macro impls below.
  64. Only make __foo{,f,l} visible but not (the macro-only) foo. */
  65. #define __MATHDECL_PRIV(type, function,suffix, args, attrib) \
  66. __MATHDECL_1(type, __CONCAT(__,function),suffix, args) \
  67. __attribute__ (attrib); \
  68. libm_hidden_proto(__MATH_PRECNAME(__##function,suffix))
  69. #define __MATHDECLI_MAINVARIANT libm_hidden_proto
  70. #define _Mdouble_ double
  71. #define __MATH_PRECNAME(name,r) __CONCAT(name,r)
  72. # define _Mdouble_BEGIN_NAMESPACE __BEGIN_NAMESPACE_STD
  73. # define _Mdouble_END_NAMESPACE __END_NAMESPACE_STD
  74. #include <bits/mathcalls.h>
  75. #undef _Mdouble_
  76. #undef _Mdouble_BEGIN_NAMESPACE
  77. #undef _Mdouble_END_NAMESPACE
  78. #undef __MATH_PRECNAME
  79. #undef __MATHDECLI_MAINVARIANT
  80. #define __MATHDECLI_MAINVARIANT(x)
  81. #if defined __USE_MISC || defined __USE_ISOC99
  82. /* Include the file of declarations again, this time using `float'
  83. instead of `double' and appending f to each function name. */
  84. # ifndef _Mfloat_
  85. # define _Mfloat_ float
  86. # endif
  87. # define _Mdouble_ _Mfloat_
  88. # ifdef __STDC__
  89. # define __MATH_PRECNAME(name,r) name##f##r
  90. # else
  91. # define __MATH_PRECNAME(name,r) name/**/f/**/r
  92. # endif
  93. # define _Mdouble_BEGIN_NAMESPACE __BEGIN_NAMESPACE_C99
  94. # define _Mdouble_END_NAMESPACE __END_NAMESPACE_C99
  95. # include <bits/mathcalls.h>
  96. # undef _Mdouble_
  97. # undef _Mdouble_BEGIN_NAMESPACE
  98. # undef _Mdouble_END_NAMESPACE
  99. # undef __MATH_PRECNAME
  100. # if (__STDC__ - 0 || __GNUC__ - 0) \
  101. && (defined __UCLIBC_HAS_LONG_DOUBLE_MATH__ || defined __LDBL_COMPAT)
  102. # ifdef __LDBL_COMPAT
  103. # ifdef __USE_ISOC99
  104. extern float __nldbl_nexttowardf (float __x, long double __y)
  105. __THROW __attribute__ ((__const__));
  106. # ifdef __REDIRECT_NTH
  107. extern float __REDIRECT_NTH (nexttowardf, (float __x, long double __y),
  108. __nldbl_nexttowardf)
  109. __attribute__ ((__const__));
  110. extern double __REDIRECT_NTH (nexttoward, (double __x, long double __y),
  111. nextafter) __attribute__ ((__const__));
  112. extern long double __REDIRECT_NTH (nexttowardl,
  113. (long double __x, long double __y),
  114. nextafter) __attribute__ ((__const__));
  115. # endif
  116. # endif
  117. /* Include the file of declarations again, this time using `long double'
  118. instead of `double' and appending l to each function name. */
  119. # undef __MATHDECL_1
  120. # define __MATHDECL_2(type, function,suffix, args, alias) \
  121. extern type __REDIRECT_NTH(__MATH_PRECNAME(function,suffix), \
  122. args, alias)
  123. # define __MATHDECL_1(type, function,suffix, args) \
  124. __MATHDECL_2(type, function,suffix, args, __CONCAT(function,suffix))
  125. # endif
  126. # ifndef _Mlong_double_
  127. # define _Mlong_double_ long double
  128. # endif
  129. # define _Mdouble_ _Mlong_double_
  130. # ifdef __STDC__
  131. # define __MATH_PRECNAME(name,r) name##l##r
  132. # else
  133. # define __MATH_PRECNAME(name,r) name/**/l/**/r
  134. # endif
  135. # define _Mdouble_BEGIN_NAMESPACE __BEGIN_NAMESPACE_C99
  136. # define _Mdouble_END_NAMESPACE __END_NAMESPACE_C99
  137. # include <bits/mathcalls.h>
  138. # undef _Mdouble_
  139. # undef _Mdouble_BEGIN_NAMESPACE
  140. # undef _Mdouble_END_NAMESPACE
  141. # undef __MATH_PRECNAME
  142. # endif /* __STDC__ || __GNUC__ */
  143. #endif /* Use misc or ISO C99. */
  144. #undef __MATHDECL_1
  145. #undef __MATHDECL
  146. #undef __MATHCALL
  147. #if defined __USE_MISC || defined __USE_XOPEN
  148. /* This variable is used by `gamma' and `lgamma'. */
  149. extern int signgam;
  150. libm_hidden_proto(signgam)
  151. #endif
  152. /* ISO C99 defines some generic macros which work on any data type. */
  153. #ifdef __USE_ISOC99
  154. /* Get the architecture specific values describing the floating-point
  155. evaluation. The following symbols will get defined:
  156. float_t floating-point type at least as wide as `float' used
  157. to evaluate `float' expressions
  158. double_t floating-point type at least as wide as `double' used
  159. to evaluate `double' expressions
  160. FLT_EVAL_METHOD
  161. Defined to
  162. 0 if `float_t' is `float' and `double_t' is `double'
  163. 1 if `float_t' and `double_t' are `double'
  164. 2 if `float_t' and `double_t' are `long double'
  165. else `float_t' and `double_t' are unspecified
  166. INFINITY representation of the infinity value of type `float'
  167. FP_FAST_FMA
  168. FP_FAST_FMAF
  169. FP_FAST_FMAL
  170. If defined it indicates that the `fma' function
  171. generally executes about as fast as a multiply and an add.
  172. This macro is defined only iff the `fma' function is
  173. implemented directly with a hardware multiply-add instructions.
  174. FP_ILOGB0 Expands to a value returned by `ilogb (0.0)'.
  175. FP_ILOGBNAN Expands to a value returned by `ilogb (NAN)'.
  176. DECIMAL_DIG Number of decimal digits supported by conversion between
  177. decimal and all internal floating-point formats.
  178. */
  179. /* All floating-point numbers can be put in one of these categories. */
  180. enum
  181. {
  182. FP_NAN,
  183. # define FP_NAN FP_NAN
  184. FP_INFINITE,
  185. # define FP_INFINITE FP_INFINITE
  186. FP_ZERO,
  187. # define FP_ZERO FP_ZERO
  188. FP_SUBNORMAL,
  189. # define FP_SUBNORMAL FP_SUBNORMAL
  190. FP_NORMAL
  191. # define FP_NORMAL FP_NORMAL
  192. };
  193. /* Return number of classification appropriate for X. */
  194. # ifndef __UCLIBC_HAS_LONG_DOUBLE_MATH__
  195. # define fpclassify(x) \
  196. (sizeof (x) == sizeof (float) ? __fpclassifyf (x) : __fpclassify (x))
  197. # else
  198. # define fpclassify(x) \
  199. (sizeof (x) == sizeof (float) \
  200. ? __fpclassifyf (x) \
  201. : sizeof (x) == sizeof (double) \
  202. ? __fpclassify (x) : __fpclassifyl (x))
  203. # endif
  204. /* Return nonzero value if sign of X is negative. */
  205. # ifndef __UCLIBC_HAS_LONG_DOUBLE_MATH__
  206. # define signbit(x) \
  207. (sizeof (x) == sizeof (float) ? __signbitf (x) : __signbit (x))
  208. # else
  209. # define signbit(x) \
  210. (sizeof (x) == sizeof (float) \
  211. ? __signbitf (x) \
  212. : sizeof (x) == sizeof (double) \
  213. ? __signbit (x) : __signbitl (x))
  214. # endif
  215. /* Return nonzero value if X is not +-Inf or NaN. */
  216. # ifndef __UCLIBC_HAS_LONG_DOUBLE_MATH__
  217. # define isfinite(x) \
  218. (sizeof (x) == sizeof (float) ? __finitef (x) : __finite (x))
  219. # else
  220. # define isfinite(x) \
  221. (sizeof (x) == sizeof (float) \
  222. ? __finitef (x) \
  223. : sizeof (x) == sizeof (double) \
  224. ? __finite (x) : __finitel (x))
  225. # endif
  226. /* Return nonzero value if X is neither zero, subnormal, Inf, nor NaN. */
  227. # define isnormal(x) (fpclassify (x) == FP_NORMAL)
  228. /* Return nonzero value if X is a NaN. We could use `fpclassify' but
  229. we already have this functions `__isnan' and it is faster. */
  230. # ifndef __UCLIBC_HAS_LONG_DOUBLE_MATH__
  231. # define isnan(x) \
  232. (sizeof (x) == sizeof (float) ? __isnanf (x) : __isnan (x))
  233. # else
  234. # define isnan(x) \
  235. (sizeof (x) == sizeof (float) \
  236. ? __isnanf (x) \
  237. : sizeof (x) == sizeof (double) \
  238. ? __isnan (x) : __isnanl (x))
  239. # endif
  240. /* Return nonzero value is X is positive or negative infinity. */
  241. # ifndef __UCLIBC_HAS_LONG_DOUBLE_MATH__
  242. # define isinf(x) \
  243. (sizeof (x) == sizeof (float) ? __isinff (x) : __isinf (x))
  244. # else
  245. # define isinf(x) \
  246. (sizeof (x) == sizeof (float) \
  247. ? __isinff (x) \
  248. : sizeof (x) == sizeof (double) \
  249. ? __isinf (x) : __isinfl (x))
  250. # endif
  251. /* Bitmasks for the math_errhandling macro. */
  252. # define MATH_ERRNO 1 /* errno set by math functions. */
  253. # define MATH_ERREXCEPT 2 /* Exceptions raised by math functions. */
  254. #endif /* Use ISO C99. */
  255. #ifdef __USE_MISC
  256. /* Support for various different standard error handling behaviors. */
  257. typedef enum
  258. {
  259. _IEEE_ = -1, /* According to IEEE 754/IEEE 854. */
  260. _SVID_, /* According to System V, release 4. */
  261. _XOPEN_, /* Nowadays also Unix98. */
  262. _POSIX_,
  263. _ISOC_ /* Actually this is ISO C99. */
  264. } _LIB_VERSION_TYPE;
  265. /* This variable can be changed at run-time to any of the values above to
  266. affect floating point error handling behavior (it may also be necessary
  267. to change the hardware FPU exception settings). */
  268. extern _LIB_VERSION_TYPE _LIB_VERSION;
  269. #endif
  270. #ifdef __USE_SVID
  271. /* In SVID error handling, `matherr' is called with this description
  272. of the exceptional condition.
  273. We have a problem when using C++ since `exception' is a reserved
  274. name in C++. */
  275. # ifdef __cplusplus
  276. struct __exception
  277. # else
  278. struct exception
  279. # endif
  280. {
  281. int type;
  282. char *name;
  283. double arg1;
  284. double arg2;
  285. double retval;
  286. };
  287. # ifdef __cplusplus
  288. extern int matherr (struct __exception *__exc) throw ();
  289. # else
  290. extern int matherr (struct exception *__exc);
  291. # endif
  292. # define X_TLOSS 1.41484755040568800000e+16
  293. /* Types of exceptions in the `type' field. */
  294. # define DOMAIN 1
  295. # define SING 2
  296. # define OVERFLOW 3
  297. # define UNDERFLOW 4
  298. # define TLOSS 5
  299. # define PLOSS 6
  300. /* SVID mode specifies returning this large value instead of infinity. */
  301. # define HUGE 3.40282347e+38F
  302. #else /* !SVID */
  303. # ifdef __USE_XOPEN
  304. /* X/Open wants another strange constant. */
  305. # define MAXFLOAT 3.40282347e+38F
  306. # endif
  307. #endif /* SVID */
  308. /* Some useful constants. */
  309. #if defined __USE_BSD || defined __USE_XOPEN
  310. # define M_E 2.7182818284590452354 /* e */
  311. # define M_LOG2E 1.4426950408889634074 /* log_2 e */
  312. # define M_LOG10E 0.43429448190325182765 /* log_10 e */
  313. # define M_LN2 0.69314718055994530942 /* log_e 2 */
  314. # define M_LN10 2.30258509299404568402 /* log_e 10 */
  315. # define M_PI 3.14159265358979323846 /* pi */
  316. # define M_PI_2 1.57079632679489661923 /* pi/2 */
  317. # define M_PI_4 0.78539816339744830962 /* pi/4 */
  318. # define M_1_PI 0.31830988618379067154 /* 1/pi */
  319. # define M_2_PI 0.63661977236758134308 /* 2/pi */
  320. # define M_2_SQRTPI 1.12837916709551257390 /* 2/sqrt(pi) */
  321. # define M_SQRT2 1.41421356237309504880 /* sqrt(2) */
  322. # define M_SQRT1_2 0.70710678118654752440 /* 1/sqrt(2) */
  323. #endif
  324. /* The above constants are not adequate for computation using `long double's.
  325. Therefore we provide as an extension constants with similar names as a
  326. GNU extension. Provide enough digits for the 128-bit IEEE quad. */
  327. #ifdef __USE_GNU
  328. # define M_El 2.7182818284590452353602874713526625L /* e */
  329. # define M_LOG2El 1.4426950408889634073599246810018921L /* log_2 e */
  330. # define M_LOG10El 0.4342944819032518276511289189166051L /* log_10 e */
  331. # define M_LN2l 0.6931471805599453094172321214581766L /* log_e 2 */
  332. # define M_LN10l 2.3025850929940456840179914546843642L /* log_e 10 */
  333. # define M_PIl 3.1415926535897932384626433832795029L /* pi */
  334. # define M_PI_2l 1.5707963267948966192313216916397514L /* pi/2 */
  335. # define M_PI_4l 0.7853981633974483096156608458198757L /* pi/4 */
  336. # define M_1_PIl 0.3183098861837906715377675267450287L /* 1/pi */
  337. # define M_2_PIl 0.6366197723675813430755350534900574L /* 2/pi */
  338. # define M_2_SQRTPIl 1.1283791670955125738961589031215452L /* 2/sqrt(pi) */
  339. # define M_SQRT2l 1.4142135623730950488016887242096981L /* sqrt(2) */
  340. # define M_SQRT1_2l 0.7071067811865475244008443621048490L /* 1/sqrt(2) */
  341. #endif
  342. /* When compiling in strict ISO C compatible mode we must not use the
  343. inline functions since they, among other things, do not set the
  344. `errno' variable correctly. */
  345. #if defined __STRICT_ANSI__ && !defined __NO_MATH_INLINES
  346. # define __NO_MATH_INLINES 1
  347. #endif
  348. #if defined __USE_ISOC99 && __GNUC_PREREQ(2,97)
  349. /* ISO C99 defines some macros to compare number while taking care for
  350. unordered numbers. Many FPUs provide special instructions to support
  351. these operations. Generic support in GCC for these as builtins went
  352. in before 3.0.0, but not all cpus added their patterns. We define
  353. versions that use the builtins here, and <bits/mathinline.h> will
  354. undef/redefine as appropriate for the specific GCC version in use. */
  355. # define isgreater(x, y) __builtin_isgreater(x, y)
  356. # define isgreaterequal(x, y) __builtin_isgreaterequal(x, y)
  357. # define isless(x, y) __builtin_isless(x, y)
  358. # define islessequal(x, y) __builtin_islessequal(x, y)
  359. # define islessgreater(x, y) __builtin_islessgreater(x, y)
  360. # define isunordered(u, v) __builtin_isunordered(u, v)
  361. #endif
  362. /* Get machine-dependent inline versions (if there are any). */
  363. #ifdef __USE_EXTERN_INLINES
  364. # include <bits/mathinline.h>
  365. #endif
  366. #ifdef __USE_ISOC99
  367. /* If we've still got undefined comparison macros, provide defaults. */
  368. /* Return nonzero value if X is greater than Y. */
  369. # ifndef isgreater
  370. # define isgreater(x, y) \
  371. (__extension__ \
  372. ({ __typeof__(x) __x = (x); __typeof__(y) __y = (y); \
  373. !isunordered (__x, __y) && __x > __y; }))
  374. # endif
  375. /* Return nonzero value if X is greater than or equal to Y. */
  376. # ifndef isgreaterequal
  377. # define isgreaterequal(x, y) \
  378. (__extension__ \
  379. ({ __typeof__(x) __x = (x); __typeof__(y) __y = (y); \
  380. !isunordered (__x, __y) && __x >= __y; }))
  381. # endif
  382. /* Return nonzero value if X is less than Y. */
  383. # ifndef isless
  384. # define isless(x, y) \
  385. (__extension__ \
  386. ({ __typeof__(x) __x = (x); __typeof__(y) __y = (y); \
  387. !isunordered (__x, __y) && __x < __y; }))
  388. # endif
  389. /* Return nonzero value if X is less than or equal to Y. */
  390. # ifndef islessequal
  391. # define islessequal(x, y) \
  392. (__extension__ \
  393. ({ __typeof__(x) __x = (x); __typeof__(y) __y = (y); \
  394. !isunordered (__x, __y) && __x <= __y; }))
  395. # endif
  396. /* Return nonzero value if either X is less than Y or Y is less than X. */
  397. # ifndef islessgreater
  398. # define islessgreater(x, y) \
  399. (__extension__ \
  400. ({ __typeof__(x) __x = (x); __typeof__(y) __y = (y); \
  401. !isunordered (__x, __y) && (__x < __y || __y < __x); }))
  402. # endif
  403. /* Return nonzero value if arguments are unordered. */
  404. # ifndef isunordered
  405. # define isunordered(u, v) \
  406. (__extension__ \
  407. ({ __typeof__(u) __u = (u); __typeof__(v) __v = (v); \
  408. fpclassify (__u) == FP_NAN || fpclassify (__v) == FP_NAN; }))
  409. # endif
  410. #endif
  411. __END_DECLS
  412. #endif /* math.h */