time-to-botec/js/node_modules/@stdlib/stats/incr/minabs/lib/main.js

75 lines
1.7 KiB
JavaScript
Raw Normal View History

/**
* @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 abs = require( '@stdlib/math/base/special/abs' );
var incrmin = require( './../../../incr/min' );
// MAIN //
/**
* Returns an accumulator function which incrementally computes a minimum absolute value.
*
* @returns {Function} accumulator function
*
* @example
* var accumulator = incrminabs();
*
* var min = accumulator();
* // returns null
*
* min = accumulator( 3.14 );
* // returns 3.14
*
* min = accumulator( -5.0 );
* // returns 3.14
*
* min = accumulator( 10.1 );
* // returns 3.14
*
* min = accumulator();
* // returns 3.14
*/
function incrminabs() {
var min = incrmin();
return accumulator;
/**
* If provided a value, the accumulator function returns an updated minimum absolute value. If not provided a value, the accumulator function returns the current minimum absolute value.
*
* @private
* @param {number} [x] - new value
* @returns {(number|null)} minimum absolute value or null
*/
function accumulator( x ) {
if ( arguments.length === 0 ) {
return min();
}
return min( abs( x ) );
}
}
// EXPORTS //
module.exports = incrminabs;