National Palace Museum

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

    0.0.7 • Public • Published

    iterSquaresSeq

    NPM version Build Status Coverage Status

    Create an iterator which generates a sequence of squares.

    Installation

    npm install @stdlib/math-iter-sequences-squares

    Usage

    var iterSquaresSeq = require( '@stdlib/math-iter-sequences-squares' );

    iterSquaresSeq( [options] )

    Returns an iterator which generates a sequence of squares.

    var it = iterSquaresSeq();
    // returns <Object>
    
    var v = it.next().value;
    // returns 0
    
    v = it.next().value;
    // returns 1
    
    v = it.next().value;
    // returns 4
    
    v = it.next().value;
    // returns 9
    
    v = it.next().value;
    // returns 16
    
    // ...

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

    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 = iterSquaresSeq( 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 iterSquaresSeq = require( '@stdlib/math-iter-sequences-squares' );
    
    // Create an iterator:
    var opts = {
        'iter': 100
    };
    var it = iterSquaresSeq( opts );
    
    // 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/math-iter-sequences-squares

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    36

    Version

    0.0.7

    License

    Apache-2.0

    Unpacked Size

    43.3 kB

    Total Files

    10

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser