@stdlib/stats
Version:
Standard library statistical functions.
33 lines (25 loc) • 738 B
Plain Text
{{alias}}()
Returns an accumulator function which incrementally computes a harmonic
mean.
If provided a value, the accumulator function returns an updated harmonic
mean. If not provided a value, the accumulator function returns the current
harmonic mean.
If provided `NaN` or a value which, when used in computations, results in
`NaN`, the accumulated value is `NaN` for all future invocations.
Returns
-------
acc: Function
Accumulator function.
Examples
--------
> var accumulator = {{alias}}();
> var v = accumulator()
null
> v = accumulator( 2.0 )
2.0
> v = accumulator( 5.0 )
~2.86
> v = accumulator()
~2.86
See Also
--------