@stdlib/number-float64-base-assert 0.1.0 → 0.2.0

package/README.md

@@ -66,6 +66,13 @@ The namespace contains the following functions:
 
 <!-- <toc pattern="*"> -->
 
+<div class="namespace-toc">
+
+-   <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>
+
+</div>
+
 <!-- </toc> -->
 
 </section>
@@ -146,8 +153,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.1.0
-[test-url]: https://github.com/stdlib-js/number-float64-base-assert/actions/workflows/test.yml?query=branch:v0.1.0
+[test-image]: https://github.com/stdlib-js/number-float64-base-assert/actions/workflows/test.yml/badge.svg?branch=v0.2.0
+[test-url]: https://github.com/stdlib-js/number-float64-base-assert/actions/workflows/test.yml?query=branch:v0.2.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
@@ -170,14 +177,21 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
 
 [deno-url]: https://github.com/stdlib-js/number-float64-base-assert/tree/deno
+[deno-readme]: https://github.com/stdlib-js/number-float64-base-assert/blob/deno/README.md
 [umd-url]: https://github.com/stdlib-js/number-float64-base-assert/tree/umd
+[umd-readme]: https://github.com/stdlib-js/number-float64-base-assert/blob/umd/README.md
 [esm-url]: https://github.com/stdlib-js/number-float64-base-assert/tree/esm
+[esm-readme]: https://github.com/stdlib-js/number-float64-base-assert/blob/esm/README.md
 [branches-url]: https://github.com/stdlib-js/number-float64-base-assert/blob/main/branches.md
 
 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/number-float64-base-assert/main/LICENSE
 
 <!-- <toc-links> -->
 
+[@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
+
 <!-- </toc-links> -->
 
 </section>

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'));module.exports=e;
+"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;
 /** @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// EXPORTS //\n\nmodule.exports = ns;\n"],
-  "mappings": "aA0BA,IAAIA,EAAc,QAAS,yCAA0C,EAUjEC,EAAK,CAAC,EASVD,EAAaC,EAAI,cAAe,QAAS,kDAAmD,CAAE,EAK9F,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 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",
   "names": ["setReadOnly", "ns"]
 }

package/docs/types/index.d.ts

@@ -21,15 +21,69 @@
 /* eslint-disable max-lines */
 
 import isSameValue = require( '@stdlib/number-float64-base-assert-is-same-value' );
+import isSameValueZero = require( '@stdlib/number-float64-base-assert-is-same-value-zero' );
 
 /**
 * Interface describing the `assert` namespace.
 */
 interface Namespace {
 	/**
-	* TODO
+	* Tests if two double-precision floating-point numbers are the same value.
+	*
+	* ## 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
+	* @returns boolean indicating whether two double-precision floating-point numbers are the same value
+	*
+	* @example
+	* var bool = ns.isSameValue( 3.14, 3.14 );
+	* // returns true
+	*
+	* @example
+	* var bool = ns.isSameValue( -0.0, -0.0 );
+	* // returns true
+	*
+	* @example
+	* var bool = ns.isSameValue( -0.0, 0.0 );
+	* // returns false
+	*
+	* @example
+	* var bool = ns.isSameValue( NaN, NaN );
+	* // returns true
 	*/
 	isSameValue: typeof isSameValue;
+
+	/**
+	* Tests if two double-precision floating-point numbers are the same value.
+	*
+	* ## Notes
+	*
+	* -   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
+	* @returns boolean indicating whether two double-precision floating-point numbers are the same value
+	*
+	* @example
+	* var bool = ns.isSameValueZero( 3.14, 3.14 );
+	* // returns true
+	*
+	* @example
+	* var bool = ns.isSameValueZero( -0.0, -0.0 );
+	* // returns true
+	*
+	* @example
+	* var bool = ns.isSameValueZero( -0.0, 0.0 );
+	* // returns true
+	*
+	* @example
+	* var bool = ns.isSameValueZero( NaN, NaN );
+	* // returns true
+	*/
+	isSameValueZero: typeof isSameValueZero;
 }
 
 /**

package/lib/index.js

@@ -45,6 +45,15 @@ var ns = {};
 */
 setReadOnly( ns, 'isSameValue', require( '@stdlib/number-float64-base-assert-is-same-value' ) );
 
+/**
+* @name isSameValueZero
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/number/float64/base/assert/is-same-value-zero}
+*/
+setReadOnly( ns, 'isSameValueZero', require( '@stdlib/number-float64-base-assert-is-same-value-zero' ) );
+
 
 // EXPORTS //
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/number-float64-base-assert",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Base double-precision floating-point number assert functions.",
   "license": "Apache-2.0",
   "author": {
@@ -36,19 +36,20 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/number-float64-base-assert-is-same-value": "github:stdlib-js/number-float64-base-assert-is-same-value#main",
-    "@stdlib/utils-define-read-only-property": "^0.1.1"
+    "@stdlib/number-float64-base-assert-is-same-value": "^0.2.0",
+    "@stdlib/number-float64-base-assert-is-same-value-zero": "^0.2.0",
+    "@stdlib/utils-define-read-only-property": "^0.2.0"
   },
   "devDependencies": {
     "@stdlib/assert-is-boolean": "^0.1.1",
     "@stdlib/boolean-ctor": "^0.1.1",
     "@stdlib/utils-keys": "^0.1.0",
-    "@stdlib/utils-try-require": "^0.1.1",
+    "@stdlib/utils-try-require": "^0.2.0",
     "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
     "istanbul": "^0.4.1",
     "tap-min": "git+https://github.com/Planeshifter/tap-min.git",
     "@stdlib/bench-harness": "^0.1.2",
-    "@stdlib/bench": "^0.2.1"
+    "@stdlib/bench": "^0.3.1"
   },
   "engines": {
     "node": ">=0.10.0",