Skip to content

docs: update namespace table of contents #13854

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

docs: update namespace table of contents #13854

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 @@ -64,6 +64,7 @@ var o = ns;
- <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>
- <span class="signature">[`cwhere( N, condition, strideC, x, strideX, y, strideY, out, strideOut )`][@stdlib/blas/ext/base/cwhere]</span><span class="delimiter">: </span><span class="description">take elements from one of two single-precision complex floating-point strided arrays depending on a condition.</span>
- <span class="signature">[`cwxsa( N, alpha, x, strideX, w, strideW )`][@stdlib/blas/ext/base/cwxsa]</span><span class="delimiter">: </span><span class="description">subtract a scalar constant from 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">[`cwxsy( N, x, strideX, y, strideY, w, strideW )`][@stdlib/blas/ext/base/cwxsy]</span><span class="delimiter">: </span><span class="description">subtract elements of a single-precision complex floating-point strided array `y` from the corresponding elements of 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">[`cxmy( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/cxmy]</span><span class="delimiter">: </span><span class="description">multiply elements of a single-precision complex floating-point strided array `x` by the corresponding elements of a single-precision complex floating-point strided array `y` and assign the results to `y`.</span>
- <span class="signature">[`cxpy( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/cxpy]</span><span class="delimiter">: </span><span class="description">add elements of a single-precision complex floating-point strided array `x` to the corresponding elements of a single-precision complex floating-point strided array `y` and assign the results to `y`.</span>
- <span class="signature">[`cxsa( N, alpha, x, strideX )`][@stdlib/blas/ext/base/cxsa]</span><span class="delimiter">: </span><span class="description">subtract a scalar constant from each element in a single-precision complex floating-point strided array.</span>
Expand Down Expand Up @@ -95,6 +96,7 @@ var o = ns;
- <span class="signature">[`ddiff( N, k, x, strideX, N1, prepend, strideP, N2, append, strideA, out, strideOut, workspace, strideW )`][@stdlib/blas/ext/base/ddiff]</span><span class="delimiter">: </span><span class="description">calculate the k-th discrete forward difference of a double-precision floating-point strided array.</span>
- <span class="signature">[`dediff( N, x, strideX, N1, prepend, strideP, N2, append, strideA, out, strideOut )`][@stdlib/blas/ext/base/dediff]</span><span class="delimiter">: </span><span class="description">calculate the differences between consecutive elements of a double-precision floating-point strided array.</span>
- <span class="signature">[`dfillEqual( N, searchElement, alpha, x, strideX )`][@stdlib/blas/ext/base/dfill-equal]</span><span class="delimiter">: </span><span class="description">replace double-precision floating-point strided array elements equal to a provided search element with a specified scalar constant.</span>
- <span class="signature">[`dfillLessThan( N, searchElement, alpha, x, strideX )`][@stdlib/blas/ext/base/dfill-less-than]</span><span class="delimiter">: </span><span class="description">replace double-precision floating-point strided array elements less than a provided search element with a specified scalar constant.</span>
- <span class="signature">[`dfillNaN( N, alpha, x, strideX )`][@stdlib/blas/ext/base/dfill-nan]</span><span class="delimiter">: </span><span class="description">replace double-precision floating-point strided array elements equal to `NaN` with a specified scalar constant.</span>
- <span class="signature">[`dfillNotEqual( N, searchElement, alpha, x, strideX )`][@stdlib/blas/ext/base/dfill-not-equal]</span><span class="delimiter">: </span><span class="description">replace double-precision floating-point strided array elements not equal to a provided search element with a specified scalar constant.</span>
- <span class="signature">[`dfill( N, alpha, x, strideX )`][@stdlib/blas/ext/base/dfill]</span><span class="delimiter">: </span><span class="description">fill a double-precision floating-point strided array with a specified scalar constant.</span>
Expand All @@ -107,6 +109,7 @@ var o = ns;
- <span class="signature">[`dindexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/dindex-of-row]</span><span class="delimiter">: </span><span class="description">return the index of the first row in a double-precision floating-point input matrix which has the same elements as a provided search vector.</span>
- <span class="signature">[`dindexOfTruthy( N, x, strideX )`][@stdlib/blas/ext/base/dindex-of-truthy]</span><span class="delimiter">: </span><span class="description">return the index of the first truthy element in a double-precision floating-point strided array.</span>
- <span class="signature">[`dindexOf( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/dindex-of]</span><span class="delimiter">: </span><span class="description">return the first index of a specified search element in a double-precision floating-point strided array.</span>
- <span class="signature">[`dlastIndexEqual( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/dlast-index-equal]</span><span class="delimiter">: </span><span class="description">return the index of the last element in a double-precision floating-point strided array equal to a corresponding element in another double-precision floating-point strided array.</span>
- <span class="signature">[`dlastIndexOfFalsy( N, x, strideX )`][@stdlib/blas/ext/base/dlast-index-of-falsy]</span><span class="delimiter">: </span><span class="description">return the index of the last falsy element in a double-precision floating-point strided array.</span>
- <span class="signature">[`dlastIndexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/dlast-index-of-row]</span><span class="delimiter">: </span><span class="description">return the index of the last row in a double-precision floating-point input matrix which has the same elements as a provided search vector.</span>
- <span class="signature">[`dlastIndexOfTruthy( N, x, strideX )`][@stdlib/blas/ext/base/dlast-index-of-truthy]</span><span class="delimiter">: </span><span class="description">return the index of the last truthy element in a double-precision floating-point strided array.</span>
Expand Down Expand Up @@ -193,6 +196,7 @@ var o = ns;
- <span class="signature">[`gcartesianSquare( order, N, x, strideX, out, LDO )`][@stdlib/blas/ext/base/gcartesian-square]</span><span class="delimiter">: </span><span class="description">compute the Cartesian square for a strided array.</span>
- <span class="signature">[`gcircshift( N, k, x, strideX )`][@stdlib/blas/ext/base/gcircshift]</span><span class="delimiter">: </span><span class="description">circularly shift the elements of a strided array by a specified number of positions.</span>
- <span class="signature">[`gconjoin( N, prefix, suffix, conjunction, oxfordComma, x, strideX )`][@stdlib/blas/ext/base/gconjoin]</span><span class="delimiter">: </span><span class="description">return a string created by joining strided array elements into a human-readable list using a conjunction.</span>
- <span class="signature">[`gcopyWithin( N, target, start, end, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/gcopy-within]</span><span class="delimiter">: </span><span class="description">perform an in-place copy of elements within a strided array.</span>
- <span class="signature">[`gcuany( N, x, strideX, out, strideOut )`][@stdlib/blas/ext/base/gcuany]</span><span class="delimiter">: </span><span class="description">cumulatively test whether at least one element in a strided array is truthy.</span>
- <span class="signature">[`gcuevery( N, x, strideX, out, strideOut )`][@stdlib/blas/ext/base/gcuevery]</span><span class="delimiter">: </span><span class="description">cumulatively test whether every element in a strided array is truthy.</span>
- <span class="signature">[`gcunone( N, x, strideX, out, strideOut )`][@stdlib/blas/ext/base/gcunone]</span><span class="delimiter">: </span><span class="description">cumulatively test whether every element in a strided array is falsy.</span>
Expand Down Expand Up @@ -270,6 +274,7 @@ var o = ns;
- <span class="signature">[`gwax( N, alpha, x, strideX, w, strideW )`][@stdlib/blas/ext/base/gwax]</span><span class="delimiter">: </span><span class="description">multiply each element in a strided array `x` by a scalar constant and assign the results to elements in a strided array `w`.</span>
- <span class="signature">[`gwaxpb( N, alpha, beta, x, strideX, w, strideW )`][@stdlib/blas/ext/base/gwaxpb]</span><span class="delimiter">: </span><span class="description">multiply each element in a strided array `x` by a scalar constant and add a scalar constant before assigning the results to a strided array `w`.</span>
- <span class="signature">[`gwhere( N, condition, strideC, x, strideX, y, strideY, out, strideOut )`][@stdlib/blas/ext/base/gwhere]</span><span class="delimiter">: </span><span class="description">take elements from one of two strided arrays depending on a condition.</span>
- <span class="signature">[`gwxdy( N, x, strideX, y, strideY, w, strideW )`][@stdlib/blas/ext/base/gwxdy]</span><span class="delimiter">: </span><span class="description">divide elements of a strided array `x` by the corresponding elements of a strided array `y` and assign the results to elements in a strided array `w`.</span>
- <span class="signature">[`gwxmy( N, x, strideX, y, strideY, w, strideW )`][@stdlib/blas/ext/base/gwxmy]</span><span class="delimiter">: </span><span class="description">multiply elements of a strided array `x` by the corresponding elements of a strided array `y` and assign the results to elements in a strided array `w`.</span>
- <span class="signature">[`gwxpy( N, x, strideX, y, strideY, w, strideW )`][@stdlib/blas/ext/base/gwxpy]</span><span class="delimiter">: </span><span class="description">add elements of a strided array `x` to the corresponding elements of a strided array `y` and assign the results to elements in a strided array `w`.</span>
- <span class="signature">[`gwxsa( N, alpha, x, strideX, w, strideW )`][@stdlib/blas/ext/base/gwxsa]</span><span class="delimiter">: </span><span class="description">subtract a scalar constant from each element in a strided array `x` and assign the results to elements in a strided array `w`.</span>
Expand Down Expand Up @@ -401,6 +406,7 @@ var o = ns;
- <span class="signature">[`zwhere( N, condition, strideC, x, strideX, y, strideY, out, strideOut )`][@stdlib/blas/ext/base/zwhere]</span><span class="delimiter">: </span><span class="description">take elements from one of two double-precision complex floating-point strided arrays depending on a condition.</span>
- <span class="signature">[`zwxmy( N, x, strideX, y, strideY, w, strideW )`][@stdlib/blas/ext/base/zwxmy]</span><span class="delimiter">: </span><span class="description">multiply elements of a double-precision complex floating-point strided array `x` by the corresponding elements of a double-precision complex floating-point strided array `y` and assign the results to elements in a double-precision complex floating-point strided array `w`.</span>
- <span class="signature">[`zwxsa( N, alpha, x, strideX, w, strideW )`][@stdlib/blas/ext/base/zwxsa]</span><span class="delimiter">: </span><span class="description">subtract a scalar constant from 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">[`zwxsy( N, x, strideX, y, strideY, w, strideW )`][@stdlib/blas/ext/base/zwxsy]</span><span class="delimiter">: </span><span class="description">subtract elements of a double-precision complex floating-point strided array `y` from the corresponding elements of 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">[`zxdy( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/zxdy]</span><span class="delimiter">: </span><span class="description">divide elements of a double-precision complex floating-point strided array `x` by the corresponding elements of a double-precision complex floating-point strided array `y` and assign the results to `y`.</span>
- <span class="signature">[`zxmy( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/zxmy]</span><span class="delimiter">: </span><span class="description">multiply elements of a double-precision complex floating-point strided array `x` by the corresponding elements of a double-precision complex floating-point strided array `y` and assign the results to `y`.</span>
- <span class="signature">[`zxpy( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/zxpy]</span><span class="delimiter">: </span><span class="description">add elements of a double-precision complex floating-point strided array `x` to the corresponding elements of a double-precision complex floating-point strided array `y` and assign the results to `y`.</span>
Expand Down Expand Up @@ -499,6 +505,8 @@ console.log( objectKeys( ns ) );

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

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

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

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

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

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

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

[@stdlib/blas/ext/base/dfill-not-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dfill-not-equal
Expand All @@ -585,6 +595,8 @@ console.log( objectKeys( ns ) );

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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