From 6b6e7032c5adc287cdf95a9168648ad38046a43e Mon Sep 17 00:00:00 2001 From: Planeshifter <1913638+Planeshifter@users.noreply.github.com> Date: Thu, 18 Dec 2025 02:52:21 +0000 Subject: [PATCH] docs: update namespace table of contents Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> --- lib/node_modules/@stdlib/array/base/assert/README.md | 3 +++ lib/node_modules/@stdlib/assert/README.md | 6 ++++++ lib/node_modules/@stdlib/complex/base/README.md | 3 +++ lib/node_modules/@stdlib/complex/base/assert/README.md | 3 +++ .../@stdlib/complex/float32/base/assert/README.md | 3 +++ .../@stdlib/complex/float64/base/assert/README.md | 3 +++ .../@stdlib/number/float32/base/assert/README.md | 3 +++ .../@stdlib/number/float64/base/assert/README.md | 3 +++ 8 files changed, 27 insertions(+) diff --git a/lib/node_modules/@stdlib/array/base/assert/README.md b/lib/node_modules/@stdlib/array/base/assert/README.md index db05bc7530a3..4fedf5dda981 100644 --- a/lib/node_modules/@stdlib/array/base/assert/README.md +++ b/lib/node_modules/@stdlib/array/base/assert/README.md @@ -47,6 +47,7 @@ The namespace exports the following: - [`contains( x, value )`][@stdlib/array/base/assert/contains]: test if an array contains a provided search value. - [`hasAlmostEqualValues( x, y, maxULP )`][@stdlib/array/base/assert/has-almost-equal-values]: test if two arrays have respective elements which are approximately equal within a specified number of ULPs (units in the last place). +- [`hasAlmostSameValues( x, y, maxULP )`][@stdlib/array/base/assert/has-almost-same-values]: test if two arrays have respective elements which are approximately the same value within a specified number of ULPs (units in the last place). - [`hasEqualValuesIndexed( x, y )`][@stdlib/array/base/assert/has-equal-values-indexed]: test if two indexed arrays have equal values. - [`hasEqualValues( x, y )`][@stdlib/array/base/assert/has-equal-values]: test if two arrays have equal values. - [`hasSameValues( x, y )`][@stdlib/array/base/assert/has-same-values]: test if two arrays have the same values. @@ -180,6 +181,8 @@ console.log( 'arr4 is complex typed array: ' + ns.isComplexTypedArray( arr4 ) ); [@stdlib/array/base/assert/has-almost-equal-values]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/assert/has-almost-equal-values +[@stdlib/array/base/assert/has-almost-same-values]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/assert/has-almost-same-values + [@stdlib/array/base/assert/has-equal-values-indexed]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/assert/has-equal-values-indexed [@stdlib/array/base/assert/has-equal-values]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/assert/has-equal-values diff --git a/lib/node_modules/@stdlib/assert/README.md b/lib/node_modules/@stdlib/assert/README.md index 486455e19be1..921cbffa1207 100644 --- a/lib/node_modules/@stdlib/assert/README.md +++ b/lib/node_modules/@stdlib/assert/README.md @@ -370,6 +370,7 @@ To test whether a runtime environment supports certain features, the namespace i - [`hasSearchSymbolSupport()`][@stdlib/assert/has-search-symbol-support]: detect native `Symbol.search` support. - [`hasSetSupport()`][@stdlib/assert/has-set-support]: detect native `Set` support. - [`hasSharedArrayBufferSupport()`][@stdlib/assert/has-sharedarraybuffer-support]: detect native `SharedArrayBuffer` support. +- [`hasSplitSymbolSupport()`][@stdlib/assert/has-split-symbol-support]: detect native `Symbol.split` support. - [`hasSymbolSupport()`][@stdlib/assert/has-symbol-support]: detect native `Symbol` support. - [`hasToPrimitiveSymbolSupport()`][@stdlib/assert/has-to-primitive-symbol-support]: detect native `Symbol.toPrimitive` support. - [`hasToStringTagSupport()`][@stdlib/assert/has-tostringtag-support]: detect native `Symbol.toStringTag` support. @@ -405,6 +406,7 @@ The remaining namespace utilities are as follows: - [`isAccessorPropertyIn( value, property )`][@stdlib/assert/is-accessor-property-in]: test if an object's own or inherited property has an accessor descriptor. - [`isAccessorProperty( value, property )`][@stdlib/assert/is-accessor-property]: test if an object's own property has an accessor descriptor. - [`isAlmostEqual( a, b, maxULP )`][@stdlib/assert/is-almost-equal]: test if two arguments are approximately equal within a specified number of ULPs (units in the last place). +- [`isAlmostSameValue( a, b, maxULP )`][@stdlib/assert/is-almost-same-value]: test if two arguments are approximately the same value within a specified number of ULPs (units in the last place). - [`isAlphagram( value )`][@stdlib/assert/is-alphagram]: test if a value is an alphagram. - [`isAlphaNumeric( value )`][@stdlib/assert/is-alphanumeric]: test whether a string contains only alphanumeric characters. - [`isAnagram( str, value )`][@stdlib/assert/is-anagram]: test if a value is an anagram. @@ -594,6 +596,8 @@ console.log( objectKeys( assert ) ); [@stdlib/assert/is-almost-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-almost-equal +[@stdlib/assert/is-almost-same-value]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-almost-same-value + [@stdlib/assert/is-alphagram]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-alphagram [@stdlib/assert/is-alphanumeric]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-alphanumeric @@ -896,6 +900,8 @@ console.log( objectKeys( assert ) ); [@stdlib/assert/has-sharedarraybuffer-support]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/has-sharedarraybuffer-support +[@stdlib/assert/has-split-symbol-support]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/has-split-symbol-support + [@stdlib/assert/has-symbol-support]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/has-symbol-support [@stdlib/assert/has-to-primitive-symbol-support]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/has-to-primitive-symbol-support diff --git a/lib/node_modules/@stdlib/complex/base/README.md b/lib/node_modules/@stdlib/complex/base/README.md index bd766aa9515c..df247b890ee7 100644 --- a/lib/node_modules/@stdlib/complex/base/README.md +++ b/lib/node_modules/@stdlib/complex/base/README.md @@ -45,6 +45,7 @@ The namespace contains the following functions:
+- [`assert`][@stdlib/complex/base/assert]: base (i.e., lower-level) complex number assertion functions. - [`cast( fcn, nargs, ctor )`][@stdlib/complex/base/cast-return]: wrap a function and cast a function's return value to a complex number. - [`parse( str )`][@stdlib/complex/base/parse]: parses a string representing a complex number into a complex like object `{re: number, im: number}`. - [`wrap( fcn, nargs, ctor )`][@stdlib/complex/base/wrap-function]: wrap a function accepting complex number arguments to support providing both real and complex numbers. @@ -98,6 +99,8 @@ console.log( objectKeys( ns ) ); +[@stdlib/complex/base/assert]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/base/assert + [@stdlib/complex/base/cast-return]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/base/cast-return [@stdlib/complex/base/parse]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/base/parse diff --git a/lib/node_modules/@stdlib/complex/base/assert/README.md b/lib/node_modules/@stdlib/complex/base/assert/README.md index db953d7f9e99..6340edf754c1 100644 --- a/lib/node_modules/@stdlib/complex/base/assert/README.md +++ b/lib/node_modules/@stdlib/complex/base/assert/README.md @@ -46,6 +46,7 @@ The namespace contains the following functions:
- [`isAlmostEqual( z1, z2, maxULP )`][@stdlib/complex/base/assert/is-almost-equal]: test whether two complex numbers are approximately equal within a specified number of ULPs (units in the last place). +- [`isAlmostSameValue( z1, z2, maxULP )`][@stdlib/complex/base/assert/is-almost-same-value]: test whether two complex numbers are approximately the same value within a specified number of ULPs (units in the last place).
@@ -98,6 +99,8 @@ console.log( objectKeys( ns ) ); [@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 +[@stdlib/complex/base/assert/is-almost-same-value]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/base/assert/is-almost-same-value + diff --git a/lib/node_modules/@stdlib/complex/float32/base/assert/README.md b/lib/node_modules/@stdlib/complex/float32/base/assert/README.md index dd6185ac6cc7..a1e5040314ff 100644 --- a/lib/node_modules/@stdlib/complex/float32/base/assert/README.md +++ b/lib/node_modules/@stdlib/complex/float32/base/assert/README.md @@ -46,6 +46,7 @@ The namespace contains the following functions:
- [`isAlmostEqual( z1, z2, maxULP )`][@stdlib/complex/float32/base/assert/is-almost-equal]: test whether two single-precision complex floating-point numbers are approximately equal within a specified number of ULPs (units in the last place). +- [`isAlmostSameValue( z1, z2, maxULP )`][@stdlib/complex/float32/base/assert/is-almost-same-value]: 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). - [`isEqual( z1, z2 )`][@stdlib/complex/float32/base/assert/is-equal]: test whether two single-precision complex floating-point numbers are equal. - [`isNotEqual( z1, z2 )`][@stdlib/complex/float32/base/assert/is-not-equal]: test whether two single-precision complex floating-point numbers are not equal. - [`isSameValueZero( z1, z2 )`][@stdlib/complex/float32/base/assert/is-same-value-zero]: test whether two single-precision complex floating-point numbers are the same value. @@ -102,6 +103,8 @@ console.log( objectKeys( ns ) ); [@stdlib/complex/float32/base/assert/is-almost-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/base/assert/is-almost-equal +[@stdlib/complex/float32/base/assert/is-almost-same-value]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/base/assert/is-almost-same-value + [@stdlib/complex/float32/base/assert/is-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/base/assert/is-equal [@stdlib/complex/float32/base/assert/is-not-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/base/assert/is-not-equal diff --git a/lib/node_modules/@stdlib/complex/float64/base/assert/README.md b/lib/node_modules/@stdlib/complex/float64/base/assert/README.md index 53b15ad74c06..b221a80a7268 100644 --- a/lib/node_modules/@stdlib/complex/float64/base/assert/README.md +++ b/lib/node_modules/@stdlib/complex/float64/base/assert/README.md @@ -46,6 +46,7 @@ The namespace contains the following functions:
- [`isAlmostEqual( z1, z2, maxULP )`][@stdlib/complex/float64/base/assert/is-almost-equal]: test whether two double-precision complex floating-point numbers are approximately equal within a specified number of ULPs (units in the last place). +- [`isAlmostSameValue( z1, z2, maxULP )`][@stdlib/complex/float64/base/assert/is-almost-same-value]: test whether two double-precision complex floating-point numbers are approximately the same value within a specified number of ULPs (units in the last place). - [`isEqual( z1, z2 )`][@stdlib/complex/float64/base/assert/is-equal]: test whether two double-precision complex floating-point numbers are equal. - [`isNotEqual( z1, z2 )`][@stdlib/complex/float64/base/assert/is-not-equal]: test whether two double-precision complex floating-point numbers are not equal. - [`isSameValueZero( z1, z2 )`][@stdlib/complex/float64/base/assert/is-same-value-zero]: test whether two double-precision complex floating-point numbers are the same value. @@ -102,6 +103,8 @@ console.log( objectKeys( ns ) ); [@stdlib/complex/float64/base/assert/is-almost-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/base/assert/is-almost-equal +[@stdlib/complex/float64/base/assert/is-almost-same-value]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/base/assert/is-almost-same-value + [@stdlib/complex/float64/base/assert/is-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/base/assert/is-equal [@stdlib/complex/float64/base/assert/is-not-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/base/assert/is-not-equal diff --git a/lib/node_modules/@stdlib/number/float32/base/assert/README.md b/lib/node_modules/@stdlib/number/float32/base/assert/README.md index 2ea60fb15353..e74aa0a30c9f 100644 --- a/lib/node_modules/@stdlib/number/float32/base/assert/README.md +++ b/lib/node_modules/@stdlib/number/float32/base/assert/README.md @@ -46,6 +46,7 @@ The namespace contains the following functions:
- [`isAlmostEqual( a, b, maxULP )`][@stdlib/number/float32/base/assert/is-almost-equal]: test if two single-precision floating-point numbers are approximately equal within a specified number of ULPs (units in the last place). +- [`isAlmostSameValue( a, b, maxULP )`][@stdlib/number/float32/base/assert/is-almost-same-value]: test if two single-precision floating-point numbers are approximately the same value within a specified number of ULPs (units in the last place). - [`isSameValueZero( a, b )`][@stdlib/number/float32/base/assert/is-same-value-zero]: test if two single-precision floating-point numbers are the same value. - [`isSameValue( a, b )`][@stdlib/number/float32/base/assert/is-same-value]: test if two single-precision floating-point numbers are the same value. @@ -100,6 +101,8 @@ console.log( objectKeys( ns ) ); [@stdlib/number/float32/base/assert/is-almost-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/float32/base/assert/is-almost-equal +[@stdlib/number/float32/base/assert/is-almost-same-value]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/float32/base/assert/is-almost-same-value + [@stdlib/number/float32/base/assert/is-same-value-zero]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/float32/base/assert/is-same-value-zero [@stdlib/number/float32/base/assert/is-same-value]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/float32/base/assert/is-same-value diff --git a/lib/node_modules/@stdlib/number/float64/base/assert/README.md b/lib/node_modules/@stdlib/number/float64/base/assert/README.md index 737ff457540f..f3cf06535652 100644 --- a/lib/node_modules/@stdlib/number/float64/base/assert/README.md +++ b/lib/node_modules/@stdlib/number/float64/base/assert/README.md @@ -46,6 +46,7 @@ The namespace contains the following functions:
- [`isAlmostEqual( a, b, maxULP )`][@stdlib/number/float64/base/assert/is-almost-equal]: test if two double-precision floating-point numbers are approximately equal within a specified number of ULPs (units in the last place). +- [`isAlmostSameValue( a, b, maxULP )`][@stdlib/number/float64/base/assert/is-almost-same-value]: test if two double-precision floating-point numbers are approximately the same value within a specified number of ULPs (units in the last place). - [`isSameValueZero( a, b )`][@stdlib/number/float64/base/assert/is-same-value-zero]: test if two double-precision floating-point numbers are the same value. - [`isSameValue( a, b )`][@stdlib/number/float64/base/assert/is-same-value]: test if two double-precision floating-point numbers are the same value. @@ -100,6 +101,8 @@ console.log( objectKeys( ns ) ); [@stdlib/number/float64/base/assert/is-almost-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/float64/base/assert/is-almost-equal +[@stdlib/number/float64/base/assert/is-almost-same-value]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/float64/base/assert/is-almost-same-value + [@stdlib/number/float64/base/assert/is-same-value-zero]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/float64/base/assert/is-same-value-zero [@stdlib/number/float64/base/assert/is-same-value]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/float64/base/assert/is-same-value