iterNonNegativeEvenIntegersSeq
Create an iterator which generates a sequence of nonnegative even integers.
Usage
var iterNonNegativeEvenIntegersSeq = require( '@stdlib/math/iter/sequences/nonnegative-even-integers' );
iterNonNegativeEvenIntegersSeq( [options] )
Returns an iterator which generates a sequence of nonnegative even integers.
var it = iterNonNegativeEvenIntegersSeq();
// returns <Object>
var v = it.next().value;
// returns 0
v = it.next().value;
// returns 2
v = it.next().value;
// returns 4
// ...
The returned iterator protocol-compliant object has the following properties:
- next: function which returns an iterator protocol-compliant object containing the next iterated value (if one exists) assigned to a
valueproperty and adoneproperty having abooleanvalue indicating whether the iterator is finished. - return: function which closes an iterator and returns a single (optional) argument in an iterator protocol-compliant object.
The function supports the following options:
- iter: number of iterations. Default:
4503599627370497.
By default, the function returns a finite iterator to avoid exceeding the maximum safe double-precision floating-point integer. To adjust the number of iterations, set the iter option.
var opts = {
'iter': 2
};
var it = iterNonNegativeEvenIntegersSeq( opts );
// returns <Object>
var v = it.next().value;
// returns 0
v = it.next().value;
// returns 2
var bool = it.next().done;
// returns true
Notes
- If an environment supports
Symbol.iterator, the returned iterator is iterable.
Examples
var iterNonNegativeEvenIntegersSeq = require( '@stdlib/math/iter/sequences/nonnegative-even-integers' );
// Create an iterator:
var opts = {
'iter': 100
};
var it = iterNonNegativeEvenIntegersSeq( opts );
// Perform manual iteration...
var v;
while ( true ) {
v = it.next();
if ( v.done ) {
break;
}
console.log( v.value );
}