diff options
author | Raphael Kruse <65403623+rk-mlu@users.noreply.github.com> | 2020-05-18 18:22:29 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-05-18 11:22:29 -0500 |
commit | 0eb532de60c9caaaa568ea294e7e1427265b6552 (patch) | |
tree | baa092d0d339bbb9df67f65411e5104ad4975178 /doc/source/reference/c-api | |
parent | 5e611af4db767f7b038af4a2138f11af5316aa13 (diff) | |
download | numpy-0eb532de60c9caaaa568ea294e7e1427265b6552.tar.gz |
DOC: Calrify tiny/xmin in finfo and machar (gh-16253)
This commit adds a note to the documentation of finfo clarifying that
the attribute `tiny` does not represent the smallest positive usable
number. Instead it refers to the smallest positive number with there
being no leading 0's in the mantisse (normalized floating point number).
Alternatively, `tiny` represents the smallest positive floating point
number with full precision. The smallest positive subnormal floating
point number is typically orders of magnitudes smaller, but has reduced
precision since leading 0's in the mantisse are used to allow smaller
exponents than indicated by `minexp`.
The commit also adds a brief clarification to the docstring of machar.
Closes #16252
Co-authored-by: Anirudh Subramanian <anirudh2290@apache.org>
Co-authored-by: Ross Barnowski <rossbar@berkeley.edu>
Diffstat (limited to 'doc/source/reference/c-api')
0 files changed, 0 insertions, 0 deletions