diff options
| author | Raymond Hettinger <rhettinger@users.noreply.github.com> | 2019-11-07 05:50:44 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-11-07 05:50:44 (GMT) |
| commit | 7f460494d2309ace004a400bae8fc59134dc325c (patch) | |
| tree | 7819822a6797dbbed59338eea2838233c1a3dda8 /Doc/library/statistics.rst | |
| parent | 519cb8772a9745b1c7d8218cabcd2f96ceda4d62 (diff) | |
| download | cpython-7f460494d2309ace004a400bae8fc59134dc325c.zip cpython-7f460494d2309ace004a400bae8fc59134dc325c.tar.gz cpython-7f460494d2309ace004a400bae8fc59134dc325c.tar.bz2 | |
bpo-38382: Document the early-out behavior for a zero (GH-17037)
Diffstat (limited to 'Doc/library/statistics.rst')
| -rw-r--r-- | Doc/library/statistics.rst | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/Doc/library/statistics.rst b/Doc/library/statistics.rst index a702b24..00c0b53 100644 --- a/Doc/library/statistics.rst +++ b/Doc/library/statistics.rst @@ -164,7 +164,8 @@ However, for reading convenience, most of the examples show sorted sequences. The harmonic mean, sometimes called the subcontrary mean, is the reciprocal of the arithmetic :func:`mean` of the reciprocals of the data. For example, the harmonic mean of three values *a*, *b* and *c* - will be equivalent to ``3/(1/a + 1/b + 1/c)``. + will be equivalent to ``3/(1/a + 1/b + 1/c)``. If one of the values + is zero, the result will be zero. The harmonic mean is a type of average, a measure of the central location of the data. It is often appropriate when averaging @@ -190,6 +191,10 @@ However, for reading convenience, most of the examples show sorted sequences. :exc:`StatisticsError` is raised if *data* is empty, or any element is less than zero. + The current algorithm has an early-out when it encounters a zero + in the input. This means that the subsequent inputs are not tested + for validity. (This behavior may change in the future.) + .. versionadded:: 3.6 |