All files / is-almost-same-value/lib main.js

85.54% Statements 71/83
100% Branches 1/1
0% Functions 0/1
85.54% Lines 71/83

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 842x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x                         2x 2x 2x 2x 2x  
/**
* @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 isAlmostSameValueComplex = require( '@stdlib/complex/base/assert/is-almost-same-value' );
var isAlmostSameValueF64 = require( '@stdlib/number/float64/base/assert/is-almost-same-value' );
var isComplexLike = require( '@stdlib/assert/is-complex-like' );
var isNumber = require( '@stdlib/assert/is-number' ).isPrimitive;
 
 
// MAIN //
 
/**
* Tests if two arguments 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 {*} a - first input value
* @param {*} b - second input value
* @param {NonNegativeInteger} maxULP - maximum allowed ULP difference
* @returns {boolean} boolean indicating whether two arguments are approximately the same value within a specified number of ULPs
*
* @example
* var EPS = require( '@stdlib/constants/float64/eps' );
*
* var bool = isAlmostSameValue( 1.0, 1.0+EPS, 0 );
* // returns false
*
* bool = isAlmostSameValue( 1.0, 1.0+EPS, 1 );
* // returns true
*
* bool = isAlmostSameValue( {}, {}, 0 );
* // returns false
*
* bool = isAlmostSameValue( -0.0, 0.0, 0 );
* // returns false
*
* bool = isAlmostSameValue( NaN, NaN, 0 );
* // returns true
*
* bool = isAlmostSameValue( [], [], 1 );
* // returns false
*/
function isAlmostSameValue( a, b, maxULP ) {
	if ( a === b && a !== 0 ) {
		return true;
	}
	if ( isNumber( a ) && isNumber( b ) ) {
		return isAlmostSameValueF64( a, b, maxULP );
	}
	if ( isComplexLike( a ) && isComplexLike( b ) ) {
		return isAlmostSameValueComplex( a, b, maxULP );
	}
	return false;
}
 
 
// EXPORTS //
 
module.exports = isAlmostSameValue;