1 .. highlightlang:: c 2 3 .. _floatobjects: 4 5 Floating Point Objects 6 ---------------------- 7 8 .. index:: object: floating point 9 10 11 .. c:type:: PyFloatObject 12 13 This subtype of :c:type:`PyObject` represents a Python floating point object. 14 15 16 .. c:var:: PyTypeObject PyFloat_Type 17 18 This instance of :c:type:`PyTypeObject` represents the Python floating point 19 type. This is the same object as :class:`float` in the Python layer. 20 21 22 .. c:function:: int PyFloat_Check(PyObject *p) 23 24 Return true if its argument is a :c:type:`PyFloatObject` or a subtype of 25 :c:type:`PyFloatObject`. 26 27 28 .. c:function:: int PyFloat_CheckExact(PyObject *p) 29 30 Return true if its argument is a :c:type:`PyFloatObject`, but not a subtype of 31 :c:type:`PyFloatObject`. 32 33 34 .. c:function:: PyObject* PyFloat_FromString(PyObject *str) 35 36 Create a :c:type:`PyFloatObject` object based on the string value in *str*, or 37 *NULL* on failure. 38 39 40 .. c:function:: PyObject* PyFloat_FromDouble(double v) 41 42 Create a :c:type:`PyFloatObject` object from *v*, or *NULL* on failure. 43 44 45 .. c:function:: double PyFloat_AsDouble(PyObject *pyfloat) 46 47 Return a C :c:type:`double` representation of the contents of *pyfloat*. If 48 *pyfloat* is not a Python floating point object but has a :meth:`__float__` 49 method, this method will first be called to convert *pyfloat* into a float. 50 This method returns ``-1.0`` upon failure, so one should call 51 :c:func:`PyErr_Occurred` to check for errors. 52 53 54 .. c:function:: double PyFloat_AS_DOUBLE(PyObject *pyfloat) 55 56 Return a C :c:type:`double` representation of the contents of *pyfloat*, but 57 without error checking. 58 59 60 .. c:function:: PyObject* PyFloat_GetInfo(void) 61 62 Return a structseq instance which contains information about the 63 precision, minimum and maximum values of a float. It's a thin wrapper 64 around the header file :file:`float.h`. 65 66 67 .. c:function:: double PyFloat_GetMax() 68 69 Return the maximum representable finite float *DBL_MAX* as C :c:type:`double`. 70 71 72 .. c:function:: double PyFloat_GetMin() 73 74 Return the minimum normalized positive float *DBL_MIN* as C :c:type:`double`. 75 76 .. c:function:: int PyFloat_ClearFreeList() 77 78 Clear the float free list. Return the number of items that could not 79 be freed. 80
