@stdlib/math-base-special-lucas
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!

Lucas

NPM version Build Status Coverage Status

Compute the nth Lucas number.

The Lucas numbers are the integer sequence

Lucas sequence
-->

The sequence is defined by the 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 );
}

C APIs

Usage

#include "stdlib/math/base/special/lucas.h"

stdlib_base_lucas( n )

Computes the nth Lucas number.

double out = stdlib_base_lucas( 0 );
// returns 2

out = stdlib_base_lucas( 1 );
// returns 1

The function accepts the following arguments:

  • n: [in] int32_t input value.
double stdlib_base_lucas( const int32_t n );

Examples

#include "stdlib/math/base/special/lucas.h"
#include <stdio.h>
#include <stdint.h>

int main( void ) {
    int32_t i;
    double v;

    for ( i = 0; i < 77; i++ ) {
        v = stdlib_base_lucas( i );
        printf( "lucas(%d) = %lf\n", i, v );
    }
}

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.

Package Sidebar

Install

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

Homepage

stdlib.io

Weekly Downloads

45

Version

0.2.1

License

Apache-2.0

Unpacked Size

58 kB

Total Files

19

Last publish

Collaborators

  • stdlib-bot
  • kgryte
  • planeshifter
  • rreusser