Nerdy People Matriculate

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

    0.0.7 • Public • Published

    iterLucasSeq

    NPM version Build Status Coverage Status

    Create an iterator which generates a Lucas sequence.

    The Lucas numbers are the integer sequence

    Lucas sequence

    The sequence is defined by the recurrence relation

    Lucas sequence recurrence relation

    Installation

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

    Usage

    var iterLucasSeq = require( '@stdlib/math-iter-sequences-lucas' );

    iterLucasSeq( [options] )

    Returns an iterator which generates a Lucas sequence.

    var it = iterLucasSeq();
    // returns <Object>
    
    var v = it.next().value;
    // returns 2
    
    v = it.next().value;
    // returns 1
    
    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: 77.

    The returned iterator can only generate the first 77 Lucas numbers, as larger Lucas numbers cannot be safely represented in double-precision floating-point format. By default, the function returns an iterator which generates all 77 numbers. To limit the number of iterations, set the iter option.

    var opts = {
        'iter': 2
    };
    var it = iterLucasSeq( opts );
    // returns <Object>
    
    var v = it.next().value;
    // returns 2
    
    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 iterLucasSeq = require( '@stdlib/math-iter-sequences-lucas' );
    
    // Create an iterator:
    var it = iterLucasSeq();
    
    // 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-lucas

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    43

    Version

    0.0.7

    License

    Apache-2.0

    Unpacked Size

    62.5 kB

    Total Files

    12

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser