All files index.js

100% Statements 70/70
100% Branches 1/1
100% Functions 0/0
100% Lines 70/70

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 713x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x  
/**
* @license Apache-2.0
*
* Copyright (c) 2026 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
 
'use strict';
 
/**
* Compute the covariance of two ndarrays provided known means and using a one-pass textbook algorithm.
*
* @module @stdlib/stats/covarmtk
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var ndarray = require( '@stdlib/ndarray/ctor' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
* var covarmtk = require( '@stdlib/stats/covarmtk' );
*
* // Create data buffers:
* var xbuf = new Float64Array( [ 1.0, -2.0, 2.0 ] );
* var ybuf = new Float64Array( [ 2.0, -2.0, 1.0 ] );
*
* // Define the shape of the input arrays:
* var sh = [ 3 ];
*
* // Define the array strides:
* var sx = [ 1 ];
* var sy = [ 1 ];
*
* // Define the index offsets:
* var ox = 0;
* var oy = 0;
*
* // Create input ndarrays:
* var x = new ndarray( 'float64', xbuf, sh, sx, ox, 'row-major' );
* var y = new ndarray( 'float64', ybuf, sh, sy, oy, 'row-major' );
*
* // Define correction and means:
* var correction = scalar2ndarray( 1.0, { 'dtype': 'float64' } );
* var meanx = scalar2ndarray( 1.0/3.0, { 'dtype': 'float64' } );
* var meany = scalar2ndarray( 1.0/3.0, { 'dtype': 'float64' } );
*
* // Perform reduction:
* var out = covarmtk( x, y, correction, meanx, meany );
* // returns <ndarray>[ ~3.8333 ]
*/
 
// MODULES //
 
var main = require( './main.js' );
 
 
// EXPORTS //
 
module.exports = main;
 
// exports: { "assign": "main.assign" }