@stdlib/number-float64-base-assert 0.2.1 → 0.3.0

package/NOTICE

@@ -1 +1 @@
-Copyright (c) 2016-2024 The Stdlib Authors.
+Copyright (c) 2016-2026 The Stdlib Authors.

package/README.md

@@ -68,6 +68,8 @@ The namespace contains the following functions:
 
 <div class="namespace-toc">
 
+-   <span class="signature">[`isAlmostEqual( a, b, maxULP )`][@stdlib/number/float64/base/assert/is-almost-equal]</span><span class="delimiter">: </span><span class="description">test if two double-precision floating-point numbers are approximately equal within a specified number of ULPs (units in the last place).</span>
+-   <span class="signature">[`isAlmostSameValue( a, b, maxULP )`][@stdlib/number/float64/base/assert/is-almost-same-value]</span><span class="delimiter">: </span><span class="description">test if two double-precision floating-point numbers are approximately the same value within a specified number of ULPs (units in the last place).</span>
 -   <span class="signature">[`isSameValueZero( a, b )`][@stdlib/number/float64/base/assert/is-same-value-zero]</span><span class="delimiter">: </span><span class="description">test if two double-precision floating-point numbers are the same value.</span>
 -   <span class="signature">[`isSameValue( a, b )`][@stdlib/number/float64/base/assert/is-same-value]</span><span class="delimiter">: </span><span class="description">test if two double-precision floating-point numbers are the same value.</span>
 
@@ -140,7 +142,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2026. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -153,8 +155,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/number-float64-base-assert.svg
 [npm-url]: https://npmjs.org/package/@stdlib/number-float64-base-assert
 
-[test-image]: https://github.com/stdlib-js/number-float64-base-assert/actions/workflows/test.yml/badge.svg?branch=v0.2.1
-[test-url]: https://github.com/stdlib-js/number-float64-base-assert/actions/workflows/test.yml?query=branch:v0.2.1
+[test-image]: https://github.com/stdlib-js/number-float64-base-assert/actions/workflows/test.yml/badge.svg?branch=v0.3.0
+[test-url]: https://github.com/stdlib-js/number-float64-base-assert/actions/workflows/test.yml?query=branch:v0.3.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/number-float64-base-assert/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/number-float64-base-assert?branch=main
@@ -166,8 +168,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 
 -->
 
