time-to-botec/js/node_modules/@stdlib/math/iter/sequences/nonfibonacci/README.md

iterNonFibonacciSeq

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

The nth non-Fibonacci number is given by

where φ is the golden ratio.

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