annotate Include/pymath.h @ 54294:dba767bc3155 legacy-trunk

remove mention of old ctypes version
author Benjamin Peterson <benjamin@python.org>
date Sat, 23 May 2009 20:59:09 +0000
parents 96d82facd890
children f3daffd4cb28
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
46477
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
1 #ifndef Py_PYMATH_H
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
2 #define Py_PYMATH_H
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
3
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
4 #include "pyconfig.h" /* include for defines */
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
5
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
6 #ifdef HAVE_STDINT_H
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
7 #include <stdint.h>
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
8 #endif
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
9
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
10 /**************************************************************************
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
11 Symbols and macros to supply platform-independent interfaces to mathematical
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
12 functions and constants
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
13 **************************************************************************/
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
14
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
15 /* Python provides implementations for copysign, acosh, asinh, atanh,
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
16 * log1p and hypot in Python/pymath.c just in case your math library doesn't
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
17 * provide the functions.
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
18 *
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
19 *Note: PC/pyconfig.h defines copysign as _copysign
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
20 */
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
21 #ifndef HAVE_COPYSIGN
48781
c1a7fdb24628 Merged revisions 65658,65869,65882 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 46477
diff changeset
22 extern double copysign(double, double);
46477
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
23 #endif
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
24
53227
96d82facd890 Backport r71704 (add configure check for C99 round function) to trunk.
Mark Dickinson <dickinsm@gmail.com>
parents: 51485
diff changeset
25 #ifndef HAVE_ROUND
96d82facd890 Backport r71704 (add configure check for C99 round function) to trunk.
Mark Dickinson <dickinsm@gmail.com>
parents: 51485
diff changeset
26 extern double round(double);
96d82facd890 Backport r71704 (add configure check for C99 round function) to trunk.
Mark Dickinson <dickinsm@gmail.com>
parents: 51485
diff changeset
27 #endif
96d82facd890 Backport r71704 (add configure check for C99 round function) to trunk.
Mark Dickinson <dickinsm@gmail.com>
parents: 51485
diff changeset
28
46477
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
29 #ifndef HAVE_ACOSH
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
30 extern double acosh(double);
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
31 #endif
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
32
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
33 #ifndef HAVE_ASINH
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
34 extern double asinh(double);
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
35 #endif
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
36
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
37 #ifndef HAVE_ATANH
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
38 extern double atanh(double);
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
39 #endif
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
40
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
41 #ifndef HAVE_LOG1P
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
42 extern double log1p(double);
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
43 #endif
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
44
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
45 #ifndef HAVE_HYPOT
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
46 extern double hypot(double, double);
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
47 #endif
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
48
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
49 /* extra declarations */
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
50 #ifndef _MSC_VER
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
51 #ifndef __STDC__
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
52 extern double fmod (double, double);
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
53 extern double frexp (double, int *);
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
54 extern double ldexp (double, int);
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
55 extern double modf (double, double *);
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
56 extern double pow(double, double);
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
57 #endif /* __STDC__ */
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
58 #endif /* _MSC_VER */
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
59
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
60 #ifdef _OSF_SOURCE
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
61 /* OSF1 5.1 doesn't make these available with XOPEN_SOURCE_EXTENDED defined */
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
62 extern int finite(double);
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
63 extern double copysign(double, double);
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
64 #endif
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
65
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
66 /* High precision defintion of pi and e (Euler)
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
67 * The values are taken from libc6's math.h.
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
68 */
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
69 #ifndef Py_MATH_PIl
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
70 #define Py_MATH_PIl 3.1415926535897932384626433832795029L
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
71 #endif
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
72 #ifndef Py_MATH_PI
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
73 #define Py_MATH_PI 3.14159265358979323846
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
74 #endif
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
75
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
76 #ifndef Py_MATH_El
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
77 #define Py_MATH_El 2.7182818284590452353602874713526625L
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
78 #endif
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
79
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
80 #ifndef Py_MATH_E
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
81 #define Py_MATH_E 2.7182818284590452354
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
82 #endif
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
83
51485
f9f2ed79b00f Merged revisions 69459 via svnmerge from
Mark Dickinson <dickinsm@gmail.com>
parents: 50610
diff changeset
84 /* On x86, Py_FORCE_DOUBLE forces a floating-point number out of an x87 FPU
f9f2ed79b00f Merged revisions 69459 via svnmerge from
Mark Dickinson <dickinsm@gmail.com>
parents: 50610
diff changeset
85 register and into a 64-bit memory location, rounding from extended
f9f2ed79b00f Merged revisions 69459 via svnmerge from
Mark Dickinson <dickinsm@gmail.com>
parents: 50610
diff changeset
86 precision to double precision in the process. On other platforms it does
f9f2ed79b00f Merged revisions 69459 via svnmerge from
Mark Dickinson <dickinsm@gmail.com>
parents: 50610
diff changeset
87 nothing. */
f9f2ed79b00f Merged revisions 69459 via svnmerge from
Mark Dickinson <dickinsm@gmail.com>
parents: 50610
diff changeset
88
f9f2ed79b00f Merged revisions 69459 via svnmerge from
Mark Dickinson <dickinsm@gmail.com>
parents: 50610
diff changeset
89 /* we take double rounding as evidence of x87 usage */
f9f2ed79b00f Merged revisions 69459 via svnmerge from
Mark Dickinson <dickinsm@gmail.com>
parents: 50610
diff changeset
90 #ifndef Py_FORCE_DOUBLE
f9f2ed79b00f Merged revisions 69459 via svnmerge from
Mark Dickinson <dickinsm@gmail.com>
parents: 50610
diff changeset
91 # ifdef X87_DOUBLE_ROUNDING
f9f2ed79b00f Merged revisions 69459 via svnmerge from
Mark Dickinson <dickinsm@gmail.com>
parents: 50610
diff changeset
92 PyAPI_FUNC(double) _Py_force_double(double);
f9f2ed79b00f Merged revisions 69459 via svnmerge from
Mark Dickinson <dickinsm@gmail.com>
parents: 50610
diff changeset
93 # define Py_FORCE_DOUBLE(X) (_Py_force_double(X))
f9f2ed79b00f Merged revisions 69459 via svnmerge from
Mark Dickinson <dickinsm@gmail.com>
parents: 50610
diff changeset
94 # else
f9f2ed79b00f Merged revisions 69459 via svnmerge from
Mark Dickinson <dickinsm@gmail.com>
parents: 50610
diff changeset
95 # define Py_FORCE_DOUBLE(X) (X)
f9f2ed79b00f Merged revisions 69459 via svnmerge from
Mark Dickinson <dickinsm@gmail.com>
parents: 50610
diff changeset
96 # endif
f9f2ed79b00f Merged revisions 69459 via svnmerge from
Mark Dickinson <dickinsm@gmail.com>
parents: 50610
diff changeset
97 #endif
f9f2ed79b00f Merged revisions 69459 via svnmerge from
Mark Dickinson <dickinsm@gmail.com>
parents: 50610
diff changeset
98
46477
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
99 /* Py_IS_NAN(X)
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
100 * Return 1 if float or double arg is a NaN, else 0.
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
101 * Caution:
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
102 * X is evaluated more than once.
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
103 * This may not work on all platforms. Each platform has *some*
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
104 * way to spell this, though -- override in pyconfig.h if you have
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
105 * a platform where it doesn't work.
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
106 * Note: PC/pyconfig.h defines Py_IS_NAN as _isnan
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
107 */
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
108 #ifndef Py_IS_NAN
50590
6e4dde2e95f7 Merged revisions 68304 via svnmerge from
Mark Dickinson <dickinsm@gmail.com>
parents: 50588
diff changeset
109 #if defined HAVE_DECL_ISNAN && HAVE_DECL_ISNAN == 1
46477
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
110 #define Py_IS_NAN(X) isnan(X)
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
111 #else
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
112 #define Py_IS_NAN(X) ((X) != (X))
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
113 #endif
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
114 #endif
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
115
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
116 /* Py_IS_INFINITY(X)
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
117 * Return 1 if float or double arg is an infinity, else 0.
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
118 * Caution:
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
119 * X is evaluated more than once.
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
120 * This implementation may set the underflow flag if |X| is very small;
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
121 * it really can't be implemented correctly (& easily) before C99.
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
122 * Override in pyconfig.h if you have a better spelling on your platform.
51485
f9f2ed79b00f Merged revisions 69459 via svnmerge from
Mark Dickinson <dickinsm@gmail.com>
parents: 50610
diff changeset
123 * Py_FORCE_DOUBLE is used to avoid getting false negatives from a
f9f2ed79b00f Merged revisions 69459 via svnmerge from
Mark Dickinson <dickinsm@gmail.com>
parents: 50610
diff changeset
124 * non-infinite value v sitting in an 80-bit x87 register such that
f9f2ed79b00f Merged revisions 69459 via svnmerge from
Mark Dickinson <dickinsm@gmail.com>
parents: 50610
diff changeset
125 * v becomes infinite when spilled from the register to 64-bit memory.
46477
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
126 * Note: PC/pyconfig.h defines Py_IS_INFINITY as _isinf
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
127 */
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
128 #ifndef Py_IS_INFINITY
51485
f9f2ed79b00f Merged revisions 69459 via svnmerge from
Mark Dickinson <dickinsm@gmail.com>
parents: 50610
diff changeset
129 # if defined HAVE_DECL_ISINF && HAVE_DECL_ISINF == 1
f9f2ed79b00f Merged revisions 69459 via svnmerge from
Mark Dickinson <dickinsm@gmail.com>
parents: 50610
diff changeset
130 # define Py_IS_INFINITY(X) isinf(X)
f9f2ed79b00f Merged revisions 69459 via svnmerge from
Mark Dickinson <dickinsm@gmail.com>
parents: 50610
diff changeset
131 # else
f9f2ed79b00f Merged revisions 69459 via svnmerge from
Mark Dickinson <dickinsm@gmail.com>
parents: 50610
diff changeset
132 # define Py_IS_INFINITY(X) ((X) && \
f9f2ed79b00f Merged revisions 69459 via svnmerge from
Mark Dickinson <dickinsm@gmail.com>
parents: 50610
diff changeset
133 (Py_FORCE_DOUBLE(X)*0.5 == Py_FORCE_DOUBLE(X)))
f9f2ed79b00f Merged revisions 69459 via svnmerge from
Mark Dickinson <dickinsm@gmail.com>
parents: 50610
diff changeset
134 # endif
46477
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
135 #endif
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
136
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
137 /* Py_IS_FINITE(X)
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
138 * Return 1 if float or double arg is neither infinite nor NAN, else 0.
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
139 * Some compilers (e.g. VisualStudio) have intrisics for this, so a special
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
140 * macro for this particular test is useful
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
141 * Note: PC/pyconfig.h defines Py_IS_FINITE as _finite
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
142 */
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
143 #ifndef Py_IS_FINITE
50610
6d9b0331d073 Merged revisions 68311 via svnmerge from
Mark Dickinson <dickinsm@gmail.com>
parents: 50590
diff changeset
144 #if defined HAVE_DECL_ISFINITE && HAVE_DECL_ISFINITE == 1
6d9b0331d073 Merged revisions 68311 via svnmerge from
Mark Dickinson <dickinsm@gmail.com>
parents: 50590
diff changeset
145 #define Py_IS_FINITE(X) isfinite(X)
6d9b0331d073 Merged revisions 68311 via svnmerge from
Mark Dickinson <dickinsm@gmail.com>
parents: 50590
diff changeset
146 #elif defined HAVE_FINITE
46477
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
147 #define Py_IS_FINITE(X) finite(X)
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
148 #else
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
149 #define Py_IS_FINITE(X) (!Py_IS_INFINITY(X) && !Py_IS_NAN(X))
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
150 #endif
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
151 #endif
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
152
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
153 /* HUGE_VAL is supposed to expand to a positive double infinity. Python
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
154 * uses Py_HUGE_VAL instead because some platforms are broken in this
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
155 * respect. We used to embed code in pyport.h to try to worm around that,
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
156 * but different platforms are broken in conflicting ways. If you're on
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
157 * a platform where HUGE_VAL is defined incorrectly, fiddle your Python
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
158 * config to #define Py_HUGE_VAL to something that works on your platform.
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
159 */
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
160 #ifndef Py_HUGE_VAL
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
161 #define Py_HUGE_VAL HUGE_VAL
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
162 #endif
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
163
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
164 /* Py_NAN
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
165 * A value that evaluates to a NaN. On IEEE 754 platforms INF*0 or
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
166 * INF/INF works. Define Py_NO_NAN in pyconfig.h if your platform
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
167 * doesn't support NaNs.
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
168 */
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
169 #if !defined(Py_NAN) && !defined(Py_NO_NAN)
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
170 #define Py_NAN (Py_HUGE_VAL * 0.)
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
171 #endif
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
172
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
173 /* Py_OVERFLOWED(X)
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
174 * Return 1 iff a libm function overflowed. Set errno to 0 before calling
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
175 * a libm function, and invoke this macro after, passing the function
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
176 * result.
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
177 * Caution:
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
178 * This isn't reliable. C99 no longer requires libm to set errno under
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
179 * any exceptional condition, but does require +- HUGE_VAL return
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
180 * values on overflow. A 754 box *probably* maps HUGE_VAL to a
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
181 * double infinity, and we're cool if that's so, unless the input
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
182 * was an infinity and an infinity is the expected result. A C89
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
183 * system sets errno to ERANGE, so we check for that too. We're
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
184 * out of luck if a C99 754 box doesn't map HUGE_VAL to +Inf, or
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
185 * if the returned result is a NaN, or if a C89 box returns HUGE_VAL
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
186 * in non-overflow cases.
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
187 * X is evaluated more than once.
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
188 * Some platforms have better way to spell this, so expect some #ifdef'ery.
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
189 *
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
190 * OpenBSD uses 'isinf()' because a compiler bug on that platform causes
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
191 * the longer macro version to be mis-compiled. This isn't optimal, and
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
192 * should be removed once a newer compiler is available on that platform.
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
193 * The system that had the failure was running OpenBSD 3.2 on Intel, with
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
194 * gcc 2.95.3.
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
195 *
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
196 * According to Tim's checkin, the FreeBSD systems use isinf() to work
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
197 * around a FPE bug on that platform.
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
198 */
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
199 #if defined(__FreeBSD__) || defined(__OpenBSD__)
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
200 #define Py_OVERFLOWED(X) isinf(X)
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
201 #else
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
202 #define Py_OVERFLOWED(X) ((X) != 0.0 && (errno == ERANGE || \
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
203 (X) == Py_HUGE_VAL || \
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
204 (X) == -Py_HUGE_VAL))
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
205 #endif
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
206
b69f443ef480 Merged revisions 62380,62382-62383 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
207 #endif /* Py_PYMATH_H */