Skip to content

docs: update namespace table of contents #15718

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
Oct 1, 2026
Merged

docs: update namespace table of contents #15718

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/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,13 @@ The namespace contains the following:
- <span class="signature">[`cunone( x[, options] )`][@stdlib/blas/ext/cunone]</span><span class="delimiter">: </span><span class="description">cumulatively test whether every element along one or more ndarray dimensions is falsy.</span>
- <span class="signature">[`cusum( x[, initial][, options] )`][@stdlib/blas/ext/cusum]</span><span class="delimiter">: </span><span class="description">compute the cumulative sum along one or more ndarray dimensions.</span>
- <span class="signature">[`fillBetween( x, value[, start[, end]][, options] )`][@stdlib/blas/ext/fill-between]</span><span class="delimiter">: </span><span class="description">fill an input ndarray with a specified value along an ndarray dimension.</span>
- <span class="signature">[`findIndexBetween( x, fromIndex, toIndex[, options], clbk[, thisArg] )`][@stdlib/blas/ext/find-index-between]</span><span class="delimiter">: </span><span class="description">return the index of the first element along an ndarray dimension which passes a test implemented by a predicate function within a specified range.</span>
- <span class="signature">[`findIndex( x[, fromIndex][, options], clbk[, thisArg] )`][@stdlib/blas/ext/find-index]</span><span class="delimiter">: </span><span class="description">return the index of the first element along an ndarray dimension which passes a test implemented by a predicate function.</span>
- <span class="signature">[`findLastIndex( x[, fromIndex][, options], clbk[, thisArg] )`][@stdlib/blas/ext/find-last-index]</span><span class="delimiter">: </span><span class="description">return the index of the last element along an ndarray dimension which passes a test implemented by a predicate function.</span>
- <span class="signature">[`firstIndexLessThan( x, y[, fromIndex][, options] )`][@stdlib/blas/ext/first-index-less-than]</span><span class="delimiter">: </span><span class="description">return the index of the first element in an ndarray which is less than a corresponding element in another ndarray along an ndarray dimension.</span>
- <span class="signature">[`indexOfFalsy( x[, fromIndex][, options] )`][@stdlib/blas/ext/index-of-falsy]</span><span class="delimiter">: </span><span class="description">return the index of the first falsy element along an ndarray dimension.</span>
- <span class="signature">[`indexOfNotEqual( x, searchElement[, fromIndex][, options] )`][@stdlib/blas/ext/index-of-not-equal]</span><span class="delimiter">: </span><span class="description">return the first index of an element which is not equal to a specified search element along an ndarray dimension.</span>
- <span class="signature">[`indexOfTruthy( x[, fromIndex][, options] )`][@stdlib/blas/ext/index-of-truthy]</span><span class="delimiter">: </span><span class="description">return the index of the first truthy element along an ndarray dimension.</span>
- <span class="signature">[`indexOf( x, searchElement[, fromIndex][, options] )`][@stdlib/blas/ext/index-of]</span><span class="delimiter">: </span><span class="description">return the first index of a specified search element along an ndarray dimension.</span>
- <span class="signature">[`join( x[, options] )`][@stdlib/blas/ext/join]</span><span class="delimiter">: </span><span class="description">return an ndarray created by joining elements using a separator along one or more ndarray dimensions.</span>
- <span class="signature">[`lastIndexOfFalsy( x[, fromIndex][, options] )`][@stdlib/blas/ext/last-index-of-falsy]</span><span class="delimiter">: </span><span class="description">return the index of the last falsy element along an ndarray dimension.</span>
Expand Down Expand Up @@ -130,14 +133,20 @@ console.log( objectKeys( ns ) );

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

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

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

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

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

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

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

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

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

