Skip to content

range

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History
 
 

range

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
benchmark
benchmark
 
 
docs
docs
 
 
examples
examples
 
 
lib
lib
 
 
test
test
 
 
README.md
README.md
 
 
package.json
package.json
 
 

README.md

iterrange

Compute the range of all iterated values.

The range is defined as the difference between the maximum and minimum values.

Usage

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

iterrange( iterator )

Computes the range of all iterated values.

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

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

var v = iterrange( arr );
// returns 7.0

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 iterrange = require( '@stdlib/stats/iter/range' );

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

// Compute the range:
var v = iterrange( rand );
// returns <number>

console.log( 'Range: %d.', v );

See Also