All files / stats/incr/nancovariance/lib index.js

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

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 551x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x  
/**
* @license Apache-2.0
*
* Copyright (c) 2020 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 an incremental sample covariance while ignoring NaN values.
*
* @module @stdlib/stats/incr/nancovariance
*
* @example
* var nancovariance = require( '@stdlib/stats/incr/nancovariance' );
*
* var acc = nancovariance();
*
* var cov = acc();
* // returns null
*
* cov = acc( 2.0, 1.0 );
* // returns null (covariance is undefined for a single pair)
*
* cov = acc( NaN , 5.0 );
* // returns null (An input with a NaN is ignored)
*
* cov = acc( 4.0, 5.0 );
* // returns 4.0
*
* cov = acc();
* // returns 4.0
*/
 
// MODULES //
 
var main = require( './main.js' );
 
 
// EXPORTS //
 
module.exports = main;