time-to-botec/js/node_modules/@stdlib/stats/incr/nansum/lib/main.js
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

75 lines
1.6 KiB
JavaScript

/**
* @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 isnan = require( '@stdlib/math/base/assert/is-nan' );
var incrsum = require( './../../../incr/sum' );
// MAIN //
/**
* Returns an accumulator function which incrementally computes a sum, ignoring `NaN` values.
*
* @returns {Function} accumulator function
*
* @example
* var accumulator = incrnansum();
*
* var sum = accumulator();
* // returns null
*
* sum = accumulator( 2.0 );
* // returns 2.0
*
* sum = accumulator( NaN );
* // returns 2.0
*
* sum = accumulator( -5.0 );
* // returns -3.0
*
* sum = accumulator();
* // returns -3.0
*/
function incrnansum() {
var sum = incrsum();
return accumulator;
/**
* If provided a value, the accumulator function returns an updated sum. If not provided a value, the accumulator function returns the current sum.
*
* @private
* @param {number} [x] - new value
* @returns {(number|null)} sum or null
*/
function accumulator( x ) {
if ( arguments.length === 0 || isnan( x ) ) {
return sum();
}
return sum( x );
}
}
// EXPORTS //
module.exports = incrnansum;