Mercurial > cpython-lru_cache-weakref
annotate Include/floatobject.h @ 39496:352ffe77b71d legacy-trunk
Patch #1535500: fix segfault in BZ2File.writelines and make sure it
raises the correct exceptions.
| author | Georg Brandl <georg@python.org> |
|---|---|
| date | Mon, 14 Aug 2006 21:42:55 +0000 |
| parents | 1dd8a0d64432 |
| children | 6620a510e9a9 195f689af5af |
| rev | line source |
|---|---|
| 145 | 1 |
| 6 | 2 /* Float object interface */ |
| 3 | |
| 4 /* | |
|
2129
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2058
diff
changeset
|
5 PyFloatObject represents a (double precision) floating point number. |
| 6 | 6 */ |
| 7 | |
|
13444
5709ddba423c
ANSI-fication and Py_PROTO extermination.
Fred Drake <fdrake@acm.org>
parents:
13256
diff
changeset
|
8 #ifndef Py_FLOATOBJECT_H |
|
5709ddba423c
ANSI-fication and Py_PROTO extermination.
Fred Drake <fdrake@acm.org>
parents:
13256
diff
changeset
|
9 #define Py_FLOATOBJECT_H |
|
5709ddba423c
ANSI-fication and Py_PROTO extermination.
Fred Drake <fdrake@acm.org>
parents:
13256
diff
changeset
|
10 #ifdef __cplusplus |
|
5709ddba423c
ANSI-fication and Py_PROTO extermination.
Fred Drake <fdrake@acm.org>
parents:
13256
diff
changeset
|
11 extern "C" { |
|
5709ddba423c
ANSI-fication and Py_PROTO extermination.
Fred Drake <fdrake@acm.org>
parents:
13256
diff
changeset
|
12 #endif |
|
5709ddba423c
ANSI-fication and Py_PROTO extermination.
Fred Drake <fdrake@acm.org>
parents:
13256
diff
changeset
|
13 |
| 6 | 14 typedef struct { |
|
13444
5709ddba423c
ANSI-fication and Py_PROTO extermination.
Fred Drake <fdrake@acm.org>
parents:
13256
diff
changeset
|
15 PyObject_HEAD |
|
5709ddba423c
ANSI-fication and Py_PROTO extermination.
Fred Drake <fdrake@acm.org>
parents:
13256
diff
changeset
|
16 double ob_fval; |
|
2129
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2058
diff
changeset
|
17 } PyFloatObject; |
| 6 | 18 |
|
24752
c1eb668525e1
Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents:
19839
diff
changeset
|
19 PyAPI_DATA(PyTypeObject) PyFloat_Type; |
| 6 | 20 |
|
19550
19d271f297dc
Make the PyXXX_Check() macros for the numeric types inheritance-aware.
Guido van Rossum <guido@python.org>
parents:
17707
diff
changeset
|
21 #define PyFloat_Check(op) PyObject_TypeCheck(op, &PyFloat_Type) |
|
19839
10f5927dbf05
More for SF bug [#460020] bug or feature: unicode() and subclasses
Tim Peters <tim.peters@gmail.com>
parents:
19550
diff
changeset
|
22 #define PyFloat_CheckExact(op) ((op)->ob_type == &PyFloat_Type) |
| 6 | 23 |
|
17707
fe4c1034b480
SF bug #422177: Results from .pyc differs from .py
Tim Peters <tim.peters@gmail.com>
parents:
14375
diff
changeset
|
24 /* Return Python float from string PyObject. Second argument ignored on |
|
fe4c1034b480
SF bug #422177: Results from .pyc differs from .py
Tim Peters <tim.peters@gmail.com>
parents:
14375
diff
changeset
|
25 input, and, if non-NULL, NULL is stored into *junk (this tried to serve a |
|
fe4c1034b480
SF bug #422177: Results from .pyc differs from .py
Tim Peters <tim.peters@gmail.com>
parents:
14375
diff
changeset
|
26 purpose once but can't be made to work as intended). */ |
|
24752
c1eb668525e1
Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents:
19839
diff
changeset
|
27 PyAPI_FUNC(PyObject *) PyFloat_FromString(PyObject*, char** junk); |
|
17707
fe4c1034b480
SF bug #422177: Results from .pyc differs from .py
Tim Peters <tim.peters@gmail.com>
parents:
14375
diff
changeset
|
28 |
|
fe4c1034b480
SF bug #422177: Results from .pyc differs from .py
Tim Peters <tim.peters@gmail.com>
parents:
14375
diff
changeset
|
29 /* Return Python float from C double. */ |
|
24752
c1eb668525e1
Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents:
19839
diff
changeset
|
30 PyAPI_FUNC(PyObject *) PyFloat_FromDouble(double); |
|
17707
fe4c1034b480
SF bug #422177: Results from .pyc differs from .py
Tim Peters <tim.peters@gmail.com>
parents:
14375
diff
changeset
|
31 |
|
fe4c1034b480
SF bug #422177: Results from .pyc differs from .py
Tim Peters <tim.peters@gmail.com>
parents:
14375
diff
changeset
|
32 /* Extract C double from Python float. The macro version trades safety for |
|
fe4c1034b480
SF bug #422177: Results from .pyc differs from .py
Tim Peters <tim.peters@gmail.com>
parents:
14375
diff
changeset
|
33 speed. */ |
|
24752
c1eb668525e1
Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents:
19839
diff
changeset
|
34 PyAPI_FUNC(double) PyFloat_AsDouble(PyObject *); |
|
17707
fe4c1034b480
SF bug #422177: Results from .pyc differs from .py
Tim Peters <tim.peters@gmail.com>
parents:
14375
diff
changeset
|
35 #define PyFloat_AS_DOUBLE(op) (((PyFloatObject *)(op))->ob_fval) |
| 6 | 36 |
|
17707
fe4c1034b480
SF bug #422177: Results from .pyc differs from .py
Tim Peters <tim.peters@gmail.com>
parents:
14375
diff
changeset
|
37 /* Write repr(v) into the char buffer argument, followed by null byte. The |
|
fe4c1034b480
SF bug #422177: Results from .pyc differs from .py
Tim Peters <tim.peters@gmail.com>
parents:
14375
diff
changeset
|
38 buffer must be "big enough"; >= 100 is very safe. |
|
fe4c1034b480
SF bug #422177: Results from .pyc differs from .py
Tim Peters <tim.peters@gmail.com>
parents:
14375
diff
changeset
|
39 PyFloat_AsReprString(buf, x) strives to print enough digits so that |
|
fe4c1034b480
SF bug #422177: Results from .pyc differs from .py
Tim Peters <tim.peters@gmail.com>
parents:
14375
diff
changeset
|
40 PyFloat_FromString(buf) then reproduces x exactly. */ |
|
24752
c1eb668525e1
Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents:
19839
diff
changeset
|
41 PyAPI_FUNC(void) PyFloat_AsReprString(char*, PyFloatObject *v); |
|
17707
fe4c1034b480
SF bug #422177: Results from .pyc differs from .py
Tim Peters <tim.peters@gmail.com>
parents:
14375
diff
changeset
|
42 |
|
fe4c1034b480
SF bug #422177: Results from .pyc differs from .py
Tim Peters <tim.peters@gmail.com>
parents:
14375
diff
changeset
|
43 /* Write str(v) into the char buffer argument, followed by null byte. The |
|
fe4c1034b480
SF bug #422177: Results from .pyc differs from .py
Tim Peters <tim.peters@gmail.com>
parents:
14375
diff
changeset
|
44 buffer must be "big enough"; >= 100 is very safe. Note that it's |
|
fe4c1034b480
SF bug #422177: Results from .pyc differs from .py
Tim Peters <tim.peters@gmail.com>
parents:
14375
diff
changeset
|
45 unusual to be able to get back the float you started with from |
|
fe4c1034b480
SF bug #422177: Results from .pyc differs from .py
Tim Peters <tim.peters@gmail.com>
parents:
14375
diff
changeset
|
46 PyFloat_AsString's result -- use PyFloat_AsReprString() if you want to |
|
fe4c1034b480
SF bug #422177: Results from .pyc differs from .py
Tim Peters <tim.peters@gmail.com>
parents:
14375
diff
changeset
|
47 preserve precision across conversions. */ |
|
24752
c1eb668525e1
Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents:
19839
diff
changeset
|
48 PyAPI_FUNC(void) PyFloat_AsString(char*, PyFloatObject *v); |
|
1329
519c25039c6a
* Added support for X11 modules.
Guido van Rossum <guido@python.org>
parents:
1257
diff
changeset
|
49 |
|
28335
70003b0cb837
New private API functions _PyFloat_{Pack,Unpack}(4,8}. This is a
Tim Peters <tim.peters@gmail.com>
parents:
24752
diff
changeset
|
50 /* _PyFloat_{Pack,Unpack}{4,8} |
|
70003b0cb837
New private API functions _PyFloat_{Pack,Unpack}(4,8}. This is a
Tim Peters <tim.peters@gmail.com>
parents:
24752
diff
changeset
|
51 * |
|
70003b0cb837
New private API functions _PyFloat_{Pack,Unpack}(4,8}. This is a
Tim Peters <tim.peters@gmail.com>
parents:
24752
diff
changeset
|
52 * The struct and pickle (at least) modules need an efficient platform- |
|
70003b0cb837
New private API functions _PyFloat_{Pack,Unpack}(4,8}. This is a
Tim Peters <tim.peters@gmail.com>
parents:
24752
diff
changeset
|
53 * independent way to store floating-point values as byte strings. |
|
70003b0cb837
New private API functions _PyFloat_{Pack,Unpack}(4,8}. This is a
Tim Peters <tim.peters@gmail.com>
parents:
24752
diff
changeset
|
54 * The Pack routines produce a string from a C double, and the Unpack |
|
70003b0cb837
New private API functions _PyFloat_{Pack,Unpack}(4,8}. This is a
Tim Peters <tim.peters@gmail.com>
parents:
24752
diff
changeset
|
55 * routines produce a C double from such a string. The suffix (4 or 8) |
|
70003b0cb837
New private API functions _PyFloat_{Pack,Unpack}(4,8}. This is a
Tim Peters <tim.peters@gmail.com>
parents:
24752
diff
changeset
|
56 * specifies the number of bytes in the string. |
|
70003b0cb837
New private API functions _PyFloat_{Pack,Unpack}(4,8}. This is a
Tim Peters <tim.peters@gmail.com>
parents:
24752
diff
changeset
|
57 * |
| 34972 | 58 * On platforms that appear to use (see _PyFloat_Init()) IEEE-754 formats |
| 59 * these functions work by copying bits. On other platforms, the formats the | |
| 60 * 4- byte format is identical to the IEEE-754 single precision format, and | |
| 61 * the 8-byte format to the IEEE-754 double precision format, although the | |
| 62 * packing of INFs and NaNs (if such things exist on the platform) isn't | |
| 63 * handled correctly, and attempting to unpack a string containing an IEEE | |
| 64 * INF or NaN will raise an exception. | |
| 65 * | |
| 66 * On non-IEEE platforms with more precision, or larger dynamic range, than | |
| 67 * 754 supports, not all values can be packed; on non-IEEE platforms with less | |
| 68 * precision, or smaller dynamic range, not all values can be unpacked. What | |
| 69 * happens in such cases is partly accidental (alas). | |
|
28335
70003b0cb837
New private API functions _PyFloat_{Pack,Unpack}(4,8}. This is a
Tim Peters <tim.peters@gmail.com>
parents:
24752
diff
changeset
|
70 */ |
|
70003b0cb837
New private API functions _PyFloat_{Pack,Unpack}(4,8}. This is a
Tim Peters <tim.peters@gmail.com>
parents:
24752
diff
changeset
|
71 |
|
70003b0cb837
New private API functions _PyFloat_{Pack,Unpack}(4,8}. This is a
Tim Peters <tim.peters@gmail.com>
parents:
24752
diff
changeset
|
72 /* The pack routines write 4 or 8 bytes, starting at p. le is a bool |
|
70003b0cb837
New private API functions _PyFloat_{Pack,Unpack}(4,8}. This is a
Tim Peters <tim.peters@gmail.com>
parents:
24752
diff
changeset
|
73 * argument, true if you want the string in little-endian format (exponent |
|
70003b0cb837
New private API functions _PyFloat_{Pack,Unpack}(4,8}. This is a
Tim Peters <tim.peters@gmail.com>
parents:
24752
diff
changeset
|
74 * last, at p+3 or p+7), false if you want big-endian format (exponent |
|
70003b0cb837
New private API functions _PyFloat_{Pack,Unpack}(4,8}. This is a
Tim Peters <tim.peters@gmail.com>
parents:
24752
diff
changeset
|
75 * first, at p). |
|
70003b0cb837
New private API functions _PyFloat_{Pack,Unpack}(4,8}. This is a
Tim Peters <tim.peters@gmail.com>
parents:
24752
diff
changeset
|
76 * Return value: 0 if all is OK, -1 if error (and an exception is |
|
70003b0cb837
New private API functions _PyFloat_{Pack,Unpack}(4,8}. This is a
Tim Peters <tim.peters@gmail.com>
parents:
24752
diff
changeset
|
77 * set, most likely OverflowError). |
| 34972 | 78 * There are two problems on non-IEEE platforms: |
| 79 * 1): What this does is undefined if x is a NaN or infinity. | |
| 80 * 2): -0.0 and +0.0 produce the same string. | |
|
28335
70003b0cb837
New private API functions _PyFloat_{Pack,Unpack}(4,8}. This is a
Tim Peters <tim.peters@gmail.com>
parents:
24752
diff
changeset
|
81 */ |
|
70003b0cb837
New private API functions _PyFloat_{Pack,Unpack}(4,8}. This is a
Tim Peters <tim.peters@gmail.com>
parents:
24752
diff
changeset
|
82 PyAPI_FUNC(int) _PyFloat_Pack4(double x, unsigned char *p, int le); |
|
70003b0cb837
New private API functions _PyFloat_{Pack,Unpack}(4,8}. This is a
Tim Peters <tim.peters@gmail.com>
parents:
24752
diff
changeset
|
83 PyAPI_FUNC(int) _PyFloat_Pack8(double x, unsigned char *p, int le); |
|
70003b0cb837
New private API functions _PyFloat_{Pack,Unpack}(4,8}. This is a
Tim Peters <tim.peters@gmail.com>
parents:
24752
diff
changeset
|
84 |
|
70003b0cb837
New private API functions _PyFloat_{Pack,Unpack}(4,8}. This is a
Tim Peters <tim.peters@gmail.com>
parents:
24752
diff
changeset
|
85 /* The unpack routines read 4 or 8 bytes, starting at p. le is a bool |
|
70003b0cb837
New private API functions _PyFloat_{Pack,Unpack}(4,8}. This is a
Tim Peters <tim.peters@gmail.com>
parents:
24752
diff
changeset
|
86 * argument, true if the string is in little-endian format (exponent |
|
70003b0cb837
New private API functions _PyFloat_{Pack,Unpack}(4,8}. This is a
Tim Peters <tim.peters@gmail.com>
parents:
24752
diff
changeset
|
87 * last, at p+3 or p+7), false if big-endian (exponent first, at p). |
|
70003b0cb837
New private API functions _PyFloat_{Pack,Unpack}(4,8}. This is a
Tim Peters <tim.peters@gmail.com>
parents:
24752
diff
changeset
|
88 * Return value: The unpacked double. On error, this is -1.0 and |
|
70003b0cb837
New private API functions _PyFloat_{Pack,Unpack}(4,8}. This is a
Tim Peters <tim.peters@gmail.com>
parents:
24752
diff
changeset
|
89 * PyErr_Occurred() is true (and an exception is set, most likely |
| 34972 | 90 * OverflowError). Note that on a non-IEEE platform this will refuse |
| 91 * to unpack a string that represents a NaN or infinity. | |
|
28335
70003b0cb837
New private API functions _PyFloat_{Pack,Unpack}(4,8}. This is a
Tim Peters <tim.peters@gmail.com>
parents:
24752
diff
changeset
|
92 */ |
|
70003b0cb837
New private API functions _PyFloat_{Pack,Unpack}(4,8}. This is a
Tim Peters <tim.peters@gmail.com>
parents:
24752
diff
changeset
|
93 PyAPI_FUNC(double) _PyFloat_Unpack4(const unsigned char *p, int le); |
|
70003b0cb837
New private API functions _PyFloat_{Pack,Unpack}(4,8}. This is a
Tim Peters <tim.peters@gmail.com>
parents:
24752
diff
changeset
|
94 PyAPI_FUNC(double) _PyFloat_Unpack8(const unsigned char *p, int le); |
|
70003b0cb837
New private API functions _PyFloat_{Pack,Unpack}(4,8}. This is a
Tim Peters <tim.peters@gmail.com>
parents:
24752
diff
changeset
|
95 |
|
70003b0cb837
New private API functions _PyFloat_{Pack,Unpack}(4,8}. This is a
Tim Peters <tim.peters@gmail.com>
parents:
24752
diff
changeset
|
96 |
|
1329
519c25039c6a
* Added support for X11 modules.
Guido van Rossum <guido@python.org>
parents:
1257
diff
changeset
|
97 #ifdef __cplusplus |
|
519c25039c6a
* Added support for X11 modules.
Guido van Rossum <guido@python.org>
parents:
1257
diff
changeset
|
98 } |
|
519c25039c6a
* Added support for X11 modules.
Guido van Rossum <guido@python.org>
parents:
1257
diff
changeset
|
99 #endif |
|
519c25039c6a
* Added support for X11 modules.
Guido van Rossum <guido@python.org>
parents:
1257
diff
changeset
|
100 #endif /* !Py_FLOATOBJECT_H */ |
