0.2.1 • Published 2 months ago
@stdlib/stats-iter-cuminabs v0.2.1
itercuminabs
Create an iterator which iteratively computes a cumulative minimum absolute value.
Installation
npm install @stdlib/stats-iter-cuminabs
Usage
var itercuminabs = require( '@stdlib/stats-iter-cuminabs' );
itercuminabs( iterator )
Returns an iterator which iteratively computes a cumulative minimum absolute value.
var array2iterator = require( '@stdlib/array-to-iterator' );
var arr = array2iterator( [ 2.0, 1.0, 3.0, -7.0, -5.0 ] );
var it = itercuminabs( arr );
var m = it.next().value;
// returns 2.0
m = it.next().value;
// returns 1.0
m = it.next().value;
// returns 1.0
m = it.next().value;
// returns 1.0
m = it.next().value;
// returns 1.0
Notes
- If an iterated value is non-numeric (including
NaN
), the function returnsNaN
for all future iterations. 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 itercuminabs = require( '@stdlib/stats-iter-cuminabs' );
// 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 minimum absolute value:
var it = itercuminabs( rand );
// Perform manual iteration...
var v;
while ( true ) {
v = it.next();
if ( typeof v.value === 'number' ) {
console.log( 'minabs: %d', v.value );
}
if ( v.done ) {
break;
}
}
See Also
@stdlib/stats-iter/cumaxabs
: create an iterator which iteratively computes a cumulative maximum absolute value.@stdlib/stats-iter/cumin
: create an iterator which iteratively computes a cumulative minimum value.@stdlib/stats-iter/minabs
: compute the minimum absolute value of 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.