@stdlib/math-base-special-lucas

Compute the nth Lucas number.

Usage no npm install needed!

<script type="module">
  import stdlibMathBaseSpecialLucas from 'https://cdn.skypack.dev/@stdlib/math-base-special-lucas';
</script>

README

Lucas

NPM version Build Status Coverage Status dependencies

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

Installation

npm install @stdlib/math-base-special-lucas

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 );
}

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