iterUnitspace

Create an iterator which returns numbers incremented by 1.

Usage

var iterUnitspace = require( '@stdlib/iter/unitspace' );

iterUnitspace( start[, stop] )

Returns an iterator which returns numbers incremented by 1.

var it = iterUnitspace( -5 );
// returns <Object>

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

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

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

// ...

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 value property and a done property having a boolean value indicating whether the iterator is finished.
  • return: function which closes an iterator and returns a single (optional) argument in an iterator protocol-compliant object.

By default, the stopping value is +infinity, and, hence, the returned iterator is an infinite iterator (i.e., the iterator never ends). To specify an alternative stopping value, provide a second argument.

var it = iterUnitspace( 0, 2 );
// returns <Object>

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

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

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

var bool = it.next().done;
// returns true

Notes

  • The returned iterator is guaranteed to return the start value and stops upon exceeding the stop value.
  • If an environment supports Symbol.iterator, the returned iterator is iterable.

Examples

var iterUnitspace = require( '@stdlib/iter/unitspace' );

// Create an iterator:
var it = iterUnitspace( -50, 50 );

// Perform manual iteration...
var v;
while ( true ) {
    v = it.next();
    if ( v.done ) {
        break;
    }
    console.log( v.value );
}