Mercurial > repos > rliterman > csp2

annotate CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/include/python3.8/floatobject.h @ 69:33d812a61356

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
author jpayne
date Tue, 18 Mar 2025 17:55:14 -0400
parents
children
rev   line source
jpayne@69 1
jpayne@69 2 /* Float object interface */
jpayne@69 3
jpayne@69 4 /*
jpayne@69 5 PyFloatObject represents a (double precision) floating point number.
jpayne@69 6 */
jpayne@69 7
jpayne@69 8 #ifndef Py_FLOATOBJECT_H
jpayne@69 9 #define Py_FLOATOBJECT_H
jpayne@69 10 #ifdef __cplusplus
jpayne@69 11 extern "C" {
jpayne@69 12 #endif
jpayne@69 13
jpayne@69 14 #ifndef Py_LIMITED_API
jpayne@69 15 typedef struct {
jpayne@69 16 PyObject_HEAD
jpayne@69 17 double ob_fval;
jpayne@69 18 } PyFloatObject;
jpayne@69 19 #endif
jpayne@69 20
jpayne@69 21 PyAPI_DATA(PyTypeObject) PyFloat_Type;
jpayne@69 22
jpayne@69 23 #define PyFloat_Check(op) PyObject_TypeCheck(op, &PyFloat_Type)
jpayne@69 24 #define PyFloat_CheckExact(op) (Py_TYPE(op) == &PyFloat_Type)
jpayne@69 25
jpayne@69 26 #ifdef Py_NAN
jpayne@69 27 #define Py_RETURN_NAN return PyFloat_FromDouble(Py_NAN)
jpayne@69 28 #endif
jpayne@69 29
jpayne@69 30 #define Py_RETURN_INF(sign) do \
jpayne@69 31 if (copysign(1., sign) == 1.) { \
jpayne@69 32 return PyFloat_FromDouble(Py_HUGE_VAL); \
jpayne@69 33 } else { \
jpayne@69 34 return PyFloat_FromDouble(-Py_HUGE_VAL); \
jpayne@69 35 } while(0)
jpayne@69 36
jpayne@69 37 PyAPI_FUNC(double) PyFloat_GetMax(void);
jpayne@69 38 PyAPI_FUNC(double) PyFloat_GetMin(void);
jpayne@69 39 PyAPI_FUNC(PyObject *) PyFloat_GetInfo(void);
jpayne@69 40
jpayne@69 41 /* Return Python float from string PyObject. */
jpayne@69 42 PyAPI_FUNC(PyObject *) PyFloat_FromString(PyObject*);
jpayne@69 43
jpayne@69 44 /* Return Python float from C double. */
jpayne@69 45 PyAPI_FUNC(PyObject *) PyFloat_FromDouble(double);
jpayne@69 46
jpayne@69 47 /* Extract C double from Python float. The macro version trades safety for
jpayne@69 48 speed. */
jpayne@69 49 PyAPI_FUNC(double) PyFloat_AsDouble(PyObject *);
jpayne@69 50 #ifndef Py_LIMITED_API
jpayne@69 51 #define PyFloat_AS_DOUBLE(op) (((PyFloatObject *)(op))->ob_fval)
jpayne@69 52 #endif
jpayne@69 53
jpayne@69 54 #ifndef Py_LIMITED_API
jpayne@69 55 /* _PyFloat_{Pack,Unpack}{4,8}
jpayne@69 56 *
jpayne@69 57 * The struct and pickle (at least) modules need an efficient platform-
jpayne@69 58 * independent way to store floating-point values as byte strings.
jpayne@69 59 * The Pack routines produce a string from a C double, and the Unpack
jpayne@69 60 * routines produce a C double from such a string. The suffix (4 or 8)
jpayne@69 61 * specifies the number of bytes in the string.
jpayne@69 62 *
jpayne@69 63 * On platforms that appear to use (see _PyFloat_Init()) IEEE-754 formats
jpayne@69 64 * these functions work by copying bits. On other platforms, the formats the
jpayne@69 65 * 4- byte format is identical to the IEEE-754 single precision format, and
jpayne@69 66 * the 8-byte format to the IEEE-754 double precision format, although the
jpayne@69 67 * packing of INFs and NaNs (if such things exist on the platform) isn't
jpayne@69 68 * handled correctly, and attempting to unpack a string containing an IEEE
jpayne@69 69 * INF or NaN will raise an exception.
jpayne@69 70 *
jpayne@69 71 * On non-IEEE platforms with more precision, or larger dynamic range, than
jpayne@69 72 * 754 supports, not all values can be packed; on non-IEEE platforms with less
jpayne@69 73 * precision, or smaller dynamic range, not all values can be unpacked. What
jpayne@69 74 * happens in such cases is partly accidental (alas).
jpayne@69 75 */
jpayne@69 76
jpayne@69 77 /* The pack routines write 2, 4 or 8 bytes, starting at p. le is a bool
jpayne@69 78 * argument, true if you want the string in little-endian format (exponent
jpayne@69 79 * last, at p+1, p+3 or p+7), false if you want big-endian format (exponent
jpayne@69 80 * first, at p).
jpayne@69 81 * Return value: 0 if all is OK, -1 if error (and an exception is
jpayne@69 82 * set, most likely OverflowError).
jpayne@69 83 * There are two problems on non-IEEE platforms:
jpayne@69 84 * 1): What this does is undefined if x is a NaN or infinity.
jpayne@69 85 * 2): -0.0 and +0.0 produce the same string.
jpayne@69 86 */
jpayne@69 87 PyAPI_FUNC(int) _PyFloat_Pack2(double x, unsigned char *p, int le);
jpayne@69 88 PyAPI_FUNC(int) _PyFloat_Pack4(double x, unsigned char *p, int le);
jpayne@69 89 PyAPI_FUNC(int) _PyFloat_Pack8(double x, unsigned char *p, int le);
jpayne@69 90
jpayne@69 91 /* Needed for the old way for marshal to store a floating point number.
jpayne@69 92 Returns the string length copied into p, -1 on error.
jpayne@69 93 */
jpayne@69 94 PyAPI_FUNC(int) _PyFloat_Repr(double x, char *p, size_t len);
jpayne@69 95
jpayne@69 96 /* Used to get the important decimal digits of a double */
jpayne@69 97 PyAPI_FUNC(int) _PyFloat_Digits(char *buf, double v, int *signum);
jpayne@69 98 PyAPI_FUNC(void) _PyFloat_DigitsInit(void);
jpayne@69 99
jpayne@69 100 /* The unpack routines read 2, 4 or 8 bytes, starting at p. le is a bool
jpayne@69 101 * argument, true if the string is in little-endian format (exponent
jpayne@69 102 * last, at p+1, p+3 or p+7), false if big-endian (exponent first, at p).
jpayne@69 103 * Return value: The unpacked double. On error, this is -1.0 and
jpayne@69 104 * PyErr_Occurred() is true (and an exception is set, most likely
jpayne@69 105 * OverflowError). Note that on a non-IEEE platform this will refuse
jpayne@69 106 * to unpack a string that represents a NaN or infinity.
jpayne@69 107 */
jpayne@69 108 PyAPI_FUNC(double) _PyFloat_Unpack2(const unsigned char *p, int le);
jpayne@69 109 PyAPI_FUNC(double) _PyFloat_Unpack4(const unsigned char *p, int le);
jpayne@69 110 PyAPI_FUNC(double) _PyFloat_Unpack8(const unsigned char *p, int le);
jpayne@69 111
jpayne@69 112 /* free list api */
jpayne@69 113 PyAPI_FUNC(int) PyFloat_ClearFreeList(void);
jpayne@69 114
jpayne@69 115 PyAPI_FUNC(void) _PyFloat_DebugMallocStats(FILE* out);
jpayne@69 116
jpayne@69 117 /* Format the object based on the format_spec, as defined in PEP 3101
jpayne@69 118 (Advanced String Formatting). */
jpayne@69 119 PyAPI_FUNC(int) _PyFloat_FormatAdvancedWriter(
jpayne@69 120 _PyUnicodeWriter *writer,
jpayne@69 121 PyObject *obj,
jpayne@69 122 PyObject *format_spec,
jpayne@69 123 Py_ssize_t start,
jpayne@69 124 Py_ssize_t end);
jpayne@69 125 #endif /* Py_LIMITED_API */
jpayne@69 126
jpayne@69 127 #ifdef __cplusplus
jpayne@69 128 }
jpayne@69 129 #endif
jpayne@69 130 #endif /* !Py_FLOATOBJECT_H */