blob: 0631b931e1837554fd49fa415fbf7d1d0d5bd6be [file] [log] [blame]
Christian Heimes6f341092008-04-18 23:13:07 +00001#ifndef Py_PYMATH_H
2#define Py_PYMATH_H
3
4#include "pyconfig.h" /* include for defines */
5
6#ifdef HAVE_STDINT_H
7#include <stdint.h>
8#endif
9
10/**************************************************************************
11Symbols and macros to supply platform-independent interfaces to mathematical
12functions and constants
13**************************************************************************/
14
15/* Python provides implementations for copysign, acosh, asinh, atanh,
16 * log1p and hypot in Python/pymath.c just in case your math library doesn't
17 * provide the functions.
18 *
19 *Note: PC/pyconfig.h defines copysign as _copysign
20 */
21#ifndef HAVE_COPYSIGN
Benjamin Peterson6b094a42008-08-19 19:27:53 +000022extern double copysign(double, double);
Christian Heimes6f341092008-04-18 23:13:07 +000023#endif
24
25#ifndef HAVE_ACOSH
26extern double acosh(double);
27#endif
28
29#ifndef HAVE_ASINH
30extern double asinh(double);
31#endif
32
33#ifndef HAVE_ATANH
34extern double atanh(double);
35#endif
36
37#ifndef HAVE_LOG1P
38extern double log1p(double);
39#endif
40
41#ifndef HAVE_HYPOT
42extern double hypot(double, double);
43#endif
44
45/* extra declarations */
46#ifndef _MSC_VER
47#ifndef __STDC__
48extern double fmod (double, double);
49extern double frexp (double, int *);
50extern double ldexp (double, int);
51extern double modf (double, double *);
52extern double pow(double, double);
53#endif /* __STDC__ */
54#endif /* _MSC_VER */
55
56#ifdef _OSF_SOURCE
57/* OSF1 5.1 doesn't make these available with XOPEN_SOURCE_EXTENDED defined */
58extern int finite(double);
59extern double copysign(double, double);
60#endif
61
62/* High precision defintion of pi and e (Euler)
63 * The values are taken from libc6's math.h.
64 */
65#ifndef Py_MATH_PIl
66#define Py_MATH_PIl 3.1415926535897932384626433832795029L
67#endif
68#ifndef Py_MATH_PI
69#define Py_MATH_PI 3.14159265358979323846
70#endif
71
72#ifndef Py_MATH_El
73#define Py_MATH_El 2.7182818284590452353602874713526625L
74#endif
75
76#ifndef Py_MATH_E
77#define Py_MATH_E 2.7182818284590452354
78#endif
79
80/* Py_IS_NAN(X)
81 * Return 1 if float or double arg is a NaN, else 0.
82 * Caution:
83 * X is evaluated more than once.
84 * This may not work on all platforms. Each platform has *some*
85 * way to spell this, though -- override in pyconfig.h if you have
86 * a platform where it doesn't work.
87 * Note: PC/pyconfig.h defines Py_IS_NAN as _isnan
88 */
89#ifndef Py_IS_NAN
Mark Dickinson0ebfedf2009-01-04 17:02:05 +000090#if defined HAVE_DECL_ISNAN && HAVE_DECL_ISNAN == 1
Christian Heimes6f341092008-04-18 23:13:07 +000091#define Py_IS_NAN(X) isnan(X)
92#else
93#define Py_IS_NAN(X) ((X) != (X))
94#endif
95#endif
96
97/* Py_IS_INFINITY(X)
98 * Return 1 if float or double arg is an infinity, else 0.
99 * Caution:
100 * X is evaluated more than once.
101 * This implementation may set the underflow flag if |X| is very small;
102 * it really can't be implemented correctly (& easily) before C99.
103 * Override in pyconfig.h if you have a better spelling on your platform.
104 * Note: PC/pyconfig.h defines Py_IS_INFINITY as _isinf
105 */
106#ifndef Py_IS_INFINITY
Mark Dickinson0ebfedf2009-01-04 17:02:05 +0000107#if defined HAVE_DECL_ISINF && HAVE_DECL_ISINF == 1
Christian Heimes6f341092008-04-18 23:13:07 +0000108#define Py_IS_INFINITY(X) isinf(X)
109#else
110#define Py_IS_INFINITY(X) ((X) && (X)*0.5 == (X))
111#endif
112#endif
113
114/* Py_IS_FINITE(X)
115 * Return 1 if float or double arg is neither infinite nor NAN, else 0.
116 * Some compilers (e.g. VisualStudio) have intrisics for this, so a special
117 * macro for this particular test is useful
118 * Note: PC/pyconfig.h defines Py_IS_FINITE as _finite
119 */
120#ifndef Py_IS_FINITE
Mark Dickinson1bf64012009-01-04 19:53:00 +0000121#if defined HAVE_DECL_ISFINITE && HAVE_DECL_ISFINITE == 1
122#define Py_IS_FINITE(X) isfinite(X)
123#elif defined HAVE_FINITE
Christian Heimes6f341092008-04-18 23:13:07 +0000124#define Py_IS_FINITE(X) finite(X)
125#else
126#define Py_IS_FINITE(X) (!Py_IS_INFINITY(X) && !Py_IS_NAN(X))
127#endif
128#endif
129
130/* HUGE_VAL is supposed to expand to a positive double infinity. Python
131 * uses Py_HUGE_VAL instead because some platforms are broken in this
132 * respect. We used to embed code in pyport.h to try to worm around that,
133 * but different platforms are broken in conflicting ways. If you're on
134 * a platform where HUGE_VAL is defined incorrectly, fiddle your Python
135 * config to #define Py_HUGE_VAL to something that works on your platform.
136 */
137#ifndef Py_HUGE_VAL
138#define Py_HUGE_VAL HUGE_VAL
139#endif
140
141/* Py_NAN
142 * A value that evaluates to a NaN. On IEEE 754 platforms INF*0 or
143 * INF/INF works. Define Py_NO_NAN in pyconfig.h if your platform
144 * doesn't support NaNs.
145 */
146#if !defined(Py_NAN) && !defined(Py_NO_NAN)
147#define Py_NAN (Py_HUGE_VAL * 0.)
148#endif
149
150/* Py_OVERFLOWED(X)
151 * Return 1 iff a libm function overflowed. Set errno to 0 before calling
152 * a libm function, and invoke this macro after, passing the function
153 * result.
154 * Caution:
155 * This isn't reliable. C99 no longer requires libm to set errno under
156 * any exceptional condition, but does require +- HUGE_VAL return
157 * values on overflow. A 754 box *probably* maps HUGE_VAL to a
158 * double infinity, and we're cool if that's so, unless the input
159 * was an infinity and an infinity is the expected result. A C89
160 * system sets errno to ERANGE, so we check for that too. We're
161 * out of luck if a C99 754 box doesn't map HUGE_VAL to +Inf, or
162 * if the returned result is a NaN, or if a C89 box returns HUGE_VAL
163 * in non-overflow cases.
164 * X is evaluated more than once.
165 * Some platforms have better way to spell this, so expect some #ifdef'ery.
166 *
167 * OpenBSD uses 'isinf()' because a compiler bug on that platform causes
168 * the longer macro version to be mis-compiled. This isn't optimal, and
169 * should be removed once a newer compiler is available on that platform.
170 * The system that had the failure was running OpenBSD 3.2 on Intel, with
171 * gcc 2.95.3.
172 *
173 * According to Tim's checkin, the FreeBSD systems use isinf() to work
174 * around a FPE bug on that platform.
175 */
176#if defined(__FreeBSD__) || defined(__OpenBSD__)
177#define Py_OVERFLOWED(X) isinf(X)
178#else
179#define Py_OVERFLOWED(X) ((X) != 0.0 && (errno == ERANGE || \
180 (X) == Py_HUGE_VAL || \
181 (X) == -Py_HUGE_VAL))
182#endif
183
184#endif /* Py_PYMATH_H */