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

100% Statements 100/100
100% Branches 9/9
100% Functions 2/2
100% Lines 100/100

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 96 97 98 99 100 1011x 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 1x 1x 1x 1x 1x 1x 19x 19x 19x 19x 6x 19x 13x 13x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 69x 32x 32x 37x 69x 19x 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 incrvariance = require( '@stdlib/stats/incr/variance' );
 
 
// MAIN //
 
/**
* Returns an accumulator function which incrementally computes an unbiased sample variance, ignoring NaN values.
*
* @param {number} [mean] - mean value
* @returns {Function} accumulator function
*
* @example
* var accumulator = incrnanvariance();
*
* var v = accumulator();
* // returns null
*
* v = accumulator( 2.0 );
* // returns 0.0
*
* v = accumulator( NaN );
* // returns 0.0
*
* v = accumulator( -5.0 );
* // returns 24.5
*
* v = accumulator();
* // returns 24.5
*
* @example
* var accumulator = incrnanvariance( 3.14 );
*
* var v = accumulator();
* // returns null
*
* v = accumulator( 2.0 );
* // returns 1.2996
*
* v = accumulator( NaN );
* // returns 1.2996
*
* v = accumulator( -5.0 );
* // returns 33.7796
*
* v = accumulator();
* // returns 33.7796
*/
function incrnanvariance( mean ) {
	var variance;
 
	if ( arguments.length === 0 ) {
		variance = incrvariance();
	} else {
		variance = incrvariance( mean );
	}
 
	return accumulator;
 
	/**
	* If provided a value, the accumulator function returns an updated unbiased sample variance. If not provided a value, the accumulator function returns the current unbiased sample variance.
	*
	* @private
	* @param {number} [x] - new value
	* @returns {(number|null)} unbiased sample variance or null
	*/
	function accumulator( x ) {
		if ( arguments.length === 0 || isnan( x ) ) {
			return variance();
		}
		return variance( x );
	}
}
 
 
// EXPORTS //
 
module.exports = incrnanvariance;