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

100% Statements 95/95
100% Branches 10/10
100% Functions 2/2
100% Lines 95/95

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 86 87 88 89 90 91 92 93 94 95 961x 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 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 35x 35x 35x 15x 35x 20x 20x 16x 16x 16x 16x 16x 16x 16x 16x 16x 16x 75x 20x 20x 75x 18x 18x 37x 75x 35x 1x 1x 1x 1x 1x  
/**
* @license Apache-2.0
*
* Copyright (c) 2025 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 isnan = require( '@stdlib/math/base/assert/is-nan' );
var incrmvariance = require( '@stdlib/stats/incr/mvariance' );
 
 
// MAIN //
 
/**
* Returns an accumulator function which incrementally computes a moving unbiased sample variance, ignoring NaN values.
*
* @param {PositiveInteger} W - window size
* @param {number} [mean] - mean value
* @throws {TypeError} first argument must be a positive integer
* @throws {TypeError} second argument must be a number
* @returns {Function} accumulator function
*
* @example
* var accumulator = incrnanmvariance( 3 );
*
* var s2 = accumulator();
* // returns null
*
* s2 = accumulator( 2.0 );
* // returns 0.0
*
* s2 = accumulator( NaN );
* // returns 0.0
*
* s2 = accumulator( -5.0 );
* // returns 24.5
*
* s2 = accumulator( 3.0 );
* // returns 19.0
*
* s2 = accumulator( NaN );
* // returns 19.0
*
* s2 = accumulator();
* // returns 19.0
*
* @example
* var accumulator = incrnanmvariance( 3, -2.0 );
*/
function incrnanmvariance( W, mean ) {
	var acc;
	if ( arguments.length > 1 ) {
		acc = incrmvariance( W, mean );
	} else {
		acc = incrmvariance( W );
	}
	return accumulator;
 
	/**
	* If provided a value, the accumulator function returns an updated unbiased sample variance, ignoring NaN values. If not provided a value, the accumulator function returns the current unbiased sample variance.
	*
	* @private
	* @param {number} [x] - input value
	* @returns {(number|null)} unbiased sample variance or null
	*/
	function accumulator( x ) {
		if ( arguments.length === 0 ) {
			return acc();
		}
		if ( isnan( x ) ) {
			return acc();
		}
		return acc( x );
	}
}
 
 
// EXPORTS //
 
module.exports = incrnanmvariance;