Skip to content

docs: update namespace table of contents #13384

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 9, 2026
+15 −0
Merged

docs: update namespace table of contents #13384

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 @@ -60,6 +60,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">[`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>
- <span class="signature">[`cxsy( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/cxsy]</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 `y`.</span>
Expand Down Expand Up @@ -89,6 +90,7 @@ var o = ns;
- <span class="signature">[`dcusumpw( N, sum, x, strideX, y, strideY )`][@stdlib/blas/ext/base/dcusumpw]</span><span class="delimiter">: </span><span class="description">calculate the cumulative sum of double-precision floating-point strided array elements using pairwise summation.</span>
- <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">[`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">[`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>
- <span class="signature">[`dindexOfColumn( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/dindex-of-column]</span><span class="delimiter">: </span><span class="description">return the index of the first column in a double-precision floating-point input matrix which has the same elements as a provided search vector.</span>
Expand Down Expand Up @@ -357,6 +359,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">[`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">[`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>
- <span class="signature">[`zxsa( N, alpha, x, strideX )`][@stdlib/blas/ext/base/zxsa]</span><span class="delimiter">: </span><span class="description">subtract a scalar constant from each element in a double-precision complex floating-point strided array.</span>
- <span class="signature">[`zxsy( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/zxsy]</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 `y`.</span>
Expand Down Expand Up @@ -445,6 +448,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/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

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

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

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

[@stdlib/blas/ext/base/dfill]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dfill
Expand Down Expand Up @@ -1039,6 +1046,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/zxmy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zxmy

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

[@stdlib/blas/ext/base/zxsa]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zxsa
Expand Down
6 changes: 6 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/ndarray/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ The namespace exposes the following APIs:
- <span class="signature">[`csum( arrays )`][@stdlib/blas/ext/base/ndarray/csum]</span><span class="delimiter">: </span><span class="description">compute the sum of all elements in a one-dimensional single-precision complex floating-point ndarray.</span>
- <span class="signature">[`csumkbn( arrays )`][@stdlib/blas/ext/base/ndarray/csumkbn]</span><span class="delimiter">: </span><span class="description">compute the sum of all elements in a one-dimensional single-precision complex floating-point ndarray using an improved Kahan–Babuška algorithm.</span>
- <span class="signature">[`cunitspace( arrays )`][@stdlib/blas/ext/base/ndarray/cunitspace]</span><span class="delimiter">: </span><span class="description">fill a one-dimensional single-precision complex floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from a specified value.</span>
- <span class="signature">[`cxmy( arrays )`][@stdlib/blas/ext/base/ndarray/cxmy]</span><span class="delimiter">: </span><span class="description">multiply elements of a one-dimensional single-precision complex floating-point ndarray by the corresponding elements of a second one-dimensional single-precision complex floating-point ndarray and assign the results to the second ndarray.</span>
- <span class="signature">[`cxpy( arrays )`][@stdlib/blas/ext/base/ndarray/cxpy]</span><span class="delimiter">: </span><span class="description">add elements of a one-dimensional single-precision complex floating-point ndarray to the corresponding elements of a second one-dimensional single-precision complex floating-point ndarray and assign the results to the second ndarray.</span>
- <span class="signature">[`cxsa( arrays )`][@stdlib/blas/ext/base/ndarray/cxsa]</span><span class="delimiter">: </span><span class="description">subtract a scalar constant from each element in a one-dimensional single-precision complex floating-point ndarray.</span>
- <span class="signature">[`cxsy( arrays )`][@stdlib/blas/ext/base/ndarray/cxsy]</span><span class="delimiter">: </span><span class="description">subtract the elements of an output one-dimensional single-precision complex floating-point ndarray from the corresponding elements in an input one-dimensional single-precision complex floating-point ndarray and assign the results to the output ndarray.</span>
Expand Down Expand Up @@ -163,6 +164,7 @@ The namespace exposes the following APIs:
- <span class="signature">[`zsum( arrays )`][@stdlib/blas/ext/base/ndarray/zsum]</span><span class="delimiter">: </span><span class="description">compute the sum of all elements in a one-dimensional double-precision complex floating-point ndarray.</span>
- <span class="signature">[`zsumkbn( arrays )`][@stdlib/blas/ext/base/ndarray/zsumkbn]</span><span class="delimiter">: </span><span class="description">compute the sum of all elements in a one-dimensional double-precision complex floating-point ndarray using an improved Kahan–Babuška algorithm.</span>
- <span class="signature">[`zunitspace( arrays )`][@stdlib/blas/ext/base/ndarray/zunitspace]</span><span class="delimiter">: </span><span class="description">fill a one-dimensional double-precision complex floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from a specified value.</span>
- <span class="signature">[`zxmy( arrays )`][@stdlib/blas/ext/base/ndarray/zxmy]</span><span class="delimiter">: </span><span class="description">multiply elements of a one-dimensional double-precision complex floating-point ndarray by the corresponding elements of a second one-dimensional double-precision complex floating-point ndarray and assign the results to the second ndarray.</span>
- <span class="signature">[`zxpy( arrays )`][@stdlib/blas/ext/base/ndarray/zxpy]</span><span class="delimiter">: </span><span class="description">add elements of a one-dimensional double-precision complex floating-point ndarray to the corresponding elements of a second one-dimensional double-precision complex floating-point ndarray and assign the results to the second ndarray.</span>
- <span class="signature">[`zxsa( arrays )`][@stdlib/blas/ext/base/ndarray/zxsa]</span><span class="delimiter">: </span><span class="description">subtract a scalar constant from each element in a one-dimensional double-precision complex floating-point ndarray.</span>
- <span class="signature">[`zxsy( arrays )`][@stdlib/blas/ext/base/ndarray/zxsy]</span><span class="delimiter">: </span><span class="description">subtract the elements of an output one-dimensional double-precision complex floating-point ndarray from the corresponding elements in an input one-dimensional double-precision complex floating-point ndarray and assign the results to the output ndarray.</span>
Expand Down Expand Up @@ -223,6 +225,8 @@ console.log( objectKeys( ns ) );

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

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

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

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

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

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

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

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