NormalDist.overlap() only needs one example (GH-12218)

This commit is contained in:
Raymond Hettinger 2019-03-07 08:54:31 -08:00 committed by Miss Islington (bot)
parent 16e6f7dee7
commit 14bab7abee
1 changed files with 4 additions and 17 deletions

View File

@ -553,23 +553,10 @@ of applications in statistics.
Compute the `overlapping coefficient (OVL)
<http://www.iceaaonline.com/ready/wp-content/uploads/2014/06/MM-9-Presentation-Meet-the-Overlapping-Coefficient-A-Measure-for-Elevator-Speeches.pdf>`_
between two normal distributions.
Measures the agreement between two normal probability distributions.
Returns a value between 0.0 and 1.0 giving the overlapping area for
two probability density functions.
In this `example from John M. Linacre
<https://www.rasch.org/rmt/rmt101r.htm>`_ about 80% of each
distribution overlaps the other:
.. doctest::
>>> N1 = NormalDist(2.4, 1.6)
>>> N2 = NormalDist(3.2, 2.0)
>>> ovl = N1.overlap(N2)
>>> f'{ovl * 100.0 :.1f}%'
'80.4%'
between two normal distributions, giving a measure of agreement.
Returns a value between 0.0 and 1.0 giving `the overlapping area for
two probability density functions
<https://www.rasch.org/rmt/rmt101r.htm>`_.
Instances of :class:`NormalDist` support addition, subtraction,
multiplication and division by a constant. These operations