Skip to content

docs: update namespace table of contents #13932

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 5, 2026
Merged

docs: update namespace table of contents #13932

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
18 changes: 18 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 @@ -59,6 +59,7 @@ var o = ns;
- <span class="signature">[`creplicate( N, k, x, strideX, out, strideOut )`][@stdlib/blas/ext/base/creplicate]</span><span class="delimiter">: </span><span class="description">replicate each element in a single-precision complex floating-point strided array a specified number of times.</span>
- <span class="signature">[`csum( N, x, strideX )`][@stdlib/blas/ext/base/csum]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision complex floating-point strided array elements.</span>
- <span class="signature">[`csumkbn( N, x, strideX )`][@stdlib/blas/ext/base/csumkbn]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision complex floating-point strided array elements using an improved Kahan–Babuška algorithm.</span>
- <span class="signature">[`ctriu( order, M, N, k, A, LDA, B, LDB )`][@stdlib/blas/ext/base/ctriu]</span><span class="delimiter">: </span><span class="description">copy the upper triangular part of a single-precision complex floating-point matrix `A` to another matrix `B`.</span>
- <span class="signature">[`cunitspace( N, start, x, strideX )`][@stdlib/blas/ext/base/cunitspace]</span><span class="delimiter">: </span><span class="description">fill a single-precision complex floating-point strided array with linearly spaced numeric elements which increment by `1` starting from a specified value.</span>
- <span class="signature">[`cwapx( N, alpha, x, strideX, w, strideW )`][@stdlib/blas/ext/base/cwapx]</span><span class="delimiter">: </span><span class="description">add a scalar constant to each element in a single-precision complex floating-point strided array `x` and assign the results to elements in a single-precision complex floating-point strided array `w`.</span>
- <span class="signature">[`cwax( N, alpha, x, strideX, w, strideW )`][@stdlib/blas/ext/base/cwax]</span><span class="delimiter">: </span><span class="description">multiply each element in a single-precision complex floating-point strided array `x` by a scalar constant and assign the results to elements in a single-precision complex floating-point strided array `w`.</span>
Expand Down Expand Up @@ -172,6 +173,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">[`dwax( N, alpha, x, strideX, w, strideW )`][@stdlib/blas/ext/base/dwax]</span><span class="delimiter">: </span><span class="description">multiply each element in a double-precision floating-point strided array `x` by a scalar constant 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">[`dwxdy( N, x, strideX, y, strideY, w, strideW )`][@stdlib/blas/ext/base/dwxdy]</span><span class="delimiter">: </span><span class="description">divide 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 elements in a double-precision floating-point strided array `w`.</span>
- <span class="signature">[`dwxmy( N, x, strideX, y, strideY, w, strideW )`][@stdlib/blas/ext/base/dwxmy]</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 elements in a double-precision floating-point strided array `w`.</span>
- <span class="signature">[`dwxpy( N, x, strideX, y, strideY, w, strideW )`][@stdlib/blas/ext/base/dwxpy]</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 elements in a double-precision floating-point strided array `w`.</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>
Expand Down Expand Up @@ -224,6 +226,7 @@ var o = ns;
- <span class="signature">[`gfirstIndexLessThan( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gfirst-index-less-than]</span><span class="delimiter">: </span><span class="description">return the index of the first element in a strided array which is less than a corresponding element in another strided array.</span>
- <span class="signature">[`gfirstIndexNotEqual( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gfirst-index-not-equal]</span><span class="delimiter">: </span><span class="description">return the index of the first element in a strided array which is not equal to the corresponding element in another strided array.</span>
- <span class="signature">[`gindexOfColumn( order, M, N, A, LDA, x, strideX )`][@stdlib/blas/ext/base/gindex-of-column]</span><span class="delimiter">: </span><span class="description">return the index of the first column in an input matrix which has the same elements as a provided search vector.</span>
- <span class="signature">[`gindexOfFalsyRow( order, M, N, A, LDA )`][@stdlib/blas/ext/base/gindex-of-falsy-row]</span><span class="delimiter">: </span><span class="description">return the index of the first row in an input matrix in which all elements are falsy.</span>
- <span class="signature">[`gindexOfFalsy( N, x, strideX )`][@stdlib/blas/ext/base/gindex-of-falsy]</span><span class="delimiter">: </span><span class="description">return the index of the first falsy element in a strided array.</span>
- <span class="signature">[`gindexOfNotEqual( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/gindex-of-not-equal]</span><span class="delimiter">: </span><span class="description">return the first index of an element in a strided array which is not equal to a specified search element.</span>
- <span class="signature">[`gindexOfRow( order, M, N, A, LDA, x, strideX )`][@stdlib/blas/ext/base/gindex-of-row]</span><span class="delimiter">: </span><span class="description">return the index of the first row in an input matrix which has the same elements as a provided search vector.</span>
Expand Down Expand Up @@ -303,6 +306,7 @@ var o = ns;
- <span class="signature">[`scartesianProduct( order, M, N, x, strideX, y, strideY, out, LDO )`][@stdlib/blas/ext/base/scartesian-product]</span><span class="delimiter">: </span><span class="description">compute the Cartesian product for two single-precision floating-point strided arrays.</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>
- <span class="signature">[`scopyWithin( N, target, start, end, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/scopy-within]</span><span class="delimiter">: </span><span class="description">perform an in-place copy of elements within a single-precision floating-point strided array.</span>
- <span class="signature">[`scuany( N, x, strideX, out, strideOut )`][@stdlib/blas/ext/base/scuany]</span><span class="delimiter">: </span><span class="description">cumulatively test whether at least one element in a single-precision floating-point strided array is truthy.</span>
- <span class="signature">[`scuevery( N, x, strideX, out, strideOut )`][@stdlib/blas/ext/base/scuevery]</span><span class="delimiter">: </span><span class="description">cumulatively test whether every element in a single-precision floating-point strided array is truthy.</span>
- <span class="signature">[`scunone( N, x, strideX, out, strideOut )`][@stdlib/blas/ext/base/scunone]</span><span class="delimiter">: </span><span class="description">cumulatively test whether every element in a single-precision floating-point strided array is falsy.</span>
Expand Down Expand Up @@ -371,6 +375,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">[`swax( N, alpha, x, strideX, w, strideW )`][@stdlib/blas/ext/base/swax]</span><span class="delimiter">: </span><span class="description">multiply each element in a single-precision floating-point strided array `x` by a scalar constant 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">[`swxdy( N, x, strideX, y, strideY, w, strideW )`][@stdlib/blas/ext/base/swxdy]</span><span class="delimiter">: </span><span class="description">divide 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 elements in a single-precision floating-point strided array `w`.</span>
- <span class="signature">[`swxmy( N, x, strideX, y, strideY, w, strideW )`][@stdlib/blas/ext/base/swxmy]</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 elements in a single-precision floating-point strided array `w`.</span>
- <span class="signature">[`swxpy( N, x, strideX, y, strideY, w, strideW )`][@stdlib/blas/ext/base/swxpy]</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 elements in a single-precision floating-point strided array `w`.</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>
Expand Down Expand Up @@ -404,6 +409,7 @@ var o = ns;
- <span class="signature">[`zreplicate( N, k, x, strideX, out, strideOut )`][@stdlib/blas/ext/base/zreplicate]</span><span class="delimiter">: </span><span class="description">replicate each element in a double-precision complex floating-point strided array a specified number of times.</span>
- <span class="signature">[`zsum( N, x, strideX )`][@stdlib/blas/ext/base/zsum]</span><span class="delimiter">: </span><span class="description">calculate the sum of double-precision complex floating-point strided array elements.</span>
- <span class="signature">[`zsumkbn( N, x, strideX )`][@stdlib/blas/ext/base/zsumkbn]</span><span class="delimiter">: </span><span class="description">calculate the sum of double-precision complex floating-point strided array elements using an improved Kahan–Babuška algorithm.</span>
- <span class="signature">[`ztriu( order, M, N, k, A, LDA, B, LDB )`][@stdlib/blas/ext/base/ztriu]</span><span class="delimiter">: </span><span class="description">copy the upper triangular part of a double-precision complex floating-point matrix `A` to another matrix `B`.</span>
- <span class="signature">[`zunitspace( N, start, x, strideX )`][@stdlib/blas/ext/base/zunitspace]</span><span class="delimiter">: </span><span class="description">fill a double-precision complex floating-point strided array with linearly spaced numeric elements which increment by `1` starting from a specified value.</span>
- <span class="signature">[`zwapx( N, alpha, x, strideX, w, strideW )`][@stdlib/blas/ext/base/zwapx]</span><span class="delimiter">: </span><span class="description">add a scalar constant to each element in a double-precision complex floating-point strided array `x` and assign the results to elements in a double-precision complex floating-point strided array `w`.</span>
- <span class="signature">[`zwax( N, alpha, x, strideX, w, strideW )`][@stdlib/blas/ext/base/zwax]</span><span class="delimiter">: </span><span class="description">multiply each element in a double-precision complex floating-point strided array `x` by a scalar constant and assign the results to elements in a double-precision complex floating-point strided array `w`.</span>
Expand Down Expand Up @@ -499,6 +505,8 @@ console.log( objectKeys( ns ) );

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

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

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

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

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

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

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

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

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

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

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

[@stdlib/blas/ext/base/gindex-of-not-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gindex-of-not-equal
Expand Down Expand Up @@ -987,6 +999,8 @@ console.log( objectKeys( ns ) );

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

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

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

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

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

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

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

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

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

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

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

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