time-to-botec/squiggle/node_modules/@stdlib/math/iter/sequences/cubes/README.md

iterCubesSeq

Create an iterator which generates a sequence of cubes.

Usage

var iterCubesSeq = require( '@stdlib/math/iter/sequences/cubes' );

iterCubesSeq( [options] )

Returns an iterator which generates a sequence of cubes.

var it = iterCubesSeq();
// returns <Object>

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

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

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

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

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

// ...

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.

The function supports the following options:

• iter: number of iterations. Default: 208063.

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 = iterCubesSeq( opts );
// returns <Object>

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

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

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

Notes

• If an environment supports Symbol.iterator, the returned iterator is iterable.

Examples

var iterCubesSeq = require( '@stdlib/math/iter/sequences/cubes' );

// Create an iterator:
var opts = {
    'iter': 100
};
var it = iterCubesSeq( opts );

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