iterNonFibonacciSeq

Create an iterator which generates a non-Fibonacci integer sequence.

The nth non-Fibonacci number is given by

where φ is the golden ratio.

Installation

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

Usage

var iterNonFibonacciSeq = require( '@stdlib/math-iter-sequences-nonfibonacci' );

iterNonFibonacciSeq( [options] )

Returns an iterator which generates a non-Fibonacci integer sequence.

var it = iterNonFibonacciSeq();
// returns <Object>

var v = it.next().value;
// returns 4

v = it.next().value;
// returns 6

v = it.next().value;
// returns 7

// ...

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: 1e308.

By default, the function returns an infinite iterator (i.e., an iterator which never ends). To limit the number of iterations, set the iter option.

var opts = {
    'iter': 2
};
var it = iterNonFibonacciSeq( opts );
// returns <Object>

var v = it.next().value;
// returns 4

v = it.next().value;
// returns 6

var bool = it.next().done;
// returns true

Notes

• If an environment supports Symbol.iterator, the returned iterator is iterable.

Examples

var iterNonFibonacciSeq = require( '@stdlib/math-iter-sequences-nonfibonacci' );

// Create an iterator:
var opts = {
    'iter': 100
};
var it = iterNonFibonacciSeq( opts );

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

References

• Gould, H.W. 1965. "Non-Fibonacci Numbers." Fibonacci Quarterly, no. 3: 177–83. <http://www.fq.math.ca/Scanned/3-3/gould.pdf>.
• Farhi, Bakir. 2011. "An explicit formula generating the non-Fibonacci numbers." arXiv abs/1105.1127 [Math.NT] (May): 1–5. <https://arxiv.org/abs/1105.1127>.

See Also

• @stdlib/math-base/special/nonfibonacci: compute the nth non-Fibonacci number.
• @stdlib/math-iter/sequences/fibonacci: create an iterator which generates a Fibonacci sequence.

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

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.