Skip to content

Commit de9dec4

Browse files
authored
docs: update namespace table of contents
PR-URL: #9205 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent ca51243 commit de9dec4

File tree

8 files changed

+27
-0
lines changed

8 files changed

+27
-0
lines changed

lib/node_modules/@stdlib/array/base/assert/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ The namespace exports the following:
4747

4848
- <span class="signature">[`contains( x, value )`][@stdlib/array/base/assert/contains]</span><span class="delimiter">: </span><span class="description">test if an array contains a provided search value.</span>
4949
- <span class="signature">[`hasAlmostEqualValues( x, y, maxULP )`][@stdlib/array/base/assert/has-almost-equal-values]</span><span class="delimiter">: </span><span class="description">test if two arrays have respective elements which are approximately equal within a specified number of ULPs (units in the last place).</span>
50+
- <span class="signature">[`hasAlmostSameValues( x, y, maxULP )`][@stdlib/array/base/assert/has-almost-same-values]</span><span class="delimiter">: </span><span class="description">test if two arrays have respective elements which are approximately the same value within a specified number of ULPs (units in the last place).</span>
5051
- <span class="signature">[`hasEqualValuesIndexed( x, y )`][@stdlib/array/base/assert/has-equal-values-indexed]</span><span class="delimiter">: </span><span class="description">test if two indexed arrays have equal values.</span>
5152
- <span class="signature">[`hasEqualValues( x, y )`][@stdlib/array/base/assert/has-equal-values]</span><span class="delimiter">: </span><span class="description">test if two arrays have equal values.</span>
5253
- <span class="signature">[`hasSameValues( x, y )`][@stdlib/array/base/assert/has-same-values]</span><span class="delimiter">: </span><span class="description">test if two arrays have the same values.</span>
@@ -180,6 +181,8 @@ console.log( 'arr4 is complex typed array: ' + ns.isComplexTypedArray( arr4 ) );
180181

