diff options
Diffstat (limited to 'Doc/c-api/float.rst')
| -rw-r--r-- | Doc/c-api/float.rst | 55 |
1 files changed, 46 insertions, 9 deletions
diff --git a/Doc/c-api/float.rst b/Doc/c-api/float.rst index bfc28a7..3aa7d18 100644 --- a/Doc/c-api/float.rst +++ b/Doc/c-api/float.rst @@ -1,4 +1,4 @@ -.. highlight:: c +.. highlightlang:: c .. _floatobjects: @@ -15,8 +15,10 @@ Floating Point Objects .. c:var:: PyTypeObject PyFloat_Type + .. index:: single: FloatType (in modules types) + This instance of :c:type:`PyTypeObject` represents the Python floating point - type. This is the same object as :class:`float` in the Python layer. + type. This is the same object as ``float`` and ``types.FloatType``. .. c:function:: int PyFloat_Check(PyObject *p) @@ -24,22 +26,28 @@ Floating Point Objects Return true if its argument is a :c:type:`PyFloatObject` or a subtype of :c:type:`PyFloatObject`. + .. versionchanged:: 2.2 + Allowed subtypes to be accepted. + .. c:function:: int PyFloat_CheckExact(PyObject *p) Return true if its argument is a :c:type:`PyFloatObject`, but not a subtype of :c:type:`PyFloatObject`. + .. versionadded:: 2.2 + -.. c:function:: PyObject* PyFloat_FromString(PyObject *str) +.. c:function:: PyObject* PyFloat_FromString(PyObject *str, char **pend) Create a :c:type:`PyFloatObject` object based on the string value in *str*, or - ``NULL`` on failure. + *NULL* on failure. The *pend* argument is ignored. It remains only for + backward compatibility. .. c:function:: PyObject* PyFloat_FromDouble(double v) - Create a :c:type:`PyFloatObject` object from *v*, or ``NULL`` on failure. + Create a :c:type:`PyFloatObject` object from *v*, or *NULL* on failure. .. c:function:: double PyFloat_AsDouble(PyObject *pyfloat) @@ -47,13 +55,9 @@ Floating Point Objects Return a C :c:type:`double` representation of the contents of *pyfloat*. If *pyfloat* is not a Python floating point object but has a :meth:`__float__` method, this method will first be called to convert *pyfloat* into a float. - If ``__float__()`` is not defined then it falls back to :meth:`__index__`. This method returns ``-1.0`` upon failure, so one should call :c:func:`PyErr_Occurred` to check for errors. - .. versionchanged:: 3.8 - Use :meth:`__index__` if available. - .. c:function:: double PyFloat_AS_DOUBLE(PyObject *pyfloat) @@ -67,17 +71,50 @@ Floating Point Objects precision, minimum and maximum values of a float. It's a thin wrapper around the header file :file:`float.h`. + .. versionadded:: 2.6 + .. c:function:: double PyFloat_GetMax() Return the maximum representable finite float *DBL_MAX* as C :c:type:`double`. + .. versionadded:: 2.6 + .. c:function:: double PyFloat_GetMin() Return the minimum normalized positive float *DBL_MIN* as C :c:type:`double`. + .. versionadded:: 2.6 + + .. c:function:: int PyFloat_ClearFreeList() Clear the float free list. Return the number of items that could not be freed. + + .. versionadded:: 2.6 + + +.. c:function:: void PyFloat_AsString(char *buf, PyFloatObject *v) + + Convert the argument *v* to a string, using the same rules as + :func:`str`. The length of *buf* should be at least 100. + + This function is unsafe to call because it writes to a buffer whose + length it does not know. + + .. deprecated:: 2.7 + Use :func:`PyObject_Str` or :func:`PyOS_double_to_string` instead. + + +.. c:function:: void PyFloat_AsReprString(char *buf, PyFloatObject *v) + + Same as PyFloat_AsString, except uses the same rules as + :func:`repr`. The length of *buf* should be at least 100. + + This function is unsafe to call because it writes to a buffer whose + length it does not know. + + .. deprecated:: 2.7 + Use :func:`PyObject_Repr` or :func:`PyOS_double_to_string` instead. |