All files main.js

100% Statements 145/145
100% Branches 12/12
100% Functions 1/1
100% Lines 145/145

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 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 1461x 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 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 5286x 5286x 5286x 5286x 5286x 5286x 5286x 5286x 5286x 5286x 3x 3x 5283x 5286x 3912x 3912x 3912x 3912x 1371x 1371x 5286x 685x 685x 685x 686x 686x 686x 5286x 5286x 1x 1x 1x 1x 1x  
/**
* @license Apache-2.0
*
* Copyright (c) 2026 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 powf = require( '@stdlib/math/base/special/powf' );
var expf = require( '@stdlib/math/base/special/expf' );
var lnf = require( '@stdlib/math/base/special/lnf' );
var absf = require( '@stdlib/math/base/special/absf' );
var cospif = require( '@stdlib/math/base/special/cospif' );
var f32 = require( '@stdlib/number/float64/base/to-float32' );
var PHI = require( '@stdlib/constants/float32/phi' );
var PINF = require( '@stdlib/constants/float32/pinf' );
var NINF = require( '@stdlib/constants/float32/ninf' );
var NAN = require( '@stdlib/constants/float32/nan' );
 
 
// VARIABLES //
 
var SQRT_5 = f32( 2.23606797749979 ); // √5
var LN_PHI = f32( 0.48121182505960347 ); // ln(φ)
var LN_SQRT_5 = f32( 0.80471895621705014 ); // ln(√5)
var OVERFLOW_THRESHOLD = f32( 184.37377929687500 ); // first (single-precision) value `x` for which `φ^x` overflows
 
 
// MAIN //
 
/**
* Evaluates Binet's formula extended to real numbers.
*
* ## Method
*
* Binet's formula is
*
* ```tex
* \operatorname{binet}(x) = \frac{\varphi^x - \cos(\pi x)\,\varphi^{-x}}{\sqrt{5}}
* ```
*
* In single-precision floating-point arithmetic, directly evaluating \\( \varphi^x \\) overflows once \\( x \\) exceeds the natural logarithm of the maximum single-precision floating-point number divided by \\( \ln(\varphi) \\), even though the function value \\( \varphi^x / \sqrt{5} \\) remains representable for \\( x < \bigl(\ln(\mathtt{FLT\_MAX}) + \tfrac{1}{2}\ln(5)\bigr) / \ln(\varphi) \\). We therefore factor out the dominant term. For \\( x \ge 0 \\),
*
* ```tex
* \operatorname{binet}(x) = \frac{\varphi^{|x|}}{\sqrt{5}} - \cos(\pi x)\,\frac{\varphi^{-|x|}}{\sqrt{5}}
* ```
*
* and for \\( x < 0 \\),
*
* ```tex
* \operatorname{binet}(x) = \frac{\varphi^{-|x|}}{\sqrt{5}} - \cos(\pi x)\,\frac{\varphi^{|x|}}{\sqrt{5}}.
* ```
*
* When the dominant term would overflow, it is evaluated in log space. For negative \\( x \\), the magnitude of the dominant term is \\( |\cos(\pi x)| \cdot \varphi^{|x|} / \sqrt{5} \\), so we fold \\( \ln|\cos(\pi x)| \\) into the exponent in order to preserve finiteness of results which are representable in single precision:
*
* ```tex
* \frac{|\cos(\pi x)| \cdot \varphi^{|x|}}{\sqrt{5}} = \exp\Bigl( |x|\,\ln(\varphi) + \ln|\cos(\pi x)| - \tfrac{1}{2}\ln(5) \Bigr).
* ```
*
* Note that the cancellation of the two terms of Binet's formula near \\( x = 0 \\) (and, for negative \\( x \\), near the negative half-integers) is inherent to the formula itself and limits _relative_ accuracy; _absolute_ accuracy is unaffected.
*
* @param {number} x - input value
* @returns {number} real-valued result
*
* @example
* var y = binetf( 0.0 );
* // returns 0.0
*
* @example
* var y = binetf( 1.0 );
* // returns 1.0
*
* @example
* var y = binetf( 2.0 );
* // returns ~1.0
*
* @example
* var y = binetf( 3.0 );
* // returns 2.0
*
* @example
* var y = binetf( 4.0 );
* // returns 3.0
*
* @example
* var y = binetf( 5.0 );
* // returns ~5.0
*
* @example
* var y = binetf( -1.0 );
* // returns 1.0
*
* @example
* var y = binetf( NaN );
* // returns NaN
*/
function binetf( x ) {
	var eps;
	var dom;
	var ax;
	var a;
	var b;
	var c;
 
	x = f32( x ); // ensure type consistency (values may arrive as `float64`s)
	if ( isnanf( x ) || x === PINF || x === NINF ) {
		return NAN;
	}
	ax = absf( x );
	if ( ax < OVERFLOW_THRESHOLD ) {
		a = powf( PHI, x );
		b = f32( cospif( x ) / a );
		return f32( f32( a - b ) / SQRT_5 );
	}
	// The input value is large enough that `powf( PHI, x )` (or `cospi(x)/powf(PHI,x)`) would overflow: evaluate the dominant term in log space
	eps = expf( f32( f32( -ax*LN_PHI ) - LN_SQRT_5 ) ); // φ^(-|x|)/√5
	if ( x > 0 ) {
		// The dominant term is φ^x/√5; the second term of Binet's formula is below single-precision resolution
		return expf( f32( f32( ax*LN_PHI ) - LN_SQRT_5 ) );
	}
	// The dominant term is -cos(πx)·φ^(-x)/√5; fold ln|cos(πx)| into the exponent to preserve finiteness (note: `lnf(0.0)` is `-infinity`, so exact half-integers naturally return `eps`)
	c = cospif( x );
	dom = expf( f32( f32( f32( ax*LN_PHI ) + lnf( absf( c ) ) ) - LN_SQRT_5 ) );
	return ( c > 0 ) ? f32( eps - dom ) : f32( eps + dom );
}
 
 
// EXPORTS //
 
module.exports = binetf;