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

0.2.1 • Public • Published
About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

iterNegaFibonacciSeq

NPM version Build Status Coverage Status

Create an iterator which generates a negaFibonacci sequence.

The negaFibonacci numbers are the integer sequence

NegaFibonacci sequence
-->

The sequence is defined by the recurrence relation

which yields

with seed values F_0 = 0 and F_{-1} = 1.

Installation

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

Usage

var iterNegaFibonacciSeq = require( '@stdlib/math-iter-sequences-negafibonacci' );

iterNegaFibonacciSeq( [options] )

Returns an iterator which generates a negaFibonacci sequence.

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

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

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

v = it.next().value;
// returns -1

// ...

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

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

var opts = {
    'iter': 2
};
var it = iterNegaFibonacciSeq( 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 iterNegaFibonacciSeq = require( '@stdlib/math-iter-sequences-negafibonacci' );

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

// 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-2024. The Stdlib Authors.

Versions

Current Tags

  • Version
    Downloads (Last 7 Days)
    • Tag
  • 0.2.1
    6
    • latest

Version History

Package Sidebar

Install

npm i @stdlib/math-iter-sequences-negafibonacci

Homepage

stdlib.io

Weekly Downloads

6

Version

0.2.1

License

Apache-2.0

Unpacked Size

58.3 kB

Total Files

15

Last publish

Collaborators

  • stdlib-bot
  • kgryte
  • planeshifter
  • rreusser