time-to-botec/js/node_modules/@stdlib/stats/incr/covmat/docs/repl.txt
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

47 lines
1.2 KiB
Plaintext

{{alias}}( out[, means] )
Returns an accumulator function which incrementally computes an unbiased
sample covariance matrix.
If provided a data vector, the accumulator function returns an updated
unbiased sample covariance matrix. If not provided a data vector, the
accumulator function returns the current unbiased sample covariance matrix.
Parameters
----------
out: integer|ndarray
Order of the covariance matrix or a square 2-dimensional ndarray for
storing the covariance 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
--------