-[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
-[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
+[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
+[chat-url]: https://stdlib.zulipchat.com
 
 [stdlib]: https://github.com/stdlib-js/stdlib
 
@@ -188,6 +190,10 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 
 <!-- <toc-links> -->
 
+[@stdlib/number/float64/base/assert/is-almost-equal]: https://www.npmjs.com/package/@stdlib/number-float64-base-assert-is-almost-equal
+
+[@stdlib/number/float64/base/assert/is-almost-same-value]: https://www.npmjs.com/package/@stdlib/number-float64-base-assert-is-almost-same-value
+
 [@stdlib/number/float64/base/assert/is-same-value-zero]: https://www.npmjs.com/package/@stdlib/number-float64-base-assert-is-same-value-zero
 
 [@stdlib/number/float64/base/assert/is-same-value]: https://www.npmjs.com/package/@stdlib/number-float64-base-assert-is-same-value

package/dist/index.js

@@ -1,3 +1,3 @@
-"use strict";var r=require('@stdlib/utils-define-read-only-property/dist'),e={};r(e,"isSameValue",require('@stdlib/number-float64-base-assert-is-same-value/dist'));r(e,"isSameValueZero",require('@stdlib/number-float64-base-assert-is-same-value-zero/dist'));module.exports=e;
+"use strict";var r=require('@stdlib/utils-define-read-only-property/dist'),e={};r(e,"isAlmostEqual",require('@stdlib/number-float64-base-assert-is-almost-equal/dist'));r(e,"isAlmostSameValue",require('@stdlib/number-float64-base-assert-is-almost-same-value/dist'));r(e,"isSameValue",require('@stdlib/number-float64-base-assert-is-same-value/dist'));r(e,"isSameValueZero",require('@stdlib/number-float64-base-assert-is-same-value-zero/dist'));module.exports=e;
 /** @license Apache-2.0 */
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../lib/index.js"],
-  "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/*\n* When adding modules to the namespace, ensure that they are added in alphabetical order according to module name.\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-read-only-property' );\n\n\n// MAIN //\n\n/**\n* Top-level namespace.\n*\n* @namespace ns\n*/\nvar ns = {};\n\n/**\n* @name isSameValue\n* @memberof ns\n* @readonly\n* @type {Function}\n* @see {@link module:@stdlib/number/float64/base/assert/is-same-value}\n*/\nsetReadOnly( ns, 'isSameValue', require( '@stdlib/number-float64-base-assert-is-same-value' ) );\n\n/**\n* @name isSameValueZero\n* @memberof ns\n* @readonly\n* @type {Function}\n* @see {@link module:@stdlib/number/float64/base/assert/is-same-value-zero}\n*/\nsetReadOnly( ns, 'isSameValueZero', require( '@stdlib/number-float64-base-assert-is-same-value-zero' ) );\n\n\n// EXPORTS //\n\nmodule.exports = ns;\n"],
-  "mappings": "aA0BA,IAAIA,EAAc,QAAS,yCAA0C,EAUjEC,EAAK,CAAC,EASVD,EAAaC,EAAI,cAAe,QAAS,kDAAmD,CAAE,EAS9FD,EAAaC,EAAI,kBAAmB,QAAS,uDAAwD,CAAE,EAKvG,OAAO,QAAUA",
+  "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/*\n* When adding modules to the namespace, ensure that they are added in alphabetical order according to module name.\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-read-only-property' );\n\n\n// MAIN //\n\n/**\n* Top-level namespace.\n*\n* @namespace ns\n*/\nvar ns = {};\n\n/**\n* @name isAlmostEqual\n* @memberof ns\n* @readonly\n* @type {Function}\n* @see {@link module:@stdlib/number/float64/base/assert/is-almost-equal}\n*/\nsetReadOnly( ns, 'isAlmostEqual', require( '@stdlib/number-float64-base-assert-is-almost-equal' ) );\n\n/**\n* @name isAlmostSameValue\n* @memberof ns\n* @readonly\n* @type {Function}\n* @see {@link module:@stdlib/number/float64/base/assert/is-almost-same-value}\n*/\nsetReadOnly( ns, 'isAlmostSameValue', require( '@stdlib/number-float64-base-assert-is-almost-same-value' ) );\n\n/**\n* @name isSameValue\n* @memberof ns\n* @readonly\n* @type {Function}\n* @see {@link module:@stdlib/number/float64/base/assert/is-same-value}\n*/\nsetReadOnly( ns, 'isSameValue', require( '@stdlib/number-float64-base-assert-is-same-value' ) );\n\n/**\n* @name isSameValueZero\n* @memberof ns\n* @readonly\n* @type {Function}\n* @see {@link module:@stdlib/number/float64/base/assert/is-same-value-zero}\n*/\nsetReadOnly( ns, 'isSameValueZero', require( '@stdlib/number-float64-base-assert-is-same-value-zero' ) );\n\n\n// EXPORTS //\n\nmodule.exports = ns;\n"],
+  "mappings": "aA0BA,IAAIA,EAAc,QAAS,yCAA0C,EAUjEC,EAAK,CAAC,EASVD,EAAaC,EAAI,gBAAiB,QAAS,oDAAqD,CAAE,EASlGD,EAAaC,EAAI,oBAAqB,QAAS,yDAA0D,CAAE,EAS3GD,EAAaC,EAAI,cAAe,QAAS,kDAAmD,CAAE,EAS9FD,EAAaC,EAAI,kBAAmB,QAAS,uDAAwD,CAAE,EAKvG,OAAO,QAAUA",
   "names": ["setReadOnly", "ns"]
 }

package/docs/types/index.d.ts

@@ -20,6 +20,8 @@
 
 /* eslint-disable max-lines */
 
+import isAlmostEqual = require( '@stdlib/number-float64-base-assert-is-almost-equal' );
+import isAlmostSameValue = require( '@stdlib/number-float64-base-assert-is-almost-same-value' );
 import isSameValue = require( '@stdlib/number-float64-base-assert-is-same-value' );
 import isSameValueZero = require( '@stdlib/number-float64-base-assert-is-same-value-zero' );
 
