@stdlib/iter-unitspace
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.7 • Public • Published

    iterUnitspace

    NPM version Build Status Coverage Status

    Create an iterator which returns numbers incremented by 1.

    Installation

    npm install @stdlib/iter-unitspace

    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 );
    }

    See Also


    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


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2022. The Stdlib Authors.

    Install

    npm i @stdlib/iter-unitspace

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    40

    Version

    0.0.7

    License

    Apache-2.0

    Unpacked Size

    42.4 kB

    Total Files

    9

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser