time-to-botec/js/node_modules/@stdlib/math/base/special/lucas/README.md
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

3.4 KiB

Lucas

Compute the nth Lucas number.

The Lucas numbers are the integer sequence

Lucas sequence

The sequence is defined by the recurrence relation

Lucas sequence recurrence relation

Usage

var lucas = require( '@stdlib/math/base/special/lucas' );

lucas( n )

Computes the nth Lucas number.

var v = lucas( 0 );
// returns 2

v = lucas( 1 );
// returns 1

v = lucas( 2 );
// returns 3

v = lucas( 3 );
// returns 4

v = lucas( 76 );
// returns 7639424778862807

If n > 76, the function returns NaN, as larger Lucas numbers cannot be safely represented in double-precision floating-point format.

var v = lucas( 77 );
// returns NaN

If not provided a nonnegative integer value, the function returns NaN.

var v = lucas( 3.14 );
// returns NaN

v = lucas( -1 );
// returns NaN

If provided NaN, the function returns NaN.

var v = lucas( NaN );
// returns NaN

Examples

var lucas = require( '@stdlib/math/base/special/lucas' );

var v;
var i;

for ( i = 0; i < 77; i++ ) {
    v = lucas( i );
    console.log( v );
}