math.h 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414
  1. /* Declarations for math functions.
  2. Copyright (C) 1991,92,93,95,96,97,98,99,2001 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. /*
  17. * ISO C99 Standard: 7.12 Mathematics <math.h>
  18. */
  19. #ifndef _MATH_H
  20. #define _MATH_H 1
  21. #include <features.h>
  22. __BEGIN_DECLS
  23. /* Get machine-dependent HUGE_VAL value (returned on overflow).
  24. On all IEEE754 machines, this is +Infinity. */
  25. #include <bits/huge_val.h>
  26. /* Get machine-dependent NAN value (returned for some domain errors). */
  27. #ifdef __USE_ISOC99
  28. # include <bits/nan.h>
  29. #endif
  30. /* Get general and ISO C99 specific information. */
  31. #include <bits/mathdef.h>
  32. /* The file <bits/mathcalls.h> contains the prototypes for all the
  33. actual math functions. These macros are used for those prototypes,
  34. so we can easily declare each function as both `name' and `__name',
  35. and can declare the float versions `namef' and `__namef'. */
  36. #define __MATHCALL(function,suffix, args) \
  37. __MATHDECL (_Mdouble_,function,suffix, args)
  38. #define __MATHDECL(type, function,suffix, args) \
  39. __MATHDECL_1(type, function,suffix, args); \
  40. __MATHDECL_1(type, __CONCAT(__,function),suffix, args)
  41. #define __MATHCALLX(function,suffix, args, attrib) \
  42. __MATHDECLX (_Mdouble_,function,suffix, args, attrib)
  43. #define __MATHDECLX(type, function,suffix, args, attrib) \
  44. __MATHDECL_1(type, function,suffix, args) __attribute__ (attrib); \
  45. __MATHDECL_1(type, __CONCAT(__,function),suffix, args) __attribute__ (attrib)
  46. #define __MATHDECL_1(type, function,suffix, args) \
  47. extern type __MATH_PRECNAME(function,suffix) args __THROW
  48. #define _Mdouble_ double
  49. #define __MATH_PRECNAME(name,r) __CONCAT(name,r)
  50. #include <bits/mathcalls.h>
  51. #undef _Mdouble_
  52. #undef __MATH_PRECNAME
  53. #if defined __USE_MISC || defined __USE_ISOC99
  54. /* Include the file of declarations again, this time using `float'
  55. instead of `double' and appending f to each function name. */
  56. # ifndef _Mfloat_
  57. # define _Mfloat_ float
  58. # endif
  59. # define _Mdouble_ _Mfloat_
  60. # ifdef __STDC__
  61. # define __MATH_PRECNAME(name,r) name##f##r
  62. # else
  63. # define __MATH_PRECNAME(name,r) name/**/f/**/r
  64. # endif
  65. # include <bits/mathcalls.h>
  66. # undef _Mdouble_
  67. # undef __MATH_PRECNAME
  68. # if (__STDC__ - 0 || __GNUC__ - 0) && !defined __NO_LONG_DOUBLE_MATH
  69. /* Include the file of declarations again, this time using `long double'
  70. instead of `double' and appending l to each function name. */
  71. # ifndef _Mlong_double_
  72. # define _Mlong_double_ long double
  73. # endif
  74. # define _Mdouble_ _Mlong_double_
  75. # ifdef __STDC__
  76. # define __MATH_PRECNAME(name,r) name##l##r
  77. # else
  78. # define __MATH_PRECNAME(name,r) name/**/l/**/r
  79. # endif
  80. # include <bits/mathcalls.h>
  81. # undef _Mdouble_
  82. # undef __MATH_PRECNAME
  83. # endif /* __STDC__ || __GNUC__ */
  84. #endif /* Use misc or ISO C99. */
  85. #undef __MATHDECL_1
  86. #undef __MATHDECL
  87. #undef __MATHCALL
  88. #if defined __USE_MISC || defined __USE_XOPEN
  89. /* This variable is used by `gamma' and `lgamma'. */
  90. extern int signgam;
  91. #endif
  92. /* ISO C99 defines some generic macros which work on any data type. */
  93. #if __USE_ISOC99
  94. /* Get the architecture specific values describing the floating-point
  95. evaluation. The following symbols will get defined:
  96. float_t floating-point type at least as wide as `float' used
  97. to evaluate `float' expressions
  98. double_t floating-point type at least as wide as `double' used
  99. to evaluate `double' expressions
  100. FLT_EVAL_METHOD
  101. Defined to
  102. 0 if `float_t' is `float' and `double_t' is `double'
  103. 1 if `float_t' and `double_t' are `double'
  104. 2 if `float_t' and `double_t' are `long double'
  105. else `float_t' and `double_t' are unspecified
  106. INFINITY representation of the infinity value of type `float'
  107. FP_FAST_FMA
  108. FP_FAST_FMAF
  109. FP_FAST_FMAL
  110. If defined it indicates that the `fma' function
  111. generally executes about as fast as a multiply and an add.
  112. This macro is defined only iff the `fma' function is
  113. implemented directly with a hardware multiply-add instructions.
  114. FP_ILOGB0 Expands to a value returned by `ilogb (0.0)'.
  115. FP_ILOGBNAN Expands to a value returned by `ilogb (NAN)'.
  116. DECIMAL_DIG Number of decimal digits supported by conversion between
  117. decimal and all internal floating-point formats.
  118. */
  119. /* All floating-point numbers can be put in one of these categories. */
  120. enum
  121. {
  122. FP_NAN,
  123. # define FP_NAN FP_NAN
  124. FP_INFINITE,
  125. # define FP_INFINITE FP_INFINITE
  126. FP_ZERO,
  127. # define FP_ZERO FP_ZERO
  128. FP_SUBNORMAL,
  129. # define FP_SUBNORMAL FP_SUBNORMAL
  130. FP_NORMAL
  131. # define FP_NORMAL FP_NORMAL
  132. };
  133. /* Return number of classification appropriate for X. */
  134. # ifdef __NO_LONG_DOUBLE_MATH
  135. # define fpclassify(x) \
  136. (sizeof (x) == sizeof (float) ? __fpclassifyf (x) : __fpclassify (x))
  137. # else
  138. # define fpclassify(x) \
  139. (sizeof (x) == sizeof (float) \
  140. ? __fpclassifyf (x) \
  141. : sizeof (x) == sizeof (double) \
  142. ? __fpclassify (x) : __fpclassifyl (x))
  143. # endif
  144. /* Return nonzero value if sign of X is negative. */
  145. # ifdef __NO_LONG_DOUBLE_MATH
  146. # define signbit(x) \
  147. (sizeof (x) == sizeof (float) ? __signbitf (x) : __signbit (x))
  148. # else
  149. # define signbit(x) \
  150. (sizeof (x) == sizeof (float) \
  151. ? __signbitf (x) \
  152. : sizeof (x) == sizeof (double) \
  153. ? __signbit (x) : __signbitl (x))
  154. # endif
  155. /* Return nonzero value if X is not +-Inf or NaN. */
  156. # ifdef __NO_LONG_DOUBLE_MATH
  157. # define isfinite(x) \
  158. (sizeof (x) == sizeof (float) ? __finitef (x) : __finite (x))
  159. # else
  160. # define isfinite(x) \
  161. (sizeof (x) == sizeof (float) \
  162. ? __finitef (x) \
  163. : sizeof (x) == sizeof (double) \
  164. ? __finite (x) : __finitel (x))
  165. # endif
  166. /* Return nonzero value if X is neither zero, subnormal, Inf, nor NaN. */
  167. # define isnormal(x) (fpclassify (x) == FP_NORMAL)
  168. /* Return nonzero value if X is a NaN. We could use `fpclassify' but
  169. we already have this functions `__isnan' and it is faster. */
  170. # ifdef __NO_LONG_DOUBLE_MATH
  171. # define isnan(x) \
  172. (sizeof (x) == sizeof (float) ? __isnanf (x) : __isnan (x))
  173. # else
  174. # define isnan(x) \
  175. (sizeof (x) == sizeof (float) \
  176. ? __isnanf (x) \
  177. : sizeof (x) == sizeof (double) \
  178. ? __isnan (x) : __isnanl (x))
  179. # endif
  180. /* Return nonzero value is X is positive or negative infinity. */
  181. # ifdef __NO_LONG_DOUBLE_MATH
  182. # define isinf(x) \
  183. (sizeof (x) == sizeof (float) ? __isinff (x) : __isinf (x))
  184. # else
  185. # define isinf(x) \
  186. (sizeof (x) == sizeof (float) \
  187. ? __isinff (x) \
  188. : sizeof (x) == sizeof (double) \
  189. ? __isinf (x) : __isinfl (x))
  190. # endif
  191. /* Bitmasks for the math_errhandling macro. */
  192. # define MATH_ERRNO 1 /* errno set by math functions. */
  193. # define MATH_ERREXCEPT 2 /* Exceptions raised by math functions. */
  194. #endif /* Use ISO C99. */
  195. #ifdef __USE_MISC
  196. /* Support for various different standard error handling behaviors. */
  197. typedef enum
  198. {
  199. _IEEE_ = -1, /* According to IEEE 754/IEEE 854. */
  200. _SVID_, /* According to System V, release 4. */
  201. _XOPEN_, /* Nowadays also Unix98. */
  202. _POSIX_,
  203. _ISOC_ /* Actually this is ISO C99. */
  204. } _LIB_VERSION_TYPE;
  205. /* This variable can be changed at run-time to any of the values above to
  206. affect floating point error handling behavior (it may also be necessary
  207. to change the hardware FPU exception settings). */
  208. extern _LIB_VERSION_TYPE _LIB_VERSION;
  209. #endif
  210. #ifdef __USE_SVID
  211. /* In SVID error handling, `matherr' is called with this description
  212. of the exceptional condition.
  213. We have a problem when using C++ since `exception' is a reserved
  214. name in C++. */
  215. # ifdef __cplusplus
  216. struct __exception
  217. # else
  218. struct exception
  219. # endif
  220. {
  221. int type;
  222. char *name;
  223. double arg1;
  224. double arg2;
  225. double retval;
  226. };
  227. # ifdef __cplusplus
  228. extern int matherr (struct __exception *__exc) throw ();
  229. # else
  230. extern int matherr (struct exception *__exc);
  231. # endif
  232. # define X_TLOSS 1.41484755040568800000e+16
  233. /* Types of exceptions in the `type' field. */
  234. # define DOMAIN 1
  235. # define SING 2
  236. # define OVERFLOW 3
  237. # define UNDERFLOW 4
  238. # define TLOSS 5
  239. # define PLOSS 6
  240. /* SVID mode specifies returning this large value instead of infinity. */
  241. # define HUGE 3.40282347e+38F
  242. #else /* !SVID */
  243. # ifdef __USE_XOPEN
  244. /* X/Open wants another strange constant. */
  245. # define MAXFLOAT 3.40282347e+38F
  246. # endif
  247. #endif /* SVID */
  248. /* Some useful constants. */
  249. #if defined __USE_BSD || defined __USE_XOPEN
  250. # define M_E 2.7182818284590452354 /* e */
  251. # define M_LOG2E 1.4426950408889634074 /* log_2 e */
  252. # define M_LOG10E 0.43429448190325182765 /* log_10 e */
  253. # define M_LN2 0.69314718055994530942 /* log_e 2 */
  254. # define M_LN10 2.30258509299404568402 /* log_e 10 */
  255. # define M_PI 3.14159265358979323846 /* pi */
  256. # define M_PI_2 1.57079632679489661923 /* pi/2 */
  257. # define M_PI_4 0.78539816339744830962 /* pi/4 */
  258. # define M_1_PI 0.31830988618379067154 /* 1/pi */
  259. # define M_2_PI 0.63661977236758134308 /* 2/pi */
  260. # define M_2_SQRTPI 1.12837916709551257390 /* 2/sqrt(pi) */
  261. # define M_SQRT2 1.41421356237309504880 /* sqrt(2) */
  262. # define M_SQRT1_2 0.70710678118654752440 /* 1/sqrt(2) */
  263. #endif
  264. /* The above constants are not adequate for computation using `long double's.
  265. Therefore we provide as an extension constants with similar names as a
  266. GNU extension. Provide enough digits for the 128-bit IEEE quad. */
  267. #ifdef __USE_GNU
  268. # define M_El 2.7182818284590452353602874713526625L /* e */
  269. # define M_LOG2El 1.4426950408889634073599246810018922L /* log_2 e */
  270. # define M_LOG10El 0.4342944819032518276511289189166051L /* log_10 e */
  271. # define M_LN2l 0.6931471805599453094172321214581766L /* log_e 2 */
  272. # define M_LN10l 2.3025850929940456840179914546843642L /* log_e 10 */
  273. # define M_PIl 3.1415926535897932384626433832795029L /* pi */
  274. # define M_PI_2l 1.5707963267948966192313216916397514L /* pi/2 */
  275. # define M_PI_4l 0.7853981633974483096156608458198757L /* pi/4 */
  276. # define M_1_PIl 0.3183098861837906715377675267450287L /* 1/pi */
  277. # define M_2_PIl 0.6366197723675813430755350534900574L /* 2/pi */
  278. # define M_2_SQRTPIl 1.1283791670955125738961589031215452L /* 2/sqrt(pi) */
  279. # define M_SQRT2l 1.4142135623730950488016887242096981L /* sqrt(2) */
  280. # define M_SQRT1_2l 0.7071067811865475244008443621048490L /* 1/sqrt(2) */
  281. #endif
  282. /* When compiling in strict ISO C compatible mode we must not use the
  283. inline functions since they, among other things, do not set the
  284. `errno' variable correctly. */
  285. #if defined __STRICT_ANSI__ && !defined __NO_MATH_INLINES
  286. # define __NO_MATH_INLINES 1
  287. #endif
  288. /* Get machine-dependent inline versions (if there are any). */
  289. #ifdef __USE_EXTERN_INLINES
  290. # include <bits/mathinline.h>
  291. #endif
  292. #if __USE_ISOC99
  293. /* ISO C99 defines some macros to compare number while taking care
  294. for unordered numbers. Since many FPUs provide special
  295. instructions to support these operations and these tests are
  296. defined in <bits/mathinline.h>, we define the generic macros at
  297. this late point and only if they are not defined yet. */
  298. /* Return nonzero value if X is greater than Y. */
  299. # ifndef isgreater
  300. # define isgreater(x, y) \
  301. (__extension__ \
  302. ({ __typeof__(x) __x = (x); __typeof__(y) __y = (y); \
  303. !isunordered (__x, __y) && __x > __y; }))
  304. # endif
  305. /* Return nonzero value if X is greater than or equal to Y. */
  306. # ifndef isgreaterequal
  307. # define isgreaterequal(x, y) \
  308. (__extension__ \
  309. ({ __typeof__(x) __x = (x); __typeof__(y) __y = (y); \
  310. !isunordered (__x, __y) && __x >= __y; }))
  311. # endif
  312. /* Return nonzero value if X is less than Y. */
  313. # ifndef isless
  314. # define isless(x, y) \
  315. (__extension__ \
  316. ({ __typeof__(x) __x = (x); __typeof__(y) __y = (y); \
  317. !isunordered (__x, __y) && __x < __y; }))
  318. # endif
  319. /* Return nonzero value if X is less than or equal to Y. */
  320. # ifndef islessequal
  321. # define islessequal(x, y) \
  322. (__extension__ \
  323. ({ __typeof__(x) __x = (x); __typeof__(y) __y = (y); \
  324. !isunordered (__x, __y) && __x <= __y; }))
  325. # endif
  326. /* Return nonzero value if either X is less than Y or Y is less than X. */
  327. # ifndef islessgreater
  328. # define islessgreater(x, y) \
  329. (__extension__ \
  330. ({ __typeof__(x) __x = (x); __typeof__(y) __y = (y); \
  331. !isunordered (__x, __y) && (__x < __y || __y < __x); }))
  332. # endif
  333. /* Return nonzero value if arguments are unordered. */
  334. # ifndef isunordered
  335. # define isunordered(u, v) \
  336. (__extension__ \
  337. ({ __typeof__(u) __u = (u); __typeof__(v) __v = (v); \
  338. fpclassify (__u) == FP_NAN || fpclassify (__v) == FP_NAN; }))
  339. # endif
  340. #endif
  341. __END_DECLS
  342. #endif /* math.h */