feat: update complex/float64/base/assert TypeScript declarations

Planeshifter · Planeshifter · commit 0bc68ba07643 · 2025-09-21T12:33:48.000-05: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: na
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: na
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - 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: na
  - task: lint_license_headers
    status: passed
---
diff --git a/lib/node_modules/@stdlib/complex/float64/base/assert/docs/types/index.d.ts b/lib/node_modules/@stdlib/complex/float64/base/assert/docs/types/index.d.ts
@@ -20,6 +20,7 @@
 
 /* eslint-disable max-lines */
 
+import isAlmostEqual = require( '@stdlib/complex/float64/base/assert/is-almost-equal' );
 import isEqual = require( '@stdlib/complex/float64/base/assert/is-equal' );
 import isNotEqual = require( '@stdlib/complex/float64/base/assert/is-not-equal' );
 import isSameValue = require( '@stdlib/complex/float64/base/assert/is-same-value' );
@@ -29,6 +30,34 @@ import isSameValueZero = require( '@stdlib/complex/float64/base/assert/is-same-v
 * Interface describing the `assert` namespace.
 */
 interface Namespace {
+	/**
+	* Tests whether two double-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 double-precision complex floating-point numbers are approximately equal within a specified number of ULPs
+	*
+	* @example
+	* var EPS = require( '@stdlib/constants/float64/eps' );
+	* var Complex128 = require( '@stdlib/complex/float64/ctor' );
+	*
+	* var z1 = new Complex128( 1.0, 3.0 );
+	* var z2 = new Complex128( 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 double-precision complex floating-point numbers are equal.
 	*
