Skip to content

docs: update namespace table of contents #14682

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kgryte merged 1 commit into from
Aug 27, 2026
Merged

docs: update namespace table of contents #14682

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/assert/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,6 +271,7 @@ The namespace includes utilities for validating other special arrays or buffers:
- <span class="signature">[`isFalsyArray( value )`][@stdlib/assert/is-falsy-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array-like object containing only falsy values.</span>
- <span class="signature">[`isFiniteArray( value )`][@stdlib/assert/is-finite-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array-like object containing only finite numbers.</span>
- <span class="signature">[`isFloat16Array( value )`][@stdlib/assert/is-float16array]</span><span class="delimiter">: </span><span class="description">test if a value is a Float16Array.</span>
- <span class="signature">[`isInt64Array( value )`][@stdlib/assert/is-int64array]</span><span class="delimiter">: </span><span class="description">test if a value is an Int64Array.</span>
- <span class="signature">[`isNumericArray( value )`][@stdlib/assert/is-numeric-array]</span><span class="delimiter">: </span><span class="description">test if a value is a numeric array.</span>
- <span class="signature">[`isPlainObjectArray( value )`][@stdlib/assert/is-plain-object-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array-like object containing only plain objects.</span>
- <span class="signature">[`isProbabilityArray( value )`][@stdlib/assert/is-probability-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array-like object containing only probabilities.</span>
Expand Down Expand Up @@ -1046,6 +1047,8 @@ console.log( objectKeys( assert ) );

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

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

[@stdlib/assert/is-numeric-array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-numeric-array

[@stdlib/assert/is-plain-object-array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-plain-object-array
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/blas/ext/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ The namespace contains the following:
- <span class="signature">[`copyWithin( x, target, start[, end][, options] )`][@stdlib/blas/ext/copy-within]</span><span class="delimiter">: </span><span class="description">perform an in-place copy of elements within an ndarray along an ndarray dimension.</span>
- <span class="signature">[`cusum( x[, initial][, options] )`][@stdlib/blas/ext/cusum]</span><span class="delimiter">: </span><span class="description">compute the cumulative sum along one or more ndarray dimensions.</span>
- <span class="signature">[`findIndex( x[, fromIndex][, options], clbk[, thisArg] )`][@stdlib/blas/ext/find-index]</span><span class="delimiter">: </span><span class="description">return the index of the first element along an ndarray dimension which passes a test implemented by a predicate function.</span>
- <span class="signature">[`findLastIndex( x[, options], clbk[, thisArg] )`][@stdlib/blas/ext/find-last-index]</span><span class="delimiter">: </span><span class="description">return the index of the last element along an ndarray dimension which passes a test implemented by a predicate function.</span>
- <span class="signature">[`findLastIndex( x[, fromIndex][, options], clbk[, thisArg] )`][@stdlib/blas/ext/find-last-index]</span><span class="delimiter">: </span><span class="description">return the index of the last element along an ndarray dimension which passes a test implemented by a predicate function.</span>
- <span class="signature">[`indexOf( x, searchElement[, fromIndex][, options] )`][@stdlib/blas/ext/index-of]</span><span class="delimiter">: </span><span class="description">return the first index of a specified search element along an ndarray dimension.</span>
- <span class="signature">[`join( x[, options] )`][@stdlib/blas/ext/join]</span><span class="delimiter">: </span><span class="description">return an ndarray created by joining elements using a separator along one or more ndarray dimensions.</span>
- <span class="signature">[`lastIndexOf( x, searchElement[, fromIndex][, options] )`][@stdlib/blas/ext/last-index-of]</span><span class="delimiter">: </span><span class="description">return the last index of a specified search element along an ndarray dimension.</span>
Expand Down
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/strided/base/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ The following functions are currently exported:
- <span class="signature">[`reinterpretComplex128( x, offset )`][@stdlib/strided/base/reinterpret-complex128]</span><span class="delimiter">: </span><span class="description">reinterpret a `Complex128Array` as a `Float64Array`.</span>
- <span class="signature">[`reinterpretComplex64( x, offset )`][@stdlib/strided/base/reinterpret-complex64]</span><span class="delimiter">: </span><span class="description">reinterpret a `Complex64Array` as a `Float32Array`.</span>
- <span class="signature">[`reinterpretFloat16( x, offset )`][@stdlib/strided/base/reinterpret-float16]</span><span class="delimiter">: </span><span class="description">reinterpret a `Float16Array` as a `Uint16Array`.</span>
- <span class="signature">[`reinterpretUint64( x, offset )`][@stdlib/strided/base/reinterpret-uint64]</span><span class="delimiter">: </span><span class="description">reinterpret a `Uint64Array` as a `Uint32Array`.</span>
- <span class="signature">[`smap( N, x, strideX, y, strideY, fcn )`][@stdlib/strided/base/smap]</span><span class="delimiter">: </span><span class="description">apply a unary function to a single-precision floating-point strided input array and assign results to a single-precision floating-point strided output array.</span>
- <span class="signature">[`smap2( N, x, strideX, y, strideY, z, strideZ, fcn )`][@stdlib/strided/base/smap2]</span><span class="delimiter">: </span><span class="description">apply a binary function to single-precision floating-point strided input arrays and assign results to a single-precision floating-point strided output array.</span>
- <span class="signature">[`smskmap( N, x, strideX, mask, strideMask, y, strideY, fcn )`][@stdlib/strided/base/smskmap]</span><span class="delimiter">: </span><span class="description">apply a unary function to a single-precision floating-point strided input array according to a strided mask array and assign results to a single-precision floating-point strided output array.</span>
Expand Down Expand Up @@ -200,6 +201,8 @@ console.log( objectKeys( ns ) );

[@stdlib/strided/base/reinterpret-float16]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/reinterpret-float16

[@stdlib/strided/base/reinterpret-uint64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/reinterpret-uint64

[@stdlib/strided/base/smap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/smap

[@stdlib/strided/base/smap2]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/smap2
Expand Down