@stdlib/stats
Version:
Standard library statistical functions.
47 lines (38 loc) • 1.23 kB
Plain Text
{{alias}}( out[, means] )
Returns an accumulator function which incrementally computes a sample
Pearson product-moment correlation matrix.
If provided a data vector, the accumulator function returns an updated
sample correlation matrix. If not provided a data vector, the accumulator
function returns the current sample correlation matrix.
Parameters
----------
out: integer|ndarray
Order of the correlation matrix or a square 2-dimensional ndarray for
storing the correlation matrix.
means: ndarray (optional)
Known means.
Returns
-------
acc: Function
Accumulator function.
Examples
--------
> var accumulator = {{alias}}( 2 );
> var out = accumulator()
<ndarray>
> var buf = new {{alias:@stdlib/array/float64}}( 2 );
> var shape = [ 2 ];
> var strides = [ 1 ];
> var v = {{alias:@stdlib/ndarray/ctor}}( 'float64', buf, shape, strides, 0, 'row-major' );
> v.set( 0, 2.0 );
> v.set( 1, 1.0 );
> out = accumulator( v )
<ndarray>
> v.set( 0, -5.0 );
> v.set( 1, 3.14 );
> out = accumulator( v )
<ndarray>
> out = accumulator()
<ndarray>
See Also
--------