@stdlib/math-iter-sequences-nonnegative-even-integers
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.6 • Public • Published

    iterNonNegativeEvenIntegersSeq

    NPM version Build Status Coverage Status dependencies

    Create an iterator which generates a sequence of nonnegative even integers.

    Installation

    npm install @stdlib/math-iter-sequences-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 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: 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 );
    }

    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

    Chat


    Copyright

    Copyright © 2016-2021. The Stdlib Authors.

    Install

    npm i @stdlib/math-iter-sequences-nonnegative-even-integers

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    20

    Version

    0.0.6

    License

    Apache-2.0

    Unpacked Size

    43 kB

    Total Files

    10

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser