jpayne@69: jpayne@69: /* Float object interface */ jpayne@69: jpayne@69: /* jpayne@69: PyFloatObject represents a (double precision) floating point number. jpayne@69: */ jpayne@69: jpayne@69: #ifndef Py_FLOATOBJECT_H jpayne@69: #define Py_FLOATOBJECT_H jpayne@69: #ifdef __cplusplus jpayne@69: extern "C" { jpayne@69: #endif jpayne@69: jpayne@69: #ifndef Py_LIMITED_API jpayne@69: typedef struct { jpayne@69: PyObject_HEAD jpayne@69: double ob_fval; jpayne@69: } PyFloatObject; jpayne@69: #endif jpayne@69: jpayne@69: PyAPI_DATA(PyTypeObject) PyFloat_Type; jpayne@69: jpayne@69: #define PyFloat_Check(op) PyObject_TypeCheck(op, &PyFloat_Type) jpayne@69: #define PyFloat_CheckExact(op) (Py_TYPE(op) == &PyFloat_Type) jpayne@69: jpayne@69: #ifdef Py_NAN jpayne@69: #define Py_RETURN_NAN return PyFloat_FromDouble(Py_NAN) jpayne@69: #endif jpayne@69: jpayne@69: #define Py_RETURN_INF(sign) do \ jpayne@69: if (copysign(1., sign) == 1.) { \ jpayne@69: return PyFloat_FromDouble(Py_HUGE_VAL); \ jpayne@69: } else { \ jpayne@69: return PyFloat_FromDouble(-Py_HUGE_VAL); \ jpayne@69: } while(0) jpayne@69: jpayne@69: PyAPI_FUNC(double) PyFloat_GetMax(void); jpayne@69: PyAPI_FUNC(double) PyFloat_GetMin(void); jpayne@69: PyAPI_FUNC(PyObject *) PyFloat_GetInfo(void); jpayne@69: jpayne@69: /* Return Python float from string PyObject. */ jpayne@69: PyAPI_FUNC(PyObject *) PyFloat_FromString(PyObject*); jpayne@69: jpayne@69: /* Return Python float from C double. */ jpayne@69: PyAPI_FUNC(PyObject *) PyFloat_FromDouble(double); jpayne@69: jpayne@69: /* Extract C double from Python float. The macro version trades safety for jpayne@69: speed. */ jpayne@69: PyAPI_FUNC(double) PyFloat_AsDouble(PyObject *); jpayne@69: #ifndef Py_LIMITED_API jpayne@69: #define PyFloat_AS_DOUBLE(op) (((PyFloatObject *)(op))->ob_fval) jpayne@69: #endif jpayne@69: jpayne@69: #ifndef Py_LIMITED_API jpayne@69: /* _PyFloat_{Pack,Unpack}{4,8} jpayne@69: * jpayne@69: * The struct and pickle (at least) modules need an efficient platform- jpayne@69: * independent way to store floating-point values as byte strings. jpayne@69: * The Pack routines produce a string from a C double, and the Unpack jpayne@69: * routines produce a C double from such a string. The suffix (4 or 8) jpayne@69: * specifies the number of bytes in the string. jpayne@69: * jpayne@69: * On platforms that appear to use (see _PyFloat_Init()) IEEE-754 formats jpayne@69: * these functions work by copying bits. On other platforms, the formats the jpayne@69: * 4- byte format is identical to the IEEE-754 single precision format, and jpayne@69: * the 8-byte format to the IEEE-754 double precision format, although the jpayne@69: * packing of INFs and NaNs (if such things exist on the platform) isn't jpayne@69: * handled correctly, and attempting to unpack a string containing an IEEE jpayne@69: * INF or NaN will raise an exception. jpayne@69: * jpayne@69: * On non-IEEE platforms with more precision, or larger dynamic range, than jpayne@69: * 754 supports, not all values can be packed; on non-IEEE platforms with less jpayne@69: * precision, or smaller dynamic range, not all values can be unpacked. What jpayne@69: * happens in such cases is partly accidental (alas). jpayne@69: */ jpayne@69: jpayne@69: /* The pack routines write 2, 4 or 8 bytes, starting at p. le is a bool jpayne@69: * argument, true if you want the string in little-endian format (exponent jpayne@69: * last, at p+1, p+3 or p+7), false if you want big-endian format (exponent jpayne@69: * first, at p). jpayne@69: * Return value: 0 if all is OK, -1 if error (and an exception is jpayne@69: * set, most likely OverflowError). jpayne@69: * There are two problems on non-IEEE platforms: jpayne@69: * 1): What this does is undefined if x is a NaN or infinity. jpayne@69: * 2): -0.0 and +0.0 produce the same string. jpayne@69: */ jpayne@69: PyAPI_FUNC(int) _PyFloat_Pack2(double x, unsigned char *p, int le); jpayne@69: PyAPI_FUNC(int) _PyFloat_Pack4(double x, unsigned char *p, int le); jpayne@69: PyAPI_FUNC(int) _PyFloat_Pack8(double x, unsigned char *p, int le); jpayne@69: jpayne@69: /* Needed for the old way for marshal to store a floating point number. jpayne@69: Returns the string length copied into p, -1 on error. jpayne@69: */ jpayne@69: PyAPI_FUNC(int) _PyFloat_Repr(double x, char *p, size_t len); jpayne@69: jpayne@69: /* Used to get the important decimal digits of a double */ jpayne@69: PyAPI_FUNC(int) _PyFloat_Digits(char *buf, double v, int *signum); jpayne@69: PyAPI_FUNC(void) _PyFloat_DigitsInit(void); jpayne@69: jpayne@69: /* The unpack routines read 2, 4 or 8 bytes, starting at p. le is a bool jpayne@69: * argument, true if the string is in little-endian format (exponent jpayne@69: * last, at p+1, p+3 or p+7), false if big-endian (exponent first, at p). jpayne@69: * Return value: The unpacked double. On error, this is -1.0 and jpayne@69: * PyErr_Occurred() is true (and an exception is set, most likely jpayne@69: * OverflowError). Note that on a non-IEEE platform this will refuse jpayne@69: * to unpack a string that represents a NaN or infinity. jpayne@69: */ jpayne@69: PyAPI_FUNC(double) _PyFloat_Unpack2(const unsigned char *p, int le); jpayne@69: PyAPI_FUNC(double) _PyFloat_Unpack4(const unsigned char *p, int le); jpayne@69: PyAPI_FUNC(double) _PyFloat_Unpack8(const unsigned char *p, int le); jpayne@69: jpayne@69: /* free list api */ jpayne@69: PyAPI_FUNC(int) PyFloat_ClearFreeList(void); jpayne@69: jpayne@69: PyAPI_FUNC(void) _PyFloat_DebugMallocStats(FILE* out); jpayne@69: jpayne@69: /* Format the object based on the format_spec, as defined in PEP 3101 jpayne@69: (Advanced String Formatting). */ jpayne@69: PyAPI_FUNC(int) _PyFloat_FormatAdvancedWriter( jpayne@69: _PyUnicodeWriter *writer, jpayne@69: PyObject *obj, jpayne@69: PyObject *format_spec, jpayne@69: Py_ssize_t start, jpayne@69: Py_ssize_t end); jpayne@69: #endif /* Py_LIMITED_API */ jpayne@69: jpayne@69: #ifdef __cplusplus jpayne@69: } jpayne@69: #endif jpayne@69: #endif /* !Py_FLOATOBJECT_H */