@@ -27,6 +29,83 @@ import isSameValueZero = require( '@stdlib/number-float64-base-assert-is-same-va
 * Interface describing the `assert` namespace.
 */
 interface Namespace {
+	/**
+	* 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 a - first input value
+	* @param b - second input value
+	* @param maxULP - maximum allowed ULP difference
+	* @returns 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 = ns.isAlmostEqual( 1.0, 1.0+EPS, 1 );
+	* // returns true
+	*
+	* bool = ns.isAlmostEqual( 1.0+EPS, 1.0, 1 );
+	* // returns true
+	*
+	* bool = ns.isAlmostEqual( 1.0, 1.0+EPS+EPS, 1 );
+	* // returns false
+	*
+	* bool = ns.isAlmostEqual( 1.0, 1.0+EPS, 0 );
+	* // returns false
+	*
+	* bool = ns.isAlmostEqual( 0.0, -0.0, 0 );
+	* // returns true
+	*
+	* bool = ns.isAlmostEqual( 1.0, NaN, 1 );
+	* // returns false
+	*
+	* bool = ns.isAlmostEqual( NaN, NaN, 1 );
+	* // returns false
+	*/
+	isAlmostEqual: typeof isAlmostEqual;
+
+	/**
+	* Tests if two double-precision floating-point numbers are approximately the same value within a specified number of ULPs (units in the last place).
+	*
+	* ## Notes
+	*
+	* -   The function differs from the `===` operator in that the function treats `-0` and `+0` as distinct and `NaNs` as the same.
+	*
+	* @param a - first input value
+	* @param b - second input value
+	* @param maxULP - maximum allowed ULP difference
+	* @returns boolean indicating whether two double-precision floating-point numbers are approximately the same value within a specified number of ULPs
+	*
+	* @example
+	* var EPS = require( '@stdlib/constants-float64-eps' );
+	*
+	* var bool = ns.isAlmostSameValue( 1.0, 1.0+EPS, 1 );
+	* // returns true
+	*
+	* bool = ns.isAlmostSameValue( 1.0+EPS, 1.0, 1 );
+	* // returns true
+	*
+	* bool = ns.isAlmostSameValue( 1.0, 1.0+EPS+EPS, 1 );
+	* // returns false
+	*
+	* bool = ns.isAlmostSameValue( 1.0, 1.0+EPS, 0 );
+	* // returns false
+	*
+	* bool = ns.isAlmostSameValue( 0.0, -0.0, 0 );
+	* // returns false
+	*
+	* bool = ns.isAlmostSameValue( 1.0, NaN, 1 );
+	* // returns false
+	*
+	* bool = ns.isAlmostSameValue( NaN, NaN, 1 );
+	* // returns true
+	*/
+	isAlmostSameValue: typeof isAlmostSameValue;
+
 	/**
 	* Tests if two double-precision floating-point numbers are the same value.
 	*
@@ -61,7 +140,7 @@ interface Namespace {
 	*
 	* ## Notes
 	*
-	* -   The function differs from the `===` operator in that the function treats ``NaNs` as the same value.
+	* -   The function differs from the `===` operator in that the function treats `NaNs` as the same value.
 	*
 	* @param a - first input value
 	* @param b - second input value

package/lib/index.js

@@ -36,6 +36,24 @@ var setReadOnly = require( '@stdlib/utils-define-read-only-property' );
 */
 var ns = {};
 
+/**
+* @name isAlmostEqual
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/number/float64/base/assert/is-almost-equal}
+*/
+setReadOnly( ns, 'isAlmostEqual', require( '@stdlib/number-float64-base-assert-is-almost-equal' ) );
+
+/**
+* @name isAlmostSameValue
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/number/float64/base/assert/is-almost-same-value}
+*/
+setReadOnly( ns, 'isAlmostSameValue', require( '@stdlib/number-float64-base-assert-is-almost-same-value' ) );
+
 /**
 * @name isSameValue
 * @memberof ns

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/number-float64-base-assert",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "Base double-precision floating-point number assert functions.",
   "license": "Apache-2.0",
   "author": {
@@ -30,9 +30,11 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
+    "@stdlib/number-float64-base-assert-is-almost-equal": "github:stdlib-js/number-float64-base-assert-is-almost-equal#main",
+    "@stdlib/number-float64-base-assert-is-almost-same-value": "github:stdlib-js/number-float64-base-assert-is-almost-same-value#main",
     "@stdlib/number-float64-base-assert-is-same-value": "^0.2.1",
     "@stdlib/number-float64-base-assert-is-same-value-zero": "^0.1.1",
-    "@stdlib/utils-define-read-only-property": "^0.2.1"
+    "@stdlib/utils-define-read-only-property": "^0.2.2"
   },
   "devDependencies": {},
   "engines": {