README

iterPositiveIntegersSeq

$NPM version$ $Build Status$ $Coverage Status$ $dependencies$

Create an iterator which generates a positive integer sequence.

The sequence of positive integers 1, 2, 3, 4, ... (OEIS A000027) is also commonly referred to the sequence of natural numbers, whole numbers, and counting numbers; however, those terms are ambiguous due to the inclusion or exclusion of 0.

Installation

npm install @stdlib/math-iter-sequences-positive-integers

Usage

var iterPositiveIntegersSeq = require( '@stdlib/math-iter-sequences-positive-integers' );

iterPositiveIntegersSeq( [options] )

Returns an iterator which generates a positive integer sequence.

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

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

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

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.

The function supports the following options:

iter: number of iterations. Default: 9007199254740991.

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

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

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 iterPositiveIntegersSeq = require( '@stdlib/math-iter-sequences-positive-integers' );

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

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

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.

@stdlib/math-iter-sequences-positive-integers

Usage no npm install needed!