summaryrefslogtreecommitdiff
path: root/Doc/c-api/float.rst
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2008-01-19 22:08:21 +0000
committerGeorg Brandl <georg@python.org>2008-01-19 22:08:21 +0000
commitf6842722df69a40e841c045d42a538bb5d6bbbf6 (patch)
tree2b8bb1b6bb5908ed66ed72f7c84de0a34ddc7542 /Doc/c-api/float.rst
parent8b506e7a2d4e8cb6ffd6b7f2845e45aa92daa4d4 (diff)
downloadcpython-git-f6842722df69a40e841c045d42a538bb5d6bbbf6.tar.gz
Split the monstrous C API manual files in smaller parts.
Diffstat (limited to 'Doc/c-api/float.rst')
-rw-r--r--Doc/c-api/float.rst86
1 files changed, 86 insertions, 0 deletions
diff --git a/Doc/c-api/float.rst b/Doc/c-api/float.rst
new file mode 100644
index 0000000000..505c19e151
--- /dev/null
+++ b/Doc/c-api/float.rst
@@ -0,0 +1,86 @@
+.. highlightlang:: c
+
+.. _floatobjects:
+
+Floating Point Objects
+----------------------
+
+.. index:: object: floating point
+
+
+.. ctype:: PyFloatObject
+
+ This subtype of :ctype:`PyObject` represents a Python floating point object.
+
+
+.. cvar:: PyTypeObject PyFloat_Type
+
+ .. index:: single: FloatType (in modules types)
+
+ This instance of :ctype:`PyTypeObject` represents the Python floating point
+ type. This is the same object as ``float`` and ``types.FloatType``.
+
+
+.. cfunction:: int PyFloat_Check(PyObject *p)
+
+ Return true if its argument is a :ctype:`PyFloatObject` or a subtype of
+ :ctype:`PyFloatObject`.
+
+ .. versionchanged:: 2.2
+ Allowed subtypes to be accepted.
+
+
+.. cfunction:: int PyFloat_CheckExact(PyObject *p)
+
+ Return true if its argument is a :ctype:`PyFloatObject`, but not a subtype of
+ :ctype:`PyFloatObject`.
+
+ .. versionadded:: 2.2
+
+
+.. cfunction:: PyObject* PyFloat_FromString(PyObject *str, char **pend)
+
+ Create a :ctype:`PyFloatObject` object based on the string value in *str*, or
+ *NULL* on failure. The *pend* argument is ignored. It remains only for
+ backward compatibility.
+
+
+.. cfunction:: PyObject* PyFloat_FromDouble(double v)
+
+ Create a :ctype:`PyFloatObject` object from *v*, or *NULL* on failure.
+
+
+.. cfunction:: double PyFloat_AsDouble(PyObject *pyfloat)
+
+ Return a C :ctype:`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.
+
+
+.. cfunction:: double PyFloat_AS_DOUBLE(PyObject *pyfloat)
+
+ Return a C :ctype:`double` representation of the contents of *pyfloat*, but
+ without error checking.
+
+
+.. cfunction:: PyObject* PyFloat_GetInfo(void)
+
+ Return a structseq instance which contains information about the
+ precision, minimum and maximum values of a float. It's a thin wrapper
+ around the header file :file:`float.h`.
+
+ .. versionadded:: 2.6
+
+
+.. cfunction:: double PyFloat_GetMax(void)
+
+ Return the maximum representable finite float *DBL_MAX* as C :ctype:`double`.
+
+ .. versionadded:: 2.6
+
+
+.. cfunction:: double PyFloat_GetMin(void)
+
+ Return the minimum normalized positive float *DBL_MIN* as C :ctype:`double`.
+
+ .. versionadded:: 2.6