All files / number/float64/base/assert/is-almost-equal-value/lib main.js

100% Statements 72/72
100% Branches 2/2
100% Functions 1/1
100% Lines 72/72

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 731x 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 24x 24x 24x 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 ulpdiff = require( '@stdlib/number/float64/base/ulp-difference' );
 
 
// MAIN //
 
/**
* Tests if two double-precision floating-point numbers are approximately equal within a specified number of ULPs (units in the last place).
*
* ## Notes
*
* -   The function returns `false` if either input value is `NaN`.
* -   The function does not distinguish between `-0` and `+0`, treating them as equal.
*
* @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 double-precision floating-point numbers are approximately equal within a specified number of ULPs
*
* @example
* var EPS = require( '@stdlib/constants/float64/eps' );
*
* var bool = isAlmostEqualValue( 1.0, 1.0+EPS, 1 );
* // returns true
*
* var bool = isAlmostEqualValue( 1.0+EPS, 1.0, 1 );
* // returns true
*
* bool = isAlmostEqualValue( 1.0, 1.0+EPS+EPS, 1 );
* // returns false
*
* bool = isAlmostEqualValue( 1.0, 1.0+EPS, 0 );
* // returns false
*
* bool = isAlmostEqualValue( 0.0, -0.0, 0 );
* // returns true
*
* bool = isAlmostEqualValue( 1.0, NaN, 1 );
* // returns false
*
* bool = isAlmostEqualValue( NaN, NaN, 1 );
* // returns false
*/
function isAlmostEqualValue( a, b, maxULP ) {
	return ulpdiff( a, b ) <= maxULP;
}
 
 
// EXPORTS //
 
module.exports = isAlmostEqualValue;