181182
[@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
182183

184+
[@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
185+
183186
[@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
184187

185188
[@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

lib/node_modules/@stdlib/assert/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -370,6 +370,7 @@ To test whether a runtime environment supports certain features, the namespace i
370370
- <span class="signature">[`hasSearchSymbolSupport()`][@stdlib/assert/has-search-symbol-support]</span><span class="delimiter">: </span><span class="description">detect native `Symbol.search` support.</span>
371371
- <span class="signature">[`hasSetSupport()`][@stdlib/assert/has-set-support]</span><span class="delimiter">: </span><span class="description">detect native `Set` support.</span>
372372
- <span class="signature">[`hasSharedArrayBufferSupport()`][@stdlib/assert/has-sharedarraybuffer-support]</span><span class="delimiter">: </span><span class="description">detect native `SharedArrayBuffer` support.</span>
373+
- <span class="signature">[`hasSplitSymbolSupport()`][@stdlib/assert/has-split-symbol-support]</span><span class="delimiter">: </span><span class="description">detect native `Symbol.split` support.</span>
373374
- <span class="signature">[`hasSymbolSupport()`][@stdlib/assert/has-symbol-support]</span><span class="delimiter">: </span><span class="description">detect native `Symbol` support.</span>
374375
- <span class="signature">[`hasToPrimitiveSymbolSupport()`][@stdlib/assert/has-to-primitive-symbol-support]</span><span class="delimiter">: </span><span class="description">detect native `Symbol.toPrimitive` support.</span>
375376
- <span class="signature">[`hasToStringTagSupport()`][@stdlib/assert/has-tostringtag-support]</span><span class="delimiter">: </span><span class="description">detect native `Symbol.toStringTag` support.</span>
@@ -405,6 +406,7 @@ The remaining namespace utilities are as follows:
405406
- <span class="signature">[`isAccessorPropertyIn( value, property )`][@stdlib/assert/is-accessor-property-in]</span><span class="delimiter">: </span><span class="description">test if an object's own or inherited property has an accessor descriptor.</span>
406407
- <span class="signature">[`isAccessorProperty( value, property )`][@stdlib/assert/is-accessor-property]</span><span class="delimiter">: </span><span class="description">test if an object's own property has an accessor descriptor.</span>
407408
- <span class="signature">[`isAlmostEqual( a, b, maxULP )`][@stdlib/assert/is-almost-equal]</span><span class="delimiter">: </span><span class="description">test if two arguments are approximately equal within a specified number of ULPs (units in the last place).</span>
409+
- <span class="signature">[`isAlmostSameValue( a, b, maxULP )`][@stdlib/assert/is-almost-same-value]</span><span class="delimiter">: </span><span class="description">test if two arguments are approximately the same value within a specified number of ULPs (units in the last place).</span>
408410
- <span class="signature">[`isAlphagram( value )`][@stdlib/assert/is-alphagram]</span><span class="delimiter">: </span><span class="description">test if a value is an alphagram.</span>
409411
- <span class="signature">[`isAlphaNumeric( value )`][@stdlib/assert/is-alphanumeric]</span><span class="delimiter">: </span><span class="description">test whether a string contains only alphanumeric characters.</span>
410412
- <span class="signature">[`isAnagram( str, value )`][@stdlib/assert/is-anagram]</span><span class="delimiter">: </span><span class="description">test if a value is an anagram.</span>
@@ -594,6 +596,8 @@ console.log( objectKeys( assert ) );
594596

595597
[@stdlib/assert/is-almost-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-almost-equal
596598

599+
[@stdlib/assert/is-almost-same-value]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-almost-same-value
600+
597601
[@stdlib/assert/is-alphagram]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-alphagram
598602

599603
[@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 ) );
896900

897901
[@stdlib/assert/has-sharedarraybuffer-support]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/has-sharedarraybuffer-support
898902

903+
[@stdlib/assert/has-split-symbol-support]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/has-split-symbol-support
904+
899905
[@stdlib/assert/has-symbol-support]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/has-symbol-support
900906

901907
[@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

lib/node_modules/@stdlib/complex/base/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ The namespace contains the following functions:
4545

4646
<div class="namespace-toc">
4747

48+
- <span class="signature">[`assert`][@stdlib/complex/base/assert]</span><span class="delimiter">: </span><span class="description">base (i.e., lower-level) complex number assertion functions.</span>
4849
- <span class="signature">[`cast( fcn, nargs, ctor )`][@stdlib/complex/base/cast-return]</span><span class="delimiter">: </span><span class="description">wrap a function and cast a function's return value to a complex number.</span>
4950
- <span class="signature">[`parse( str )`][@stdlib/complex/base/parse]</span><span class="delimiter">: </span><span class="description">parses a string representing a complex number into a complex like object `{re: number, im: number}`.</span>
5051
- <span class="signature">[`wrap( fcn, nargs, ctor )`][@stdlib/complex/base/wrap-function]</span><span class="delimiter">: </span><span class="description">wrap a function accepting complex number arguments to support providing both real and complex numbers.</span>
@@ -98,6 +99,8 @@ console.log( objectKeys( ns ) );
9899

99100
<!-- <toc-links> -->
100101

102+
[@stdlib/complex/base/assert]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/base/assert
103+
101104
[@stdlib/complex/base/cast-return]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/base/cast-return
102105

103106
[@stdlib/complex/base/parse]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/base/parse

lib/node_modules/@stdlib/complex/base/assert/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ The namespace contains the following functions:
4646
<div class="namespace-toc">
4747

4848
- <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>
49+
- <span class="signature">[`isAlmostSameValue( z1, z2, maxULP )`][@stdlib/complex/base/assert/is-almost-same-value]</span><span class="delimiter">: </span><span class="description">test whether two complex numbers are approximately the same value within a specified number of ULPs (units in the last place).</span>
4950

5051
</div>
5152

@@ -98,6 +99,8 @@ console.log( objectKeys( ns ) );
9899

99100
[@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
100101

102+
[@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
103+
101104
<!-- </toc-links> -->
102105

103106
</section>

lib/node_modules/@stdlib/complex/float32/base/assert/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ The namespace contains the following functions:
4646
<div class="namespace-toc">
4747

4848
- <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>
49+
- <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>
4950
- <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>
5051
- <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>
5152
- <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>
@@ -102,6 +103,8 @@ console.log( objectKeys( ns ) );
102103

103104
[@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
104105

106+
[@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
107+
105108
[@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
106109

107110
[@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

lib/node_modules/@stdlib/complex/float64/base/assert/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ The namespace contains the following functions:
4646
<div class="namespace-toc">
4747

4848
- <span class="signature">[`isAlmostEqual( z1, z2, maxULP )`][@stdlib/complex/float64/base/assert/is-almost-equal]</span><span class="delimiter">: </span><span class="description">test whether two double-precision complex floating-point numbers are approximately equal within a specified number of ULPs (units in the last place).</span>
49+
- <span class="signature">[`isAlmostSameValue( z1, z2, maxULP )`][@stdlib/complex/float64/base/assert/is-almost-same-value]</span><span class="delimiter">: </span><span class="description">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).</span>
4950
- <span class="signature">[`isEqual( z1, z2 )`][@stdlib/complex/float64/base/assert/is-equal]</span><span class="delimiter">: </span><span class="description">test whether two double-precision complex floating-point numbers are equal.</span>
5051
- <span class="signature">[`isNotEqual( z1, z2 )`][@stdlib/complex/float64/base/assert/is-not-equal]</span><span class="delimiter">: </span><span class="description">test whether two double-precision complex floating-point numbers are not equal.</span>
5152
- <span class="signature">[`isSameValueZero( z1, z2 )`][@stdlib/complex/float64/base/assert/is-same-value-zero]</span><span class="delimiter">: </span><span class="description">test whether two double-precision complex floating-point numbers are the same value.</span>
@@ -102,6 +103,8 @@ console.log( objectKeys( ns ) );
102103

103104
[@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
104105

106+
[@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
107+
105108
[@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
106109

107110
[@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

lib/node_modules/@stdlib/number/float32/base/assert/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ The namespace contains the following functions:
4646
<div class="namespace-toc">
4747

4848
- <span class="signature">[`isAlmostEqual( a, b, maxULP )`][@stdlib/number/float32/base/assert/is-almost-equal]</span><span class="delimiter">: </span><span class="description">test if two single-precision floating-point numbers are approximately equal within a specified number of ULPs (units in the last place).</span>
49+
- <span class="signature">[`isAlmostSameValue( a, b, maxULP )`][@stdlib/number/float32/base/assert/is-almost-same-value]</span><span class="delimiter">: </span><span class="description">test if two single-precision floating-point numbers are approximately the same value within a specified number of ULPs (units in the last place).</span>
4950
- <span class="signature">[`isSameValueZero( 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>
5051
- <span class="signature">[`isSameValue( 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>
5152

@@ -100,6 +101,8 @@ console.log( objectKeys( ns ) );
100101

101102
[@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
102103

104+
[@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
105+
103106
[@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
104107

105108
[@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

lib/node_modules/@stdlib/number/float64/base/assert/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ The namespace contains the following functions:
4646
<div class="namespace-toc">
4747

4848
- <span class="signature">[`isAlmostEqual( a, b, maxULP )`][@stdlib/number/float64/base/assert/is-almost-equal]</span><span class="delimiter">: </span><span class="description">test if two double-precision floating-point numbers are approximately equal within a specified number of ULPs (units in the last place).</span>
49+
- <span class="signature">[`isAlmostSameValue( a, b, maxULP )`][@stdlib/number/float64/base/assert/is-almost-same-value]</span><span class="delimiter">: </span><span class="description">test if two double-precision floating-point numbers are approximately the same value within a specified number of ULPs (units in the last place).</span>
4950
- <span class="signature">[`isSameValueZero( a, b )`][@stdlib/number/float64/base/assert/is-same-value-zero]</span><span class="delimiter">: </span><span class="description">test if two double-precision floating-point numbers are the same value.</span>
5051
- <span class="signature">[`isSameValue( a, b )`][@stdlib/number/float64/base/assert/is-same-value]</span><span class="delimiter">: </span><span class="description">test if two double-precision floating-point numbers are the same value.</span>
5152

@@ -100,6 +101,8 @@ console.log( objectKeys( ns ) );
100101

101102
[@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
102103

104+
[@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
105+
103106
[@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
104107

105108
[@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

0 commit comments

Comments
 (0)