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

100% Statements 75/75
100% Branches 7/7
100% Functions 2/2
100% Lines 75/75

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 761x 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 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 26x 16x 16x 10x 26x 7x 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 incrwmean = require( '@stdlib/stats/incr/wmean' );
 
 
// MAIN //
 
/**
* Returns an accumulator function which incrementally computes a weighted mean, ignoring `NaN` values.
*
* @returns {Function} accumulator function
*
* @example
* var accumulator = incrnanwmean();
*
* var mean = accumulator();
* // returns null
*
* mean = accumulator( 2.0, 1.0 );
* // returns 2.0
*
* mean = accumulator( NaN, 1.0 );
* // returns 2.0
*
* mean = accumulator( -5.0, 2.0 );
* // returns -2.666666666666666
*
* mean = accumulator();
* // returns -2.666666666666666
*/
function incrnanwmean() {
	var wmean = incrwmean();
	return accumulator;
 
	/**
	* If provided arguments, the accumulator function returns an updated weighted mean. If not provided arguments, the accumulator function returns the current weighted mean.
	*
	* @private
	* @param {number} [x] - value
	* @param {number} [w] - weight
	* @returns {(number|null)} weighted mean or null
	*/
	function accumulator( x, w ) {
		if ( arguments.length === 0 || isnan( x ) || isnan( w ) ) {
			return wmean();
		}
		return wmean( x, w );
	}
}
 
 
// EXPORTS //
 
module.exports = incrnanwmean;