All files main.js

100% Statements 95/95
100% Branches 10/10
100% Functions 1/1
100% Lines 95/95

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 961x 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 27x 27x 27x 27x 27x 27x 27x 27x 27x 3x 3x 24x 27x 4x 4x 20x 27x 10x 10x 10x 10x 27x 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 isnan = require( '@stdlib/math/base/assert/is-nan' );
var f16 = require( '@stdlib/number/float64/base/to-float16' );
var ulpdiff = require( '@stdlib/number/float16/base/ulp-difference' );
 
 
// MAIN //
 
/**
* Tests if two half-precision floating-point numbers are approximately the same value within a specified number of ULPs (units in the last place).
*
* ## Notes
*
* -   The function implements the [SameValue Algorithm][ecma-262-same-value-algorithm], as specified in ECMAScript 5.
* -   In contrast to the strict equality operator `===`, `-0` and `+0` are distinguishable and `NaNs` are the same.
*
* [ecma-262-same-value-algorithm]: http://ecma-international.org/ecma-262/5.1/#sec-9.12
*
* @param {number} a - first input value
* @param {number} b - second input value
* @param {number} maxULP - maximum allowed ULP difference
* @returns {boolean} boolean indicating whether two half-precision floating-point numbers are approximately the same value within a specified number of ULPs
*
* @example
* var EPS = require( '@stdlib/constants/float16/eps' );
*
* var bool = isAlmostSameValue( 1.0, 1.0+EPS, 1 );
* // returns true
*
* bool = isAlmostSameValue( 1.0+EPS, 1.0, 1 );
* // returns true
*
* bool = isAlmostSameValue( 1.0, 1.0+EPS+EPS, 1 );
* // returns false
*
* bool = isAlmostSameValue( 1.0, 1.0+EPS, 0 );
* // returns false
*
* bool = isAlmostSameValue( 0.0, -0.0, 0 );
* // returns false
*
* bool = isAlmostSameValue( 1.0, NaN, 1 );
* // returns false
*
* bool = isAlmostSameValue( NaN, NaN, 1 );
* // returns true
*/
function isAlmostSameValue( a, b, maxULP ) {
	var af;
	var bf;
 
	af = f16( a );
	bf = f16( b );
 
	// Check for NaN (NaN is considered equal to NaN in SameValue):
	if ( isnan( af ) && isnan( bf ) ) {
		return true;
	}
	// Only distinguish signed zeros when maxULP is 0:
	if ( maxULP === 0 && af === 0.0 && bf === 0.0 ) {
		return ( 1.0 / af === 1.0 / bf );
	}
	// Check if exactly equal:
	if ( af === bf ) {
		return true;
	}
	// Check ULP difference:
	return ulpdiff( af, bf ) <= maxULP;
}
 
 
// EXPORTS //
 
module.exports = isAlmostSameValue;