[@stdlib/blas/ext/join]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/join
Expand Down
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 @@ -70,9 +70,11 @@ var o = ns;
- <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>
- <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">[`cwxmy( N, x, strideX, y, strideY, w, strideW )`][@stdlib/blas/ext/base/cwxmy]</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 elements in a single-precision complex floating-point strided array `w`.</span>
- <span class="signature">[`cwxpy( N, x, strideX, y, strideY, w, strideW )`][@stdlib/blas/ext/base/cwxpy]</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 elements in a single-precision complex floating-point strided array `w`.</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">[`cxdy( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/cxdy]</span><span class="delimiter">: </span><span class="description">divide 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">[`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 @@ -242,6 +244,7 @@ var o = ns;
- <span class="signature">[`gfirstIndexLessThanEqual( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gfirst-index-less-than-equal]</span><span class="delimiter">: </span><span class="description">return the index of the first element in a strided array which is less than or equal to a corresponding element in another strided array.</span>
- <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 a corresponding element in another strided array.</span>
- <span class="signature">[`gindexOfAlmostEqual( N, searchElement, maxULP, x, strideX )`][@stdlib/blas/ext/base/gindex-of-almost-equal]</span><span class="delimiter">: </span><span class="description">return the first index of an element in a strided array which is almost equal to a specified search element.</span>
- <span class="signature">[`gindexOfAlmostSameValue( N, searchElement, maxULP, x, strideX )`][@stdlib/blas/ext/base/gindex-of-almost-same-value]</span><span class="delimiter">: </span><span class="description">return the first index of an element in a strided array which is almost the same value as a specified search element.</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>
Expand Down Expand Up @@ -377,6 +380,8 @@ var o = ns;
- <span class="signature">[`slastIndexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/slast-index-of-row]</span><span class="delimiter">: </span><span class="description">return the index of the last row in a single-precision floating-point input matrix which has the same elements as a provided search vector.</span>
- <span class="signature">[`slastIndexOfTruthy( N, x, strideX )`][@stdlib/blas/ext/base/slast-index-of-truthy]</span><span class="delimiter">: </span><span class="description">return the index of the last truthy element in a single-precision floating-point strided array.</span>
- <span class="signature">[`slastIndexOf( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/slast-index-of]</span><span class="delimiter">: </span><span class="description">return the last index of a specified search element in a single-precision floating-point strided array.</span>
- <span class="signature">[`sleftPadCircular( N, k, x, strideX, y, strideY )`][@stdlib/blas/ext/base/sleft-pad-circular]</span><span class="delimiter">: </span><span class="description">prepend elements to a single-precision floating-point strided array by circularly repeating existing elements.</span>
- <span class="signature">[`sleftPadEdge( N, k, x, strideX, y, strideY )`][@stdlib/blas/ext/base/sleft-pad-edge]</span><span class="delimiter">: </span><span class="description">prepend elements to a single-precision floating-point strided array by repeating the leading edge element.</span>
- <span class="signature">[`slinspace( N, start, stop, endpoint, x, strideX )`][@stdlib/blas/ext/base/slinspace]</span><span class="delimiter">: </span><span class="description">fill a single-precision floating-point strided array with linearly spaced values over a specified interval.</span>
- <span class="signature">[`slogspace( N, base, start, stop, endpoint, x, strideX )`][@stdlib/blas/ext/base/slogspace]</span><span class="delimiter">: </span><span class="description">fill a single-precision floating-point strided array with logarithmically spaced values over a specified interval.</span>
- <span class="signature">[`sminheapSiftDown( N, index, value, x, strideX )`][@stdlib/blas/ext/base/sminheap-sift-down]</span><span class="delimiter">: </span><span class="description">sift a value down from a specified index in a single-precision floating-point strided min-heap until the heap property is restored.</span>
Expand Down Expand Up @@ -459,6 +464,7 @@ var o = ns;
- <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>
- <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">[`zwxpy( N, x, strideX, y, strideY, w, strideW )`][@stdlib/blas/ext/base/zwxpy]</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 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>
Expand Down Expand Up @@ -571,12 +577,16 @@ console.log( objectKeys( ns ) );

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

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

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

[@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/cxdy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/cxdy

[@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 @@ -915,6 +925,8 @@ console.log( objectKeys( ns ) );

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

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

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

[@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
Expand Down Expand Up @@ -1185,6 +1197,10 @@ console.log( objectKeys( ns ) );

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

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

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

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

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

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

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

[@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
Expand Down
Loading
Loading