time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

repl.txt (1226B)


      1 
      2 {{alias}}( out[, means] )
      3     Returns an accumulator function which incrementally computes an unbiased
      4     sample covariance matrix.
      5 
      6     If provided a data vector, the accumulator function returns an updated
      7     unbiased sample covariance matrix. If not provided a data vector, the
      8     accumulator function returns the current unbiased sample covariance matrix.
      9 
     10     Parameters
     11     ----------
     12     out: integer|ndarray
     13         Order of the covariance matrix or a square 2-dimensional ndarray for
     14         storing the covariance matrix.
     15 
     16     means: ndarray (optional)
     17         Known means.
     18 
     19     Returns
     20     -------
     21     acc: Function
     22         Accumulator function.
     23 
     24     Examples
     25     --------
     26     > var accumulator = {{alias}}( 2 );
     27     > var out = accumulator()
     28     <ndarray>
     29     > var buf = new {{alias:@stdlib/array/float64}}( 2 );
     30     > var shape = [ 2 ];
     31     > var strides = [ 1 ];
     32     > var v = {{alias:@stdlib/ndarray/ctor}}( 'float64', buf, shape, strides, 0, 'row-major' );
     33     > v.set( 0, 2.0 );
     34     > v.set( 1, 1.0 );
     35     > out = accumulator( v )
     36     <ndarray>
     37     > v.set( 0, -5.0 );
     38     > v.set( 1, 3.14 );
     39     > out = accumulator( v )
     40     <ndarray>
     41     > out = accumulator()
     42     <ndarray>
     43 
     44     See Also
     45     --------
     46