@stdlib/number-float32-base-assert 0.1.0 → 0.2.1

package/README.md

@@ -66,6 +66,13 @@ The namespace contains the following functions:
 
 <!-- <toc pattern="*"> -->
 
+<div class="namespace-toc">
+
+-   <span class="signature">[`isSameValueZerof( a, b )`][@stdlib/number/float32/base/assert/is-same-value-zero]</span><span class="delimiter">: </span><span class="description">test if two single-precision floating-point numbers are the same value.</span>
+-   <span class="signature">[`isSameValuef( a, b )`][@stdlib/number/float32/base/assert/is-same-value]</span><span class="delimiter">: </span><span class="description">test if two single-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-float32-base-assert.svg
 [npm-url]: https://npmjs.org/package/@stdlib/number-float32-base-assert
 
-[test-image]: https://github.com/stdlib-js/number-float32-base-assert/actions/workflows/test.yml/badge.svg?branch=v0.1.0
-[test-url]: https://github.com/stdlib-js/number-float32-base-assert/actions/workflows/test.yml?query=branch:v0.1.0
+[test-image]: https://github.com/stdlib-js/number-float32-base-assert/actions/workflows/test.yml/badge.svg?branch=v0.2.1
+[test-url]: https://github.com/stdlib-js/number-float32-base-assert/actions/workflows/test.yml?query=branch:v0.2.1
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/number-float32-base-assert/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/number-float32-base-assert?branch=main
@@ -181,6 +188,10 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 
 <!-- <toc-links> -->
 
+[@stdlib/number/float32/base/assert/is-same-value-zero]: https://www.npmjs.com/package/@stdlib/number-float32-base-assert-is-same-value-zero
+
+[@stdlib/number/float32/base/assert/is-same-value]: https://www.npmjs.com/package/@stdlib/number-float32-base-assert-is-same-value
+
 <!-- </toc-links> -->
 
 </section>

package/docs/types/index.d.ts

@@ -20,20 +20,90 @@
 
 /* eslint-disable max-lines */
 
-import isSameValue = require( '@stdlib/number-float32-base-assert-is-same-value' );
+import isSameValuef = require( '@stdlib/number-float32-base-assert-is-same-value' );
+import isSameValueZerof = require( '@stdlib/number-float32-base-assert-is-same-value-zero' );
 
 /**
 * Interface describing the `assert` namespace.
 */
 interface Namespace {
 	/**
-	* TODO
+	* Tests if two single-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 single-precision floating-point numbers are the same value
+	*
+	* @example
+	* var toFloat32 = require( '@stdlib/number-float64-base-to-float32' );
+	*
+	* var bool = ns.isSameValuef( toFloat32( 3.14 ), toFloat32( 3.14 ) );
+	* // returns true
+	*
+	* @example
+	* var toFloat32 = require( '@stdlib/number-float64-base-to-float32' );
+	*
+	* var bool = ns.isSameValuef( toFloat32( -0.0 ), toFloat32( -0.0 ) );
+	* // returns true
+	*
+	* @example
+	* var toFloat32 = require( '@stdlib/number-float64-base-to-float32' );
+	*
+	* var bool = ns.isSameValuef( toFloat32( -0.0 ), toFloat32( 0.0 ) );
+	* // returns false
+	*
+	* @example
+	* var toFloat32 = require( '@stdlib/number-float64-base-to-float32' );
+	*
+	* var bool = ns.isSameValuef( toFloat32( NaN ), toFloat32( NaN ) );
+	* // returns true
 	*/
-	isSameValue: typeof isSameValue;
+	isSameValuef: typeof isSameValuef;
+
+	/**
+	* Tests if two single-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 single-precision floating-point numbers are the same value
+	*
+	* @example
+	* var toFloat32 = require( '@stdlib/number-float64-base-to-float32' );
+	*
+	* var bool = ns.isSameValueZerof( toFloat32( 3.14 ), toFloat32( 3.14 ) );
+	* // returns true
+	*
+	* @example
+	* var toFloat32 = require( '@stdlib/number-float64-base-to-float32' );
+	*
+	* var bool = ns.isSameValueZerof( toFloat32( -0.0 ), toFloat32( -0.0 ) );
+	* // returns true
+	*
+	* @example
+	* var toFloat32 = require( '@stdlib/number-float64-base-to-float32' );
+	*
+	* var bool = ns.isSameValueZerof( toFloat32( -0.0 ), toFloat32( 0.0 ) );
+	* // returns true
+	*
+	* @example
+	* var toFloat32 = require( '@stdlib/number-float64-base-to-float32' );
+	*
+	* var bool = ns.isSameValueZerof( toFloat32( NaN ), toFloat32( NaN ) );
+	* // returns true
+	*/
+	isSameValueZerof: typeof isSameValueZerof;
 }
 
 /**
-* Base single-precision floating-point number assert functions.
+* Base double-precision floating-point number assert functions.
 */
 declare var ns: Namespace;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/number-float32-base-assert",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "description": "Base double-precision floating-point number assert functions.",
   "license": "Apache-2.0",
   "author": {
@@ -16,17 +16,11 @@
   "main": "lib/index.js",
   "directories": {
     "doc": "./docs",
-    "example": "./examples",
     "lib": "./lib",
-    "test": "./test"
+    "dist": "./dist"
   },
   "types": "./docs/types",
-  "scripts": {
-    "test": "make test",
-    "test-cov": "make test-cov",
-    "examples": "make examples",
-    "benchmark": "make benchmark"
-  },
+  "scripts": {},
   "homepage": "https://stdlib.io",
   "repository": {
     "type": "git",
@@ -36,22 +30,11 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/number-float32-base-assert-is-same-value": "^0.1.0",
-    "@stdlib/number-float32-base-assert-is-same-value-zero": "^0.1.0",
-    "@stdlib/utils-define-read-only-property": "^0.1.1"
-  },
-  "devDependencies": {
-    "@stdlib/assert-is-boolean": "^0.1.1",
-    "@stdlib/boolean-ctor": "^0.1.1",
-    "@stdlib/number-float64-base-to-float32": "^0.1.1",
-    "@stdlib/utils-keys": "^0.1.0",
-    "@stdlib/utils-try-require": "^0.1.1",
-    "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/number-float32-base-assert-is-same-value": "^0.2.1",
+    "@stdlib/number-float32-base-assert-is-same-value-zero": "^0.1.1",
+    "@stdlib/utils-define-read-only-property": "^0.2.1"
   },
+  "devDependencies": {},
   "engines": {
     "node": ">=0.10.0",
     "npm": ">2.7.0"