time-to-botec/squiggle/node_modules/@stdlib/stats/iter/meanabs/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

72 lines
1.7 KiB
JavaScript

/**
* @license Apache-2.0
*
* Copyright (c) 2019 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 isIteratorLike = require( '@stdlib/assert/is-iterator-like' );
var hasOwnProp = require( '@stdlib/assert/has-own-property' );
var incrmeanabs = require( './../../../incr/meanabs' );
// MAIN //
/**
* Computes the arithmetic mean of absolute values for all iterated values.
*
* @param {Iterator} iterator - input iterator
* @throws {TypeError} must provide an iterator
* @returns {(number|null)} arithmetic mean of absolute values
*
* @example
* var runif = require( '@stdlib/random/iter/uniform' );
*
* var rand = runif( -10.0, 10.0, {
* 'iter': 100
* });
*
* var m = itermeanabs( rand );
* // returns <number>
*/
function itermeanabs( iterator ) {
var acc;
var v;
if ( !isIteratorLike( iterator ) ) {
throw new TypeError( 'invalid argument. Must provide an iterator. Value: `'+iterator+'`.' );
}
acc = incrmeanabs();
while ( true ) {
v = iterator.next();
if ( typeof v.value === 'number' ) {
acc( v.value );
} else if ( hasOwnProp( v, 'value' ) ) {
acc( NaN );
}
if ( v.done ) {
break;
}
}
return acc();
}
// EXPORTS //
module.exports = itermeanabs;