Skip to content

docs: update namespace table of contents #13161

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
Planeshifter merged 1 commit into from
Jun 27, 2026
+24 −0
Merged

docs: update namespace table of contents #13161

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
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 @@ -149,6 +149,7 @@ var o = ns;
- <span class="signature">[`dwapx( N, alpha, x, strideX, w, strideW )`][@stdlib/blas/ext/base/dwapx]</span><span class="delimiter">: </span><span class="description">add a scalar constant to each element in a double-precision floating-point strided array `x` and assign the results to elements in a double-precision floating-point strided array `w`.</span>
- <span class="signature">[`dwhere( N, condition, strideC, x, strideX, y, strideY, out, strideOut )`][@stdlib/blas/ext/base/dwhere]</span><span class="delimiter">: </span><span class="description">take elements from one of two double-precision floating-point strided arrays depending on a condition.</span>
- <span class="signature">[`dwxsa( N, alpha, x, strideX, w, strideW )`][@stdlib/blas/ext/base/dwxsa]</span><span class="delimiter">: </span><span class="description">subtract a scalar constant from each element in a double-precision floating-point strided array `x` and assign the results to elements in a double-precision floating-point strided array `w`.</span>
- <span class="signature">[`dxmy( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/dxmy]</span><span class="delimiter">: </span><span class="description">multiply elements of a double-precision floating-point strided array `x` by the corresponding elements of a double-precision floating-point strided array `y` and assign the results to `y`.</span>
- <span class="signature">[`dxpy( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/dxpy]</span><span class="delimiter">: </span><span class="description">add elements of a double-precision floating-point strided array `x` to the corresponding elements of a double-precision floating-point strided array `y` and assign the results to `y`.</span>
- <span class="signature">[`dxsa( N, alpha, x, strideX )`][@stdlib/blas/ext/base/dxsa]</span><span class="delimiter">: </span><span class="description">subtract a scalar constant from each element in a double-precision floating-point strided array.</span>
- <span class="signature">[`dxsy( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/dxsy]</span><span class="delimiter">: </span><span class="description">subtract elements of a double-precision floating-point strided array `y` from the corresponding elements of a double-precision floating-point strided array `x` and assign the results to `y`.</span>
Expand Down Expand Up @@ -192,6 +193,7 @@ var o = ns;
- <span class="signature">[`gindexOf( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/gindex-of]</span><span class="delimiter">: </span><span class="description">return the first index of a specified search element in a strided array.</span>
- <span class="signature">[`gjoinBetween( N, prefix, suffix, x, strideX, separators, strideS )`][@stdlib/blas/ext/base/gjoin-between]</span><span class="delimiter">: </span><span class="description">return a string by joining strided array elements using a specified separator for each pair of consecutive elements.</span>
- <span class="signature">[`gjoin( N, separator, x, strideX )`][@stdlib/blas/ext/base/gjoin]</span><span class="delimiter">: </span><span class="description">return a string created by joining strided array elements using a specified separator.</span>
- <span class="signature">[`glastIndexOfFalsy( N, x, strideX )`][@stdlib/blas/ext/base/glast-index-of-falsy]</span><span class="delimiter">: </span><span class="description">return the index of the last falsy element in a strided array.</span>
- <span class="signature">[`glastIndexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/glast-index-of-row]</span><span class="delimiter">: </span><span class="description">return the index of the last row in an input matrix which has the same elements as a provided search vector.</span>
- <span class="signature">[`glastIndexOfTruthy( N, x, strideX )`][@stdlib/blas/ext/base/glast-index-of-truthy]</span><span class="delimiter">: </span><span class="description">return the index of the last truthy element in a strided array.</span>
- <span class="signature">[`glastIndexOf( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/glast-index-of]</span><span class="delimiter">: </span><span class="description">return the last index of a specified search element in a strided array.</span>
Expand Down Expand Up @@ -311,6 +313,7 @@ var o = ns;
- <span class="signature">[`swapx( N, alpha, x, strideX, w, strideW )`][@stdlib/blas/ext/base/swapx]</span><span class="delimiter">: </span><span class="description">add a scalar constant to each element in a single-precision floating-point strided array `x` and assign the results to elements in a single-precision floating-point strided array `w`.</span>
- <span class="signature">[`swhere( N, condition, strideC, x, strideX, y, strideY, out, strideOut )`][@stdlib/blas/ext/base/swhere]</span><span class="delimiter">: </span><span class="description">take elements from one of two single-precision floating-point strided arrays depending on a condition.</span>
- <span class="signature">[`swxsa( N, alpha, x, strideX, w, strideW )`][@stdlib/blas/ext/base/swxsa]</span><span class="delimiter">: </span><span class="description">subtract a scalar constant from each element in a single-precision floating-point strided array `x` and assign the results to elements in a single-precision floating-point strided array `w`.</span>
- <span class="signature">[`sxmy( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/sxmy]</span><span class="delimiter">: </span><span class="description">multiply elements of a single-precision floating-point strided array `x` by the corresponding elements of a single-precision floating-point strided array `y` and assign the results to `y`.</span>
- <span class="signature">[`sxpy( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/sxpy]</span><span class="delimiter">: </span><span class="description">add elements of a single-precision floating-point strided array `x` to the corresponding elements of a single-precision floating-point strided array `y` and assign the results to `y`.</span>
- <span class="signature">[`sxsa( N, alpha, x, strideX )`][@stdlib/blas/ext/base/sxsa]</span><span class="delimiter">: </span><span class="description">subtract a scalar constant from each element in a single-precision floating-point strided array.</span>
- <span class="signature">[`sxsy( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/sxsy]</span><span class="delimiter">: </span><span class="description">subtract elements of a single-precision floating-point strided array `y` from the corresponding elements of a single-precision floating-point strided array `x` and assign the results to `y`.</span>
Expand Down Expand Up @@ -600,6 +603,8 @@ console.log( objectKeys( ns ) );

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

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

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

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

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

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

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

[@stdlib/blas/ext/base/glast-index-of-truthy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/glast-index-of-truthy
Expand Down Expand Up @@ -924,6 +931,8 @@ console.log( objectKeys( ns ) );

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

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

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

[@stdlib/blas/ext/base/sxsa]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/sxsa
Expand Down
15 changes: 15 additions & 0 deletions lib/node_modules/@stdlib/ndarray/matrix/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,12 @@ The namespace exports the following:

<div class="namespace-toc">

- <span class="signature">[`Complex128Matrix()`][@stdlib/ndarray/matrix/complex128]</span><span class="delimiter">: </span><span class="description">create a double-precision complex floating-point matrix (i.e., a two-dimensional ndarray).</span>
- <span class="signature">[`Complex64Matrix()`][@stdlib/ndarray/matrix/complex64]</span><span class="delimiter">: </span><span class="description">create a single-precision complex floating-point matrix (i.e., a two-dimensional ndarray).</span>
- <span class="signature">[`matrix()`][@stdlib/ndarray/matrix/ctor]</span><span class="delimiter">: </span><span class="description">create a matrix (i.e., a two-dimensional ndarray).</span>
- <span class="signature">[`Float32Matrix()`][@stdlib/ndarray/matrix/float32]</span><span class="delimiter">: </span><span class="description">create a single-precision floating-point matrix (i.e., a two-dimensional ndarray).</span>
- <span class="signature">[`Float64Matrix()`][@stdlib/ndarray/matrix/float64]</span><span class="delimiter">: </span><span class="description">create a double-precision floating-point matrix (i.e., a two-dimensional ndarray).</span>
- <span class="signature">[`Int32Matrix()`][@stdlib/ndarray/matrix/int32]</span><span class="delimiter">: </span><span class="description">create a 32-bit signed integer matrix (i.e., a two-dimensional ndarray).</span>

</div>

Expand Down Expand Up @@ -108,8 +113,18 @@ console.log( objectKeys( ns ) );

<!-- <toc-links> -->

[@stdlib/ndarray/matrix/complex128]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/matrix/complex128

[@stdlib/ndarray/matrix/complex64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/matrix/complex64

[@stdlib/ndarray/matrix/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/matrix/ctor

[@stdlib/ndarray/matrix/float32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/matrix/float32

[@stdlib/ndarray/matrix/float64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/matrix/float64

[@stdlib/ndarray/matrix/int32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/matrix/int32

<!-- </toc-links> -->

</section>
Expand Down