Skip to content

docs: update namespace table of contents #12521

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
Jun 4, 2026
+12 −0
Merged

docs: update namespace table of contents #12521

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 @@ -520,6 +520,7 @@ The remaining namespace utilities are as follows:
- <span class="signature">[`isStructConstructorLike( value )`][@stdlib/assert/is-struct-constructor-like]</span><span class="delimiter">: </span><span class="description">test if a value is struct constructor-like.</span>
- <span class="signature">[`isStruct( value )`][@stdlib/assert/is-struct]</span><span class="delimiter">: </span><span class="description">test if a value is a `struct` instance.</span>
- <span class="signature">[`isTruthy( value )`][@stdlib/assert/is-truthy]</span><span class="delimiter">: </span><span class="description">test if a value is truthy.</span>
- <span class="signature">[`isUint64( value )`][@stdlib/assert/is-uint64]</span><span class="delimiter">: </span><span class="description">test if a value is an unsigned 64-bit integer.</span>
- <span class="signature">[`isUNCPath( value )`][@stdlib/assert/is-unc-path]</span><span class="delimiter">: </span><span class="description">test if a value is a UNC path.</span>
- <span class="signature">[`isUndefinedOrNull( value )`][@stdlib/assert/is-undefined-or-null]</span><span class="delimiter">: </span><span class="description">test if a value is undefined or null.</span>
- <span class="signature">[`isUppercase( value )`][@stdlib/assert/is-uppercase]</span><span class="delimiter">: </span><span class="description">test if a value is an uppercase string.</span>
Expand Down Expand Up @@ -816,6 +817,8 @@ console.log( objectKeys( assert ) );

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

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

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

