Skip to content

docs: update namespace table of contents #13770

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
Jul 30, 2026
Merged

docs: update namespace table of contents #13770

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
12 changes: 12 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 @@ -52,6 +52,7 @@ var o = ns;
- <span class="signature">[`cindexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/cindex-of-row]</span><span class="delimiter">: </span><span class="description">return the index of the first row in a single-precision complex floating-point input matrix which has the same elements as a provided search vector.</span>
- <span class="signature">[`cindexOf( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/cindex-of]</span><span class="delimiter">: </span><span class="description">return the first index of a specified search element in a single-precision complex floating-point strided array.</span>
- <span class="signature">[`clastIndexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/clast-index-of-row]</span><span class="delimiter">: </span><span class="description">return the index of the last row in a single-precision complex floating-point input matrix which has the same elements as a provided search vector.</span>
- <span class="signature">[`clogspace( N, base, start, stop, endpoint, x, strideX )`][@stdlib/blas/ext/base/clogspace]</span><span class="delimiter">: </span><span class="description">fill a single-precision complex floating-point strided array with logarithmically spaced values over a specified interval.</span>
- <span class="signature">[`coneTo( N, x, strideX )`][@stdlib/blas/ext/base/cone-to]</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 one.</span>
- <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>
Expand Down Expand Up @@ -163,6 +164,7 @@ var o = ns;
- <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">[`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>
- <span class="signature">[`dxdy( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/dxdy]</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 `y`.</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>
Expand Down Expand Up @@ -215,6 +217,7 @@ var o = ns;
- <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>
- <span class="signature">[`gindexOfSameValue( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/gindex-of-same-value]</span><span class="delimiter">: </span><span class="description">return the index of the first element in a strided array which has the same value as a provided search element.</span>
- <span class="signature">[`gindexOfTruthyRow( order, M, N, A, LDA )`][@stdlib/blas/ext/base/gindex-of-truthy-row]</span><span class="delimiter">: </span><span class="description">return the index of the first row in an input matrix which contains at least one truthy element.</span>
- <span class="signature">[`gindexOfTruthy( N, x, strideX )`][@stdlib/blas/ext/base/gindex-of-truthy]</span><span class="delimiter">: </span><span class="description">return the index of the first truthy element in a strided array.</span>
- <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>
Expand Down Expand Up @@ -246,6 +249,7 @@ var o = ns;
- <span class="signature">[`gsort2hp( N, order, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gsort2hp]</span><span class="delimiter">: </span><span class="description">simultaneously sort two strided arrays based on the sort order of the first array using heapsort.</span>
- <span class="signature">[`gsort2ins( N, order, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gsort2ins]</span><span class="delimiter">: </span><span class="description">simultaneously sort two strided arrays based on the sort order of the first array using insertion sort.</span>
- <span class="signature">[`gsort2sh( N, order, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gsort2sh]</span><span class="delimiter">: </span><span class="description">simultaneously sort two strided arrays based on the sort order of the first array using Shellsort.</span>
- <span class="signature">[`gsorthpBy( N, x, strideX, clbk[, thisArg] )`][@stdlib/blas/ext/base/gsorthp-by]</span><span class="delimiter">: </span><span class="description">sort a strided array using heapsort according to a provided callback function.</span>
- <span class="signature">[`gsorthp( N, order, x, strideX )`][@stdlib/blas/ext/base/gsorthp]</span><span class="delimiter">: </span><span class="description">sort a strided array using heapsort.</span>
- <span class="signature">[`gsortins( N, order, x, strideX )`][@stdlib/blas/ext/base/gsortins]</span><span class="delimiter">: </span><span class="description">sort a strided array using insertion sort.</span>
- <span class="signature">[`gsortsh( N, order, x, strideX )`][@stdlib/blas/ext/base/gsortsh]</span><span class="delimiter">: </span><span class="description">sort a strided array using Shellsort.</span>
Expand Down Expand Up @@ -457,6 +461,8 @@ console.log( objectKeys( ns ) );

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

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

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

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

[@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

[@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/dxdy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dxdy
Expand Down Expand Up @@ -783,6 +791,8 @@ console.log( objectKeys( ns ) );

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

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

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

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

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

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

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

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