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

73 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 incrmean = require( './../../../incr/mean' );
// MAIN //
/**
* Returns an accumulator function which incrementally computes the mean absolute error.
*
* @returns {Function} accumulator function
*
* @example
* var accumulator = incrmae();
*
* var m = accumulator();
* // returns null
*
* m = accumulator( 2.0, 3.0 );
* // returns 1.0
*
* m = accumulator( -5.0, 2.0 );
* // returns 4.0
*
* m = accumulator();
* // returns 4.0
*/
function incrmae() {
var mean = incrmean();
return accumulator;
/**
* If provided input values, the accumulator function returns an updated mean absolute error. If not provided input values, the accumulator function returns the current mean absolute error.
*
* @private
* @param {number} [x] - input value
* @param {number} [y] - input value
* @returns {(number|null)} mean absolute error or null
*/
function accumulator( x, y ) {
if ( arguments.length === 0 ) {
return mean();
}
return mean( abs( y-x ) );
}
}
// EXPORTS //
module.exports = incrmae;