floatobject.h 4.27 KB
Newer Older
1

Guido van Rossum's avatar
Guido van Rossum committed
2 3 4
/* Float object interface */

/*
5
PyFloatObject represents a (double precision) floating point number.
Guido van Rossum's avatar
Guido van Rossum committed
6 7
*/

8 9 10 11 12 13
#ifndef Py_FLOATOBJECT_H
#define Py_FLOATOBJECT_H
#ifdef __cplusplus
extern "C" {
#endif

Guido van Rossum's avatar
Guido van Rossum committed
14
typedef struct {
15 16
    PyObject_HEAD
    double ob_fval;
17
} PyFloatObject;
Guido van Rossum's avatar
Guido van Rossum committed
18

19
PyAPI_DATA(PyTypeObject) PyFloat_Type;
Guido van Rossum's avatar
Guido van Rossum committed
20

21
#define PyFloat_Check(op) PyObject_TypeCheck(op, &PyFloat_Type)
22
#define PyFloat_CheckExact(op) (Py_TYPE(op) == &PyFloat_Type)
Guido van Rossum's avatar
Guido van Rossum committed
23

24 25 26 27 28 29 30 31 32 33 34
#ifdef Py_NAN
#define Py_RETURN_NAN return PyFloat_FromDouble(Py_NAN)
#endif

#define Py_RETURN_INF(sign) do					\
	if (copysign(1., sign) == 1.) {				\
		return PyFloat_FromDouble(Py_HUGE_VAL);	\
	} else {						\
		return PyFloat_FromDouble(-Py_HUGE_VAL);	\
	} while(0)

35 36 37 38
PyAPI_FUNC(double) PyFloat_GetMax(void);
PyAPI_FUNC(double) PyFloat_GetMin(void);
PyAPI_FUNC(PyObject *) PyFloat_GetInfo(void);

39 40
/* Return Python float from string PyObject. */
PyAPI_FUNC(PyObject *) PyFloat_FromString(PyObject*);
41 42

/* Return Python float from C double. */
43
PyAPI_FUNC(PyObject *) PyFloat_FromDouble(double);
Guido van Rossum's avatar
Guido van Rossum committed
44

45 46
/* Extract C double from Python float.  The macro version trades safety for
   speed. */
47
PyAPI_FUNC(double) PyFloat_AsDouble(PyObject *);
48
#define PyFloat_AS_DOUBLE(op) (((PyFloatObject *)(op))->ob_fval)
49

50 51 52 53 54 55 56 57
/* _PyFloat_{Pack,Unpack}{4,8}
 *
 * The struct and pickle (at least) modules need an efficient platform-
 * independent way to store floating-point values as byte strings.
 * The Pack routines produce a string from a C double, and the Unpack
 * routines produce a C double from such a string.  The suffix (4 or 8)
 * specifies the number of bytes in the string.
 *
Michael W. Hudson's avatar
Michael W. Hudson committed
58 59 60 61 62 63 64 65 66 67 68 69
 * On platforms that appear to use (see _PyFloat_Init()) IEEE-754 formats
 * these functions work by copying bits.  On other platforms, the formats the
 * 4- byte format is identical to the IEEE-754 single precision format, and
 * the 8-byte format to the IEEE-754 double precision format, although the
 * packing of INFs and NaNs (if such things exist on the platform) isn't
 * handled correctly, and attempting to unpack a string containing an IEEE
 * INF or NaN will raise an exception.
 *
 * On non-IEEE platforms with more precision, or larger dynamic range, than
 * 754 supports, not all values can be packed; on non-IEEE platforms with less
 * precision, or smaller dynamic range, not all values can be unpacked.  What
 * happens in such cases is partly accidental (alas).
70 71 72 73 74 75 76 77
 */

/* The pack routines write 4 or 8 bytes, starting at p.  le is a bool
 * argument, true if you want the string in little-endian format (exponent
 * last, at p+3 or p+7), false if you want big-endian format (exponent
 * first, at p).
 * Return value:  0 if all is OK, -1 if error (and an exception is
 * set, most likely OverflowError).
Michael W. Hudson's avatar
Michael W. Hudson committed
78 79 80
 * There are two problems on non-IEEE platforms:
 * 1):  What this does is undefined if x is a NaN or infinity.
 * 2):  -0.0 and +0.0 produce the same string.
81 82 83 84
 */
PyAPI_FUNC(int) _PyFloat_Pack4(double x, unsigned char *p, int le);
PyAPI_FUNC(int) _PyFloat_Pack8(double x, unsigned char *p, int le);

85 86 87 88 89
/* Needed for the old way for marshal to store a floating point number.
   Returns the string length copied into p, -1 on error.
 */
PyAPI_FUNC(int) _PyFloat_Repr(double x, char *p, size_t len);

90 91 92 93
/* Used to get the important decimal digits of a double */
PyAPI_FUNC(int) _PyFloat_Digits(char *buf, double v, int *signum);
PyAPI_FUNC(void) _PyFloat_DigitsInit(void);

94 95 96 97 98
/* The unpack routines read 4 or 8 bytes, starting at p.  le is a bool
 * argument, true if the string is in little-endian format (exponent
 * last, at p+3 or p+7), false if big-endian (exponent first, at p).
 * Return value:  The unpacked double.  On error, this is -1.0 and
 * PyErr_Occurred() is true (and an exception is set, most likely
Michael W. Hudson's avatar
Michael W. Hudson committed
99 100
 * OverflowError).  Note that on a non-IEEE platform this will refuse
 * to unpack a string that represents a NaN or infinity.
101 102 103 104
 */
PyAPI_FUNC(double) _PyFloat_Unpack4(const unsigned char *p, int le);
PyAPI_FUNC(double) _PyFloat_Unpack8(const unsigned char *p, int le);

Christian Heimes's avatar
Christian Heimes committed
105
/* free list api */
Georg Brandl's avatar
Georg Brandl committed
106
PyAPI_FUNC(int) PyFloat_ClearFreeList(void);
Christian Heimes's avatar
Christian Heimes committed
107

108 109 110 111 112 113
/* Format the object based on the format_spec, as defined in PEP 3101
   (Advanced String Formatting). */
PyAPI_FUNC(PyObject *) _PyFloat_FormatAdvanced(PyObject *obj,
					       Py_UNICODE *format_spec,
					       Py_ssize_t format_spec_len);

114 115 116 117
#ifdef __cplusplus
}
#endif
#endif /* !Py_FLOATOBJECT_H */