summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--numpy/core/getlimits.py8
1 files changed, 7 insertions, 1 deletions
diff --git a/numpy/core/getlimits.py b/numpy/core/getlimits.py
index 4149a5303..b6f65f848 100644
--- a/numpy/core/getlimits.py
+++ b/numpy/core/getlimits.py
@@ -423,7 +423,8 @@ class finfo:
Parameters
----------
dtype : float, dtype, or instance
- Kind of floating point data-type about which to get information.
+ Kind of floating point or complex floating point
+ data-type about which to get information.
See Also
--------
@@ -445,6 +446,11 @@ class finfo:
fill the gap between 0 and ``smallest_normal``. However, subnormal numbers
may have significantly reduced precision [2]_.
+ This function can also be used for complex data types as well. If used,
+ the output will be the same as the corresponding real float type
+ (e.g. numpy.finfo(numpy.csingle) is the same as numpy.finfo(numpy.single)).
+ However, the output is true for the real and imaginary components.
+
References
----------
.. [1] IEEE Standard for Floating-Point Arithmetic, IEEE Std 754-2008,