@stdlib/stats-iter-mean

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

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 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 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.