Skip to content

Latest commit

 

History

History
238 lines (151 loc) · 16.9 KB

README.md

File metadata and controls

238 lines (151 loc) · 16.9 KB

Iterator Statistics

Statistical function iterators.

Usage

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

ns

Namespace containing functions for computing statistics over iterators.

var o = ns;
// returns {...}

Examples

var getKeys = require( '@stdlib/utils/keys' );
var ns = require( '@stdlib/stats/iter' );

console.log( getKeys( ns ) );

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

// Example data: An iterator of temperature values
var temperatures = array2iterator([20, 22, 25, 18, 23, 21, 19, 20, 24, 26]);

// Compute the minimum temperature
var minTemperature = ns.itermin( temperatures );
// returns 18.0

// Compute the maximum temperature
var maxTemperature = ns.itermax( temperatures );
// returns 26.0

// Compute the arithmetic mean temperature
var meanTemperature = ns.itermean( temperatures );
// returns 21.8