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

3.7 KiB

itermeanabs2

Compute the arithmetic mean of squared absolute values for all iterated values.

The arithmetic mean of squared absolute values is defined as

Equation for the arithmetic mean of squared absolute values.

Usage

var itermeanabs2 = require( '@stdlib/stats/iter/meanabs2' );

itermeanabs2( iterator )

Computes the arithmetic mean of squared absolute values for all iterated values.

var array2iterator = require( '@stdlib/array/to-iterator' );

var arr = array2iterator( [ 1.0, -2.0, -3.0, 4.0 ] );

var m = itermeanabs2( arr );
// returns 7.5

Notes

  • If an iterated value is non-numeric (including NaN), the returned iterator returns NaN. If non-numeric iterated values are possible, you are advised to provide an iterator which type checks and handles non-numeric values accordingly.

Examples

var runif = require( '@stdlib/random/iter/uniform' );
var itermeanabs2 = require( '@stdlib/stats/iter/meanabs2' );

// Create an iterator for generating uniformly distributed pseudorandom numbers:
var rand = runif( -10.0, 10.0, {
    'seed': 1234,
    'iter': 100
});

// Compute the arithmetic mean of squared absolute values:
var m = itermeanabs2( rand );
// returns <number>

console.log( 'meanabs2: %d.', m );