mirror of
https://github.com/python/cpython.git
synced 2025-12-08 06:10:17 +00:00
gh-141004: Document Py_HUGE_VAL/IS_FINITE/IS_INFINITE/IS_NAN (#141544)
Co-authored-by: Victor Stinner <vstinner@python.org> Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
This commit is contained in:
parent
58f3fe0d9b
commit
630cd37bfa
1 changed files with 37 additions and 1 deletions
|
|
@ -87,7 +87,7 @@ Floating-Point Objects
|
||||||
``<math.h>`` header.
|
``<math.h>`` header.
|
||||||
|
|
||||||
.. deprecated:: 3.15
|
.. deprecated:: 3.15
|
||||||
The macro is soft deprecated.
|
The macro is :term:`soft deprecated`.
|
||||||
|
|
||||||
|
|
||||||
.. c:macro:: Py_NAN
|
.. c:macro:: Py_NAN
|
||||||
|
|
@ -99,6 +99,14 @@ Floating-Point Objects
|
||||||
the C11 standard ``<math.h>`` header.
|
the C11 standard ``<math.h>`` header.
|
||||||
|
|
||||||
|
|
||||||
|
.. c:macro:: Py_HUGE_VAL
|
||||||
|
|
||||||
|
Equivalent to :c:macro:`!INFINITY`.
|
||||||
|
|
||||||
|
.. deprecated:: 3.14
|
||||||
|
The macro is :term:`soft deprecated`.
|
||||||
|
|
||||||
|
|
||||||
.. c:macro:: Py_MATH_E
|
.. c:macro:: Py_MATH_E
|
||||||
|
|
||||||
The definition (accurate for a :c:expr:`double` type) of the :data:`math.e` constant.
|
The definition (accurate for a :c:expr:`double` type) of the :data:`math.e` constant.
|
||||||
|
|
@ -147,6 +155,34 @@ Floating-Point Objects
|
||||||
return PyFloat_FromDouble(copysign(INFINITY, sign));
|
return PyFloat_FromDouble(copysign(INFINITY, sign));
|
||||||
|
|
||||||
|
|
||||||
|
.. c:macro:: Py_IS_FINITE(X)
|
||||||
|
|
||||||
|
Return ``1`` if the given floating-point number *X* is finite,
|
||||||
|
that is, it is normal, subnormal or zero, but not infinite or NaN.
|
||||||
|
Return ``0`` otherwise.
|
||||||
|
|
||||||
|
.. deprecated:: 3.14
|
||||||
|
The macro is :term:`soft deprecated`. Use :c:macro:`!isfinite` instead.
|
||||||
|
|
||||||
|
|
||||||
|
.. c:macro:: Py_IS_INFINITY(X)
|
||||||
|
|
||||||
|
Return ``1`` if the given floating-point number *X* is positive or negative
|
||||||
|
infinity. Return ``0`` otherwise.
|
||||||
|
|
||||||
|
.. deprecated:: 3.14
|
||||||
|
The macro is :term:`soft deprecated`. Use :c:macro:`!isinf` instead.
|
||||||
|
|
||||||
|
|
||||||
|
.. c:macro:: Py_IS_NAN(X)
|
||||||
|
|
||||||
|
Return ``1`` if the given floating-point number *X* is a not-a-number (NaN)
|
||||||
|
value. Return ``0`` otherwise.
|
||||||
|
|
||||||
|
.. deprecated:: 3.14
|
||||||
|
The macro is :term:`soft deprecated`. Use :c:macro:`!isnan` instead.
|
||||||
|
|
||||||
|
|
||||||
Pack and Unpack functions
|
Pack and Unpack functions
|
||||||
-------------------------
|
-------------------------
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue