iterNonPositiveIntegersSeq

Create an iterator which generates a nonpositive integer sequence.

Installation

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

Usage

var iterNonPositiveIntegersSeq = require( '@stdlib/math-iter-sequences-nonpositive-integers' );

iterNonPositiveIntegersSeq( [options] )

Returns an iterator which generates a nonpositive integer sequence.

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

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

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

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

// ...

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: 9007199254740992.

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

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

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

See Also

• @stdlib/math-iter/sequences/integers: create an iterator which generates an interleaved integer sequence.
• @stdlib/math-iter/sequences/negative-integers: create an iterator which generates a negative integer sequence.
• @stdlib/math-iter/sequences/nonnegative-integers: create an iterator which generates a nonnegative integer sequence.
• @stdlib/math-iter/sequences/positive-integers: create an iterator which generates a positive integer sequence.

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.