feat: add complex/base/assert namespace

kgryte · kgryte · commit 6e539e715f29 · 2025-12-17T16:57:26.000-08:00
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: passed
  - task: lint_package_json
    status: passed
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: passed
  - task: lint_javascript_tests
    status: passed
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: passed
  - task: lint_license_headers
    status: passed
---
diff --git a/lib/node_modules/@stdlib/complex/base/assert/README.md b/lib/node_modules/@stdlib/complex/base/assert/README.md
@@ -0,0 +1,105 @@
+<!--
+
+@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.
+
+-->
+
+# Assert
+
+> Base (i.e., lower-level) complex number assertion functions.
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var assert = require( '@stdlib/complex/base/assert' );
+```
+
+#### assert
+
+Namespace containing base (i.e., lower-level) complex number assertion functions.
+
+```javascript
+var ns = assert;
+// returns {...}
+```
+
+The namespace contains the following functions:
+
+<!-- <toc pattern="*"> -->
+
+<div class="namespace-toc">
+
+-   <span class="signature">[`isAlmostEqual( z1, z2, maxULP )`][@stdlib/complex/base/assert/is-almost-equal]</span><span class="delimiter">: </span><span class="description">test whether two complex numbers are approximately equal within a specified number of ULPs (units in the last place).</span>
+
+</div>
+
+<!-- </toc> -->
+
+</section>
+
+<!-- /.usage -->
+
+<!-- Package notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- TODO: better examples -->
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var objectKeys = require( '@stdlib/utils/keys' );
+var ns = require( '@stdlib/complex/base/assert' );
+
+console.log( objectKeys( ns ) );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+<!-- <toc-links> -->
+
+[@stdlib/complex/base/assert/is-almost-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/base/assert/is-almost-equal
+
+<!-- </toc-links> -->
+
+</section>
+
+<!-- /.links -->
diff --git a/lib/node_modules/@stdlib/complex/base/assert/docs/types/index.d.ts b/lib/node_modules/@stdlib/complex/base/assert/docs/types/index.d.ts
@@ -0,0 +1,66 @@
+/*
+* @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.
+*/
+
+// TypeScript Version: 4.1
+
+/* eslint-disable max-lines */
+
+import isAlmostEqual = require( '@stdlib/complex/base/assert/is-almost-equal' );
+
+/**
+* Interface describing the `assert` namespace.
+*/
+interface Namespace {
+	/**
+	* Tests whether two complex 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 complex 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;
+}
+
+/**
+* Base (i.e., lower-level) complex number assertion functions.
+*/
+declare var ns: Namespace;
+
+
+// EXPORTS //
+
+export = ns;
diff --git a/lib/node_modules/@stdlib/complex/base/assert/docs/types/test.ts b/lib/node_modules/@stdlib/complex/base/assert/docs/types/test.ts
@@ -0,0 +1,29 @@
+/*
+* @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.
+*/
+
+/* eslint-disable @typescript-eslint/no-unused-expressions */
+
+import ns = require( './index' );
+
+
+// TESTS //
+
+// The exported value is the expected interface...
+{
+	ns; // $ExpectType Namespace
+}
diff --git a/lib/node_modules/@stdlib/complex/base/assert/examples/index.js b/lib/node_modules/@stdlib/complex/base/assert/examples/index.js
@@ -0,0 +1,24 @@
+/**
+* @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';
+
+var objectKeys = require( '@stdlib/utils/keys' );
+var ns = require( './../lib' );
+
+console.log( objectKeys( ns ) );
diff --git a/lib/node_modules/@stdlib/complex/base/assert/lib/index.js b/lib/node_modules/@stdlib/complex/base/assert/lib/index.js
@@ -0,0 +1,60 @@
+/**
+* @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';
+
+/*
+* When adding modules to the namespace, ensure that they are added in alphabetical order according to module name.
+*/
+
+// MODULES //
+
+var setReadOnly = require( '@stdlib/utils/define-read-only-property' );
+
+
+// MAIN //
+
+/**
+* Top-level namespace.
+*
+* @namespace ns
+*/
+var ns = {};
+
+/**
+* @name isAlmostEqual
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/complex/base/assert/is-almost-equal}
+*/
+setReadOnly( ns, 'isAlmostEqual', require( '@stdlib/complex/base/assert/is-almost-equal' ) );
+
+/**
+* @name isAlmostSameValue
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/complex/base/assert/is-almost-same-value}
+*/
+setReadOnly( ns, 'isAlmostSameValue', require( '@stdlib/complex/base/assert/is-almost-same-value' ) );
+
+
+// EXPORTS //
+
+module.exports = ns;
diff --git a/lib/node_modules/@stdlib/complex/base/assert/package.json b/lib/node_modules/@stdlib/complex/base/assert/package.json
@@ -0,0 +1,62 @@
+{
+  "name": "@stdlib/complex/base/assert",
+  "version": "0.0.0",
+  "description": "Base (i.e., lower-level) complex number assertion functions.",
+  "license": "Apache-2.0",
+  "author": {
+    "name": "The Stdlib Authors",
+    "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
+  },
+  "contributors": [
+    {
+      "name": "The Stdlib Authors",
+      "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
+    }
+  ],
+  "main": "lib/index.js",
+  "directories": {
+    "doc": "./docs",
+    "example": "./examples",
+    "lib": "./lib",
+    "test": "./test"
+  },
+  "types": "./docs/types",
+  "scripts": {},
+  "homepage": "https://github.com/stdlib-js/stdlib",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/stdlib-js/stdlib.git"
+  },
+  "bugs": {
+    "url": "https://github.com/stdlib-js/stdlib/issues"
+  },
+  "dependencies": {},
+  "devDependencies": {},
+  "engines": {
+    "node": ">=0.10.0",
+    "npm": ">2.7.0"
+  },
+  "os": [
+    "aix",
+    "darwin",
+    "freebsd",
+    "linux",
+    "macos",
+    "openbsd",
+    "sunos",
+    "win32",
+    "windows"
+  ],
+  "keywords": [
+    "stdlib",
+    "stdtypes",
+    "types",
+    "complex",
+    "cmplx",
+    "number",
+    "namespace",
+    "ns",
+    "base",
+    "assert"
+  ]
+}
diff --git a/lib/node_modules/@stdlib/complex/base/assert/test/test.js b/lib/node_modules/@stdlib/complex/base/assert/test/test.js
@@ -0,0 +1,40 @@
+/**
+* @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 tape = require( 'tape' );
+var objectKeys = require( '@stdlib/utils/keys' );
+var ns = require( './../lib' );
+
+
+// TESTS //
+
+tape( 'main export is an object', function test( t ) {
+	t.ok( true, __filename );
+	t.strictEqual( typeof ns, 'object', 'main export is an object' );
+	t.end();
+});
+
+tape( 'the exported object contains key-value pairs', function test( t ) {
+	var keys = objectKeys( ns );
+	t.strictEqual( keys.length > 0, true, 'has keys' );
+	t.end();
+});
