blob: e240fdb8f68030c4b7316781324441fd132c3f13 [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002/* Float object interface */
3
4/*
Guido van Rossumcaa63801995-01-12 11:45:45 +00005PyFloatObject represents a (double precision) floating point number.
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00006*/
7
Fred Drakeea9cb5a2000-07-09 00:20:36 +00008#ifndef Py_FLOATOBJECT_H
9#define Py_FLOATOBJECT_H
10#ifdef __cplusplus
11extern "C" {
12#endif
13
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000014#ifndef Py_LIMITED_API
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000015typedef struct {
Fred Drakeea9cb5a2000-07-09 00:20:36 +000016 PyObject_HEAD
17 double ob_fval;
Guido van Rossumcaa63801995-01-12 11:45:45 +000018} PyFloatObject;
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000019#endif
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000020
Mark Hammond91a681d2002-08-12 07:21:58 +000021PyAPI_DATA(PyTypeObject) PyFloat_Type;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000022
Guido van Rossumc16fcdf2001-08-29 15:45:32 +000023#define PyFloat_Check(op) PyObject_TypeCheck(op, &PyFloat_Type)
Christian Heimes90aa7642007-12-19 02:45:37 +000024#define PyFloat_CheckExact(op) (Py_TYPE(op) == &PyFloat_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000025
Christian Heimes53876d92008-04-19 00:31:39 +000026#ifdef Py_NAN
27#define Py_RETURN_NAN return PyFloat_FromDouble(Py_NAN)
28#endif
29
Ezio Melotti2aa2b3b2011-09-29 00:58:57 +030030#define Py_RETURN_INF(sign) do \
31 if (copysign(1., sign) == 1.) { \
32 return PyFloat_FromDouble(Py_HUGE_VAL); \
33 } else { \
34 return PyFloat_FromDouble(-Py_HUGE_VAL); \
35 } while(0)
Christian Heimes53876d92008-04-19 00:31:39 +000036
Christian Heimes93852662007-12-01 12:22:32 +000037PyAPI_FUNC(double) PyFloat_GetMax(void);
38PyAPI_FUNC(double) PyFloat_GetMin(void);
39PyAPI_FUNC(PyObject *) PyFloat_GetInfo(void);
40
Georg Brandl428f0642007-03-18 18:35:15 +000041/* Return Python float from string PyObject. */
42PyAPI_FUNC(PyObject *) PyFloat_FromString(PyObject*);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000043
Tim Peters72f98e92001-05-08 15:19:57 +000044/* Return Python float from C double. */
Mark Hammond91a681d2002-08-12 07:21:58 +000045PyAPI_FUNC(PyObject *) PyFloat_FromDouble(double);
Tim Peters72f98e92001-05-08 15:19:57 +000046
47/* Extract C double from Python float. The macro version trades safety for
48 speed. */
Mark Hammond91a681d2002-08-12 07:21:58 +000049PyAPI_FUNC(double) PyFloat_AsDouble(PyObject *);
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000050#ifndef Py_LIMITED_API
Guido van Rossum2981bc71997-08-02 02:40:58 +000051#define PyFloat_AS_DOUBLE(op) (((PyFloatObject *)(op))->ob_fval)
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000052#endif
Guido van Rossuma3309961993-07-28 09:05:47 +000053
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000054#ifndef Py_LIMITED_API
Tim Peters9905b942003-03-20 20:53:32 +000055/* _PyFloat_{Pack,Unpack}{4,8}
56 *
57 * The struct and pickle (at least) modules need an efficient platform-
58 * independent way to store floating-point values as byte strings.
59 * The Pack routines produce a string from a C double, and the Unpack
60 * routines produce a C double from such a string. The suffix (4 or 8)
61 * specifies the number of bytes in the string.
62 *
Michael W. Hudsonba283e22005-05-27 15:23:20 +000063 * On platforms that appear to use (see _PyFloat_Init()) IEEE-754 formats
64 * these functions work by copying bits. On other platforms, the formats the
65 * 4- byte format is identical to the IEEE-754 single precision format, and
66 * the 8-byte format to the IEEE-754 double precision format, although the
67 * packing of INFs and NaNs (if such things exist on the platform) isn't
68 * handled correctly, and attempting to unpack a string containing an IEEE
69 * INF or NaN will raise an exception.
70 *
71 * On non-IEEE platforms with more precision, or larger dynamic range, than
72 * 754 supports, not all values can be packed; on non-IEEE platforms with less
73 * precision, or smaller dynamic range, not all values can be unpacked. What
74 * happens in such cases is partly accidental (alas).
Tim Peters9905b942003-03-20 20:53:32 +000075 */
76
77/* The pack routines write 4 or 8 bytes, starting at p. le is a bool
78 * argument, true if you want the string in little-endian format (exponent
79 * last, at p+3 or p+7), false if you want big-endian format (exponent
80 * first, at p).
81 * Return value: 0 if all is OK, -1 if error (and an exception is
82 * set, most likely OverflowError).
Michael W. Hudsonba283e22005-05-27 15:23:20 +000083 * There are two problems on non-IEEE platforms:
84 * 1): What this does is undefined if x is a NaN or infinity.
85 * 2): -0.0 and +0.0 produce the same string.
Tim Peters9905b942003-03-20 20:53:32 +000086 */
87PyAPI_FUNC(int) _PyFloat_Pack4(double x, unsigned char *p, int le);
88PyAPI_FUNC(int) _PyFloat_Pack8(double x, unsigned char *p, int le);
89
Neal Norwitz545686b2006-12-28 04:45:06 +000090/* Needed for the old way for marshal to store a floating point number.
91 Returns the string length copied into p, -1 on error.
92 */
93PyAPI_FUNC(int) _PyFloat_Repr(double x, char *p, size_t len);
94
Christian Heimes827b35c2007-12-10 22:19:17 +000095/* Used to get the important decimal digits of a double */
96PyAPI_FUNC(int) _PyFloat_Digits(char *buf, double v, int *signum);
97PyAPI_FUNC(void) _PyFloat_DigitsInit(void);
98
Tim Peters9905b942003-03-20 20:53:32 +000099/* The unpack routines read 4 or 8 bytes, starting at p. le is a bool
100 * argument, true if the string is in little-endian format (exponent
101 * last, at p+3 or p+7), false if big-endian (exponent first, at p).
102 * Return value: The unpacked double. On error, this is -1.0 and
103 * PyErr_Occurred() is true (and an exception is set, most likely
Michael W. Hudsonba283e22005-05-27 15:23:20 +0000104 * OverflowError). Note that on a non-IEEE platform this will refuse
105 * to unpack a string that represents a NaN or infinity.
Tim Peters9905b942003-03-20 20:53:32 +0000106 */
107PyAPI_FUNC(double) _PyFloat_Unpack4(const unsigned char *p, int le);
108PyAPI_FUNC(double) _PyFloat_Unpack8(const unsigned char *p, int le);
109
Christian Heimes15ebc882008-02-04 18:48:49 +0000110/* free list api */
Georg Brandl2ee470f2008-07-16 12:55:28 +0000111PyAPI_FUNC(int) PyFloat_ClearFreeList(void);
Christian Heimes15ebc882008-02-04 18:48:49 +0000112
David Malcolm49526f42012-06-22 14:55:41 -0400113PyAPI_FUNC(void) _PyFloat_DebugMallocStats(FILE* out);
114
Eric Smith4a7d76d2008-05-30 18:10:19 +0000115/* Format the object based on the format_spec, as defined in PEP 3101
116 (Advanced String Formatting). */
Victor Stinnerd3f08822012-05-29 12:57:52 +0200117PyAPI_FUNC(int) _PyFloat_FormatAdvancedWriter(
118 _PyUnicodeWriter *writer,
119 PyObject *obj,
120 PyObject *format_spec,
121 Py_ssize_t start,
122 Py_ssize_t end);
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000123#endif /* Py_LIMITED_API */
Eric Smith4a7d76d2008-05-30 18:10:19 +0000124
Guido van Rossuma3309961993-07-28 09:05:47 +0000125#ifdef __cplusplus
126}
127#endif
128#endif /* !Py_FLOATOBJECT_H */