All files / math/base/special/lucasf/lib main.js

100% Statements 92/92
100% Branches 7/7
100% Functions 1/1
100% Lines 92/92

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 931x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 603x 603x 603x 603x 603x 501x 603x 568x 568x 35x 603x 1x 1x 1x 1x 1x  
/**
* @license Apache-2.0
*
* Copyright (c) 2025 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
 
'use strict';
 
// MODULES //
 
var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
var isIntegerf = require( '@stdlib/math/base/assert/is-integerf' );
var MAX_LUCAS = require( '@stdlib/constants/float32/max-safe-nth-lucas' );
var LUCAS = require( './lucas.json' );
 
 
// MAIN //
 
/**
* Computes the nth Lucas number as a single-precision floating-point number.
*
* @param {NonNegativeInteger} n - the Lucas number to compute
* @returns {NonNegativeInteger} Lucas number
*
* @example
* var y = lucasf( 0 );
* // returns 2
*
* @example
* var y = lucasf( 1 );
* // returns 1
*
* @example
* var y = lucasf( 2 );
* // returns 3
*
* @example
* var y = lucasf( 3 );
* // returns 4
*
* @example
* var y = lucasf( 4 );
* // returns 7
*
* @example
* var y = lucasf( 5 );
* // returns 11
*
* @example
* var y = lucasf( 6 );
* // returns 18
*
* @example
* var y = lucasf( NaN );
* // returns NaN
*
* @example
* var y = lucasf( 3.14 );
* // returns NaN
*
* @example
* var y = lucasf( -1.0 );
* // returns NaN
*/
function lucasf( n ) {
	if (
		isnanf( n ) ||
		isIntegerf( n ) === false ||
		n < 0 ||
		n > MAX_LUCAS
	) {
		return NaN;
	}
	return LUCAS[ n ];
}
 
 
// EXPORTS //
 
module.exports = lucasf;