Skip to content

Commit 14bab7a

Browse files
rhettingermiss-islington
authored andcommitted
NormalDist.overlap() only needs one example (GH-12218)
1 parent 16e6f7d commit 14bab7a

File tree

1 file changed

+4
-17
lines changed

1 file changed

+4
-17
lines changed

Doc/library/statistics.rst

Lines changed: 4 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -553,23 +553,10 @@ of applications in statistics.
553553

554554
Compute the `overlapping coefficient (OVL)
555555
<http://www.iceaaonline.com/ready/wp-content/uploads/2014/06/MM-9-Presentation-Meet-the-Overlapping-Coefficient-A-Measure-for-Elevator-Speeches.pdf>`_
556-
between two normal distributions.
557-
558-
Measures the agreement between two normal probability distributions.
559-
Returns a value between 0.0 and 1.0 giving the overlapping area for
560-
two probability density functions.
561-
562-
In this `example from John M. Linacre
563-
<https://www.rasch.org/rmt/rmt101r.htm>`_ about 80% of each
564-
distribution overlaps the other:
565-
566-
.. doctest::
567-
568-
>>> N1 = NormalDist(2.4, 1.6)
569-
>>> N2 = NormalDist(3.2, 2.0)
570-
>>> ovl = N1.overlap(N2)
571-
>>> f'{ovl * 100.0 :.1f}%'
572-
'80.4%'
556+
between two normal distributions, giving a measure of agreement.
557+
Returns a value between 0.0 and 1.0 giving `the overlapping area for
558+
two probability density functions
559+
<https://www.rasch.org/rmt/rmt101r.htm>`_.
573560

574561
Instances of :class:`NormalDist` support addition, subtraction,
575562
multiplication and division by a constant. These operations

0 commit comments

Comments
 (0)