@stdlib/complex-float32-base-assert 0.1.0 → 0.2.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( z1, z2, maxULP )`][@stdlib/complex/float32/base/assert/is-almost-equal]</span><span class="delimiter">: </span><span class="description">test whether two single-precision complex floating-point numbers are approximately equal within a specified number of ULPs (units in the last place).</span>
+-   <span class="signature">[`isAlmostSameValue( z1, z2, maxULP )`][@stdlib/complex/float32/base/assert/is-almost-same-value]</span><span class="delimiter">: </span><span class="description">test whether two single-precision complex floating-point numbers are approximately the same value within a specified number of ULPs (units in the last place).</span>
 -   <span class="signature">[`isEqual( z1, z2 )`][@stdlib/complex/float32/base/assert/is-equal]</span><span class="delimiter">: </span><span class="description">test whether two single-precision complex floating-point numbers are equal.</span>
 -   <span class="signature">[`isNotEqual( z1, z2 )`][@stdlib/complex/float32/base/assert/is-not-equal]</span><span class="delimiter">: </span><span class="description">test whether two single-precision complex floating-point numbers are not equal.</span>
 -   <span class="signature">[`isSameValueZero( z1, z2 )`][@stdlib/complex/float32/base/assert/is-same-value-zero]</span><span class="delimiter">: </span><span class="description">test whether two single-precision complex floating-point numbers are the same value.</span>
@@ -142,7 +144,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>
 
@@ -155,8 +157,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/complex-float32-base-assert.svg
 [npm-url]: https://npmjs.org/package/@stdlib/complex-float32-base-assert
 
-[test-image]: https://github.com/stdlib-js/complex-float32-base-assert/actions/workflows/test.yml/badge.svg?branch=v0.1.0
-[test-url]: https://github.com/stdlib-js/complex-float32-base-assert/actions/workflows/test.yml?query=branch:v0.1.0
+[test-image]: https://github.com/stdlib-js/complex-float32-base-assert/actions/workflows/test.yml/badge.svg?branch=v0.2.0
+[test-url]: https://github.com/stdlib-js/complex-float32-base-assert/actions/workflows/test.yml?query=branch:v0.2.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/complex-float32-base-assert/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/complex-float32-base-assert?branch=main
@@ -168,8 +170,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
 
@@ -190,6 +192,10 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 
 <!-- <toc-links> -->
 
+[@stdlib/complex/float32/base/assert/is-almost-equal]: https://www.npmjs.com/package/@stdlib/complex-float32-base-assert-is-almost-equal
+
+[@stdlib/complex/float32/base/assert/is-almost-same-value]: https://www.npmjs.com/package/@stdlib/complex-float32-base-assert-is-almost-same-value
+
 [@stdlib/complex/float32/base/assert/is-equal]: https://www.npmjs.com/package/@stdlib/complex-float32-base-assert-is-equal
 
 [@stdlib/complex/float32/base/assert/is-not-equal]: https://www.npmjs.com/package/@stdlib/complex-float32-base-assert-is-not-equal

package/dist/index.js

@@ -1,3 +1,3 @@
-"use strict";var r=require('@stdlib/utils-define-read-only-property/dist'),e={};r(e,"isEqual",require('@stdlib/complex-float32-base-assert-is-equal/dist'));r(e,"isNotEqual",require('@stdlib/complex-float32-base-assert-is-not-equal/dist'));r(e,"isSameValue",require('@stdlib/complex-float32-base-assert-is-same-value/dist'));r(e,"isSameValueZero",require('@stdlib/complex-float32-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/complex-float32-base-assert-is-almost-equal/dist'));r(e,"isAlmostSameValue",require('@stdlib/complex-float32-base-assert-is-almost-same-value/dist'));r(e,"isEqual",require('@stdlib/complex-float32-base-assert-is-equal/dist'));r(e,"isNotEqual",require('@stdlib/complex-float32-base-assert-is-not-equal/dist'));r(e,"isSameValue",require('@stdlib/complex-float32-base-assert-is-same-value/dist'));r(e,"isSameValueZero",require('@stdlib/complex-float32-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 isEqual\n* @memberof ns\n* @readonly\n* @type {Function}\n* @see {@link module:@stdlib/complex/float32/base/assert/is-equal}\n*/\nsetReadOnly( ns, 'isEqual', require( '@stdlib/complex-float32-base-assert-is-equal' ) );\n\n/**\n* @name isNotEqual\n* @memberof ns\n* @readonly\n* @type {Function}\n* @see {@link module:@stdlib/complex/float32/base/assert/is-not-equal}\n*/\nsetReadOnly( ns, 'isNotEqual', require( '@stdlib/complex-float32-base-assert-is-not-equal' ) );\n\n/**\n* @name isSameValue\n* @memberof ns\n* @readonly\n* @type {Function}\n* @see {@link module:@stdlib/complex/float32/base/assert/is-same-value}\n*/\nsetReadOnly( ns, 'isSameValue', require( '@stdlib/complex-float32-base-assert-is-same-value' ) );\n\n/**\n* @name isSameValueZero\n* @memberof ns\n* @readonly\n* @type {Function}\n* @see {@link module:@stdlib/complex/float32/base/assert/is-same-value-zero}\n*/\nsetReadOnly( ns, 'isSameValueZero', require( '@stdlib/complex-float32-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,UAAW,QAAS,8CAA+C,CAAE,EAStFD,EAAaC,EAAI,aAAc,QAAS,kDAAmD,CAAE,EAS7FD,EAAaC,EAAI,cAAe,QAAS,mDAAoD,CAAE,EAS/FD,EAAaC,EAAI,kBAAmB,QAAS,wDAAyD,CAAE,EAKxG,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/complex/float32/base/assert/is-almost-equal}\n*/\nsetReadOnly( ns, 'isAlmostEqual', require( '@stdlib/complex-float32-base-assert-is-almost-equal' ) );\n\n/**\n* @name isAlmostSameValue\n* @memberof ns\n* @readonly\n* @type {Function}\n* @see {@link module:@stdlib/complex/float32/base/assert/is-almost-same-value}\n*/\nsetReadOnly( ns, 'isAlmostSameValue', require( '@stdlib/complex-float32-base-assert-is-almost-same-value' ) );\n\n/**\n* @name isEqual\n* @memberof ns\n* @readonly\n* @type {Function}\n* @see {@link module:@stdlib/complex/float32/base/assert/is-equal}\n*/\nsetReadOnly( ns, 'isEqual', require( '@stdlib/complex-float32-base-assert-is-equal' ) );\n\n/**\n* @name isNotEqual\n* @memberof ns\n* @readonly\n* @type {Function}\n* @see {@link module:@stdlib/complex/float32/base/assert/is-not-equal}\n*/\nsetReadOnly( ns, 'isNotEqual', require( '@stdlib/complex-float32-base-assert-is-not-equal' ) );\n\n/**\n* @name isSameValue\n* @memberof ns\n* @readonly\n* @type {Function}\n* @see {@link module:@stdlib/complex/float32/base/assert/is-same-value}\n*/\nsetReadOnly( ns, 'isSameValue', require( '@stdlib/complex-float32-base-assert-is-same-value' ) );\n\n/**\n* @name isSameValueZero\n* @memberof ns\n* @readonly\n* @type {Function}\n* @see {@link module:@stdlib/complex/float32/base/assert/is-same-value-zero}\n*/\nsetReadOnly( ns, 'isSameValueZero', require( '@stdlib/complex-float32-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,qDAAsD,CAAE,EASnGD,EAAaC,EAAI,oBAAqB,QAAS,0DAA2D,CAAE,EAS5GD,EAAaC,EAAI,UAAW,QAAS,8CAA+C,CAAE,EAStFD,EAAaC,EAAI,aAAc,QAAS,kDAAmD,CAAE,EAS7FD,EAAaC,EAAI,cAAe,QAAS,mDAAoD,CAAE,EAS/FD,EAAaC,EAAI,kBAAmB,QAAS,wDAAyD,CAAE,EAKxG,OAAO,QAAUA",
   "names": ["setReadOnly", "ns"]
 }

package/docs/types/index.d.ts

@@ -20,6 +20,8 @@
 
 /* eslint-disable max-lines */
 
+import isAlmostEqual = require( '@stdlib/complex-float32-base-assert-is-almost-equal' );
+import isAlmostSameValue = require( '@stdlib/complex-float32-base-assert-is-almost-same-value' );
 import isEqual = require( '@stdlib/complex-float32-base-assert-is-equal' );
 import isNotEqual = require( '@stdlib/complex-float32-base-assert-is-not-equal' );
 import isSameValue = require( '@stdlib/complex-float32-base-assert-is-same-value' );
@@ -29,6 +31,61 @@ import isSameValueZero = require( '@stdlib/complex-float32-base-assert-is-same-v
 * Interface describing the `assert` namespace.
 */
 interface Namespace {
+	/**
+	* Tests whether two single-precision complex 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 has a `NaN` real or imaginary component.
+	* -   The function does not distinguish between `-0` and `+0`, treating them as equal.
+	*
+	* @param z1 - first complex number
+	* @param z2 - second complex number
+	* @param maxULP - maximum allowed ULP difference
+	* @returns boolean indicating whether two single-precision complex floating-point numbers are approximately equal within a specified number of ULPs
+	*
+	* @example
+	* var EPS = require( '@stdlib/constants-float32-eps' );
+	* var Complex64 = require( '@stdlib/complex-float32-ctor' );
+	*
+	* var z1 = new Complex64( 1.0, 3.0 );
+	* var z2 = new Complex64( 1.0+EPS, 3.0 );
+	*
+	* var bool = ns.isAlmostEqual( z1, z2, 0 );
+	* // returns false
+	*
+	* bool = ns.isAlmostEqual( z1, z2, 1 );
+	* // returns true
+	*/
+	isAlmostEqual: typeof isAlmostEqual;
+
+	/**
+	* Tests whether two single-precision complex 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 z1 - first complex number
+	* @param z2 - second complex number
+	* @param maxULP - maximum allowed ULP difference
+	* @returns boolean indicating whether two single-precision complex floating-point numbers are approximately the same value within a specified number of ULPs
+	*
+	* @example
+	* var EPS = require( '@stdlib/constants-float32-eps' );
+	* var Complex64 = require( '@stdlib/complex-float32-ctor' );
+	*
+	* var z1 = new Complex64( 1.0, 3.0 );
+	* var z2 = new Complex64( 1.0+EPS, 3.0 );
+	*
+	* var bool = ns.isAlmostSameValue( z1, z2, 0 );
+	* // returns false
+	*
+	* bool = ns.isAlmostSameValue( z1, z2, 1 );
+	* // returns true
+	*/
+	isAlmostSameValue: typeof isAlmostSameValue;
+
 	/**
 	* Tests whether two single-precision complex floating-point numbers are equal.
 	*

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/complex/float32/base/assert/is-almost-equal}
+*/
+setReadOnly( ns, 'isAlmostEqual', require( '@stdlib/complex-float32-base-assert-is-almost-equal' ) );
+
+/**
+* @name isAlmostSameValue
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/complex/float32/base/assert/is-almost-same-value}
+*/
+setReadOnly( ns, 'isAlmostSameValue', require( '@stdlib/complex-float32-base-assert-is-almost-same-value' ) );
+
 /**
 * @name isEqual
 * @memberof ns

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/complex-float32-base-assert",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Base (i.e., lower-level) single-precision complex number assertion functions.",
   "license": "Apache-2.0",
   "author": {
@@ -30,10 +30,12 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/complex-float32-base-assert-is-equal": "^0.1.1",
-    "@stdlib/complex-float32-base-assert-is-not-equal": "^0.1.1",
-    "@stdlib/complex-float32-base-assert-is-same-value": "^0.1.1",
-    "@stdlib/complex-float32-base-assert-is-same-value-zero": "^0.0.1",
+    "@stdlib/complex-float32-base-assert-is-almost-equal": "github:stdlib-js/complex-float32-base-assert-is-almost-equal#main",
+    "@stdlib/complex-float32-base-assert-is-almost-same-value": "github:stdlib-js/complex-float32-base-assert-is-almost-same-value#main",
+    "@stdlib/complex-float32-base-assert-is-equal": "^0.1.2",
+    "@stdlib/complex-float32-base-assert-is-not-equal": "^0.1.2",
+    "@stdlib/complex-float32-base-assert-is-same-value": "^0.1.2",
+    "@stdlib/complex-float32-base-assert-is-same-value-zero": "^0.1.1",
     "@stdlib/utils-define-read-only-property": "^0.2.2"
   },
   "devDependencies": {},