time-to-botec/squiggle/node_modules/@stdlib/stats/iter/cumidrange/README.md

itercumidrange

Create an iterator which iteratively computes a cumulative mid-range.

The mid-range, or mid-extreme, is the arithmetic mean of maximum and minimum values. Accordingly, the mid-range is the midpoint of the range and a measure of central tendency.

Usage

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

itercumidrange( iterator )

Returns an iterator which iteratively computes a cumulative mid-range.

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

var arr = array2iterator( [ 2.0, 1.0, 3.0, -7.0, -5.0 ] );
var it = itercumidrange( arr );

var v = it.next().value;
// returns 2.0

v = it.next().value;
// returns 1.5

v = it.next().value;
// returns 2.0

v = it.next().value;
// returns -2.0

v = it.next().value;
// returns -2.0

Notes

• If an iterated value is non-numeric (including NaN), the function returns NaN for all future iterations. 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 itercumidrange = require( '@stdlib/stats/iter/cumidrange' );

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

// Create an iterator for iteratively computing a cumulative mid-range:
var it = itercumidrange( rand );

// Perform manual iteration...
var v;
while ( true ) {
    v = it.next();
    if ( typeof v.value === 'number' ) {
        console.log( 'mid-range: %d', v.value );
    }
    if ( v.done ) {
        break;
    }
}