@stdlib/stats-iter-mean
v0.2.1
Published
Compute the arithmetic mean over all iterated values.
Downloads
136
Readme
itermean
Compute the arithmetic mean over all iterated values.
The arithmetic mean is defined as
Installation
npm install @stdlib/stats-iter-mean
Usage
var itermean = require( '@stdlib/stats-iter-mean' );
itermean( iterator )
Computes the arithmetic mean over all iterated values.
var array2iterator = require( '@stdlib/array-to-iterator' );
var arr = array2iterator( [ 1.0, 2.0, 3.0, 4.0 ] );
var m = itermean( arr );
// returns 2.5
Notes
- If an iterated value is non-numeric (including
NaN
), the returnediterator
returnsNaN
. If non-numeric iterated values are possible, you are advised to provide aniterator
which type checks and handles non-numeric values accordingly.
Examples
var runif = require( '@stdlib/random-iter-uniform' );
var itermean = require( '@stdlib/stats-iter-mean' );
// Create an iterator for generating uniformly distributed pseudorandom numbers:
var rand = runif( -10.0, 10.0, {
'seed': 1234,
'iter': 100
});
// Compute the arithmetic mean:
var m = itermean( rand );
// returns <number>
console.log( 'Mean: %d.', m );
See Also
@stdlib/stats-iter/midrange
: compute the mid-range of all iterated values.@stdlib/stats-iter/mmean
: create an iterator which iteratively computes a moving arithmetic mean.@stdlib/stats-iter/stdev
: compute the corrected sample standard deviation over all iterated values.@stdlib/stats-iter/sum
: compute the sum of all iterated values.@stdlib/stats-iter/variance
: compute the unbiased sample variance over all iterated values.
Notice
This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2024. The Stdlib Authors.