[@stdlib/assert/is-undefined-or-null]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-undefined-or-null
Expand Down
9 changes: 9 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ var o = ns;
- <span class="signature">[`dnansumors( N, x, strideX )`][@stdlib/blas/ext/base/dnansumors]</span><span class="delimiter">: </span><span class="description">calculate the sum of double-precision floating-point strided array elements, ignoring `NaN` values and using ordinary recursive summation.</span>
- <span class="signature">[`dnansumpw( N, x, strideX )`][@stdlib/blas/ext/base/dnansumpw]</span><span class="delimiter">: </span><span class="description">calculate the sum of double-precision floating-point strided array elements, ignoring `NaN` values and using pairwise summation.</span>
- <span class="signature">[`doneTo( N, x, strideX )`][@stdlib/blas/ext/base/done-to]</span><span class="delimiter">: </span><span class="description">fill a double-precision floating-point strided array with linearly spaced numeric elements which increment by `1` starting from one.</span>
- <span class="signature">[`dones( N, x, strideX )`][@stdlib/blas/ext/base/dones]</span><span class="delimiter">: </span><span class="description">fill a double-precision floating-point strided array with ones.</span>
- <span class="signature">[`drev( N, x, strideX )`][@stdlib/blas/ext/base/drev]</span><span class="delimiter">: </span><span class="description">reverse a double-precision floating-point strided array in-place.</span>
- <span class="signature">[`drrss( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/drrss]</span><span class="delimiter">: </span><span class="description">calculate the square root of the residual sum of squares of two double-precision floating-point strided arrays.</span>
- <span class="signature">[`drss( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/drss]</span><span class="delimiter">: </span><span class="description">calculate the residual sum of squares of two double-precision floating-point strided arrays.</span>
Expand Down Expand Up @@ -206,6 +207,7 @@ var o = ns;
- <span class="signature">[`sapxsumpw( N, alpha, x, strideX )`][@stdlib/blas/ext/base/sapxsumpw]</span><span class="delimiter">: </span><span class="description">add a scalar constant to each single-precision floating-point strided array element and compute the sum using pairwise summation.</span>
- <span class="signature">[`sasumpw( N, x, strideX )`][@stdlib/blas/ext/base/sasumpw]</span><span class="delimiter">: </span><span class="description">calculate the sum of absolute values (_L1_ norm) of single-precision floating-point strided array elements using pairwise summation.</span>
- <span class="signature">[`saxpb( N, alpha, beta, x, strideX )`][@stdlib/blas/ext/base/saxpb]</span><span class="delimiter">: </span><span class="description">multiply each element in a single-precision floating-point strided array by a scalar constant and add a scalar constant to each result.</span>
- <span class="signature">[`saxpby( N, alpha, x, strideX, beta, y, strideY )`][@stdlib/blas/ext/base/saxpby]</span><span class="delimiter">: </span><span class="description">multiply a single-precision floating-point strided array `x` by a constant and add the result to a single-precision floating-point strided array `y` multiplied by a constant.</span>
- <span class="signature">[`scartesianPower( order, N, k, x, strideX, out, LDO )`][@stdlib/blas/ext/base/scartesian-power]</span><span class="delimiter">: </span><span class="description">compute the Cartesian power for a single-precision floating-point strided array.</span>
- <span class="signature">[`scartesianSquare( order, N, x, strideX, out, LDO )`][@stdlib/blas/ext/base/scartesian-square]</span><span class="delimiter">: </span><span class="description">compute the Cartesian square for a single-precision floating-point strided array.</span>
- <span class="signature">[`scircshift( N, k, x, strideX )`][@stdlib/blas/ext/base/scircshift]</span><span class="delimiter">: </span><span class="description">circularly shift the elements of a single-precision floating-point strided array by a specified number of positions.</span>
Expand Down Expand Up @@ -237,6 +239,7 @@ var o = ns;
- <span class="signature">[`snansumors( N, x, strideX )`][@stdlib/blas/ext/base/snansumors]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision floating-point strided array elements, ignoring `NaN` values and using ordinary recursive summation.</span>
- <span class="signature">[`snansumpw( N, x, strideX )`][@stdlib/blas/ext/base/snansumpw]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision floating-point strided array elements, ignoring `NaN` values and using pairwise summation.</span>
- <span class="signature">[`soneTo( N, x, strideX )`][@stdlib/blas/ext/base/sone-to]</span><span class="delimiter">: </span><span class="description">fill a single-precision floating-point strided array with linearly spaced numeric elements which increment by `1` starting from one.</span>
- <span class="signature">[`sones( N, x, strideX )`][@stdlib/blas/ext/base/sones]</span><span class="delimiter">: </span><span class="description">fill a single-precision floating-point strided array with ones.</span>
- <span class="signature">[`srev( N, x, strideX )`][@stdlib/blas/ext/base/srev]</span><span class="delimiter">: </span><span class="description">reverse a single-precision floating-point strided array in-place.</span>
- <span class="signature">[`ssort( N, order, x, strideX )`][@stdlib/blas/ext/base/ssort]</span><span class="delimiter">: </span><span class="description">sort a single-precision floating-point strided array.</span>
- <span class="signature">[`ssort2hp( N, order, x, strideX, y, strideY )`][@stdlib/blas/ext/base/ssort2hp]</span><span class="delimiter">: </span><span class="description">simultaneously sort two single-precision floating-point strided arrays based on the sort order of the first array using heapsort.</span>
Expand Down Expand Up @@ -437,6 +440,8 @@ console.log( objectKeys( ns ) );

[@stdlib/blas/ext/base/done-to]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/done-to

[@stdlib/blas/ext/base/dones]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dones

[@stdlib/blas/ext/base/drev]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/drev

[@stdlib/blas/ext/base/drrss]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/drrss
Expand Down Expand Up @@ -649,6 +654,8 @@ console.log( objectKeys( ns ) );

[@stdlib/blas/ext/base/saxpb]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/saxpb

[@stdlib/blas/ext/base/saxpby]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/saxpby

[@stdlib/blas/ext/base/scartesian-power]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/scartesian-power

[@stdlib/blas/ext/base/scartesian-square]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/scartesian-square
Expand Down Expand Up @@ -711,6 +718,8 @@ console.log( objectKeys( ns ) );

[@stdlib/blas/ext/base/sone-to]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/sone-to

[@stdlib/blas/ext/base/sones]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/sones

[@stdlib/blas/ext/base/srev]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/srev

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