time-to-botec/js/node_modules/@stdlib/math/iter/sequences/negalucas
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00
..
docs feat: add the node modules 2022-12-03 12:44:49 +00:00
lib feat: add the node modules 2022-12-03 12:44:49 +00:00
package.json feat: add the node modules 2022-12-03 12:44:49 +00:00
README.md feat: add the node modules 2022-12-03 12:44:49 +00:00

iterNegaLucasSeq

Create an iterator which generates a negaLucas sequence.

The negaLucas numbers are the integer sequence

NegaLucas sequence

The sequence is defined by the recurrence relation

NegaLucas sequence recurrence relation

which yields

NegaLucas relationship to Lucas numbers

with seed values L_0 = 2 and L_{-1} = -1.

Usage

var iterNegaLucasSeq = require( '@stdlib/math/iter/sequences/negalucas' );

iterNegaLucasSeq( [options] )

Returns an iterator which generates a negaLucas sequence.

var it = iterNegaLucasSeq();
// 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 negaLucas numbers, as larger negaLucas 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 = iterNegaLucasSeq( 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 iterNegaLucasSeq = require( '@stdlib/math/iter/sequences/negalucas' );

// Create an iterator:
var it = iterNegaLucasSeq();

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