@stdlib/stats
Version:
Standard library statistical functions.
41 lines (31 loc) • 956 B
Plain Text
{{alias}}( [mx, my] )
Returns an accumulator function which incrementally computes a sample
Pearson product-moment correlation coefficient.
If provided values, the accumulator function returns an updated sample
correlation coefficient. If not provided values, the accumulator function
returns the current sample correlation coefficient.
If provided `NaN` or a value which, when used in computations, results in
`NaN`, the accumulated value is `NaN` for all future invocations.
Parameters
----------
mx: number (optional)
Known mean.
my: number (optional)
Known mean.
Returns
-------
acc: Function
Accumulator function.
Examples
--------
> var accumulator = {{alias}}();
> var r = accumulator()
null
> r = accumulator( 2.0, 1.0 )
0.0
> r = accumulator( -5.0, 3.14 )
~-1.0
> r = accumulator()
~-1.0
See Also
--------