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

100% Statements 85/85
100% Branches 14/14
100% Functions 2/2
100% Lines 85/85

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 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 861x 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 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 18x 18x 4x 4x 18x 4x 4x 10x 10x 18x 18x 6x 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';
 
// MODULES //
 
var covariance = require( '@stdlib/stats/incr/covariance' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
 
 
// MAIN //
 
/**
* Returns an accumulator function which incrementally computes a sample covariance.
*
* @returns {Function} accumulator function
*
* @example
* var nancovariance = require( '@stdlib/stats/incr/nancovariance' );
*
* var acc = nancovariance();
*
* var cov = acc();
* // returns null
*
* cov = acc( 2.0, 1.0 );
* // returns null
*
* cov = acc( NaN, 5.0 );
* // returns null
*
* cov = acc( 4.0, 5.0 );
* // returns 4.0
*
* cov =  acc();
* // returns 4.0
*/
function nancovariance() {
	var count = 0;
	var acc = covariance();
	return accumulator;
 
	/**
	* Updates and returns the sample covariance when provided two numeric arguments.
	* If no arguments are provided, returns the current sample covariance.
	*
	* @private
	* @param {number} [x] - new x value
	* @param {number} [y] - new y value
	* @returns {(number|null)} sample covariance or null
	*/
	function accumulator( x, y ) {
		var val;
		if ( arguments.length === 0 ) {
			return ( count < 2 ) ? null : acc();
		}
		if ( isnan( x ) || isnan( y ) ) {
			return ( count < 2 ) ? null : acc();
		}
		count += 1;
		val = acc( x, y );
		return ( count < 2 ) ? null : val;
	}
}
 
 
// EXPORTS //
 
module.exports = nancovariance;