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

100% Statements 81/81
100% Branches 6/6
100% Functions 2/2
100% Lines 81/81

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 821x 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 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 14x 3x 3x 11x 14x 4x 1x 1x 1x 1x 1x  
/**
* @license Apache-2.0
*
* Copyright (c) 2018 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 increwvariance = require( '@stdlib/stats/incr/ewvariance' );
 
 
// MAIN //
 
/**
* Returns an accumulator function which incrementally computes an arithmetic mean, ignoring `NaN` values.
*
* @param {number} alpha - smoothing factor
* @returns {Function} accumulator function
*
* @example
* var incrnanewvariance = require( '@stdlib/stats/incr/nanewvariance' );
*
* var accumulator = incrnanewvariance( 0.5 );
*
* var v = accumulator();
* // returns null
*
* v = accumulator( 2.0 );
* // returns 0
*
* v = accumulator( 4.0 );
* // returns 1.0
*
* v = accumulator( NaN );
* // returns 1.0
*
* v = accumulator( 5.0 );
* // returns 1.5
*
* v = accumulator();
* // returns 1.5
*/
function nanewvariance(alpha) {
	var acc = increwvariance( alpha );
	return accumulator;
 
	/**
	* Updates and returns the exponentially weighted variance when provided a numeric input.
	* If no input is provided, returns the current exponentially weighted variance.
	*
	* @private
	* @param {number} [x] - new value
	* @returns {(number|null)} updated exponentially weighted variance or null
	*/
	function accumulator(x) {
		if ( arguments.length === 0 || isnan( x ) ) {
			return acc();
		}
		return acc( x );
	}
}
 
 
// EXPORTS //
 
module.exports = nanewvariance;