Skip to content

docs: update namespace table of contents #13591

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
Planeshifter merged 1 commit into from
Jul 21, 2026
Merged

docs: update namespace table of contents #13591

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
6 changes: 6 additions & 0 deletions lib/node_modules/@stdlib/blas/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,14 @@ The namespace contains the following:

<div class="namespace-toc">

- <span class="signature">[`asum( x[, options] )`][@stdlib/blas/asum]</span><span class="delimiter">: </span><span class="description">compute the sum of absolute values (L1 norm) along one or more ndarray dimensions.</span>
- <span class="signature">[`base`][@stdlib/blas/base]</span><span class="delimiter">: </span><span class="description">base (i.e., lower-level) basic linear algebra subprograms (BLAS).</span>
- <span class="signature">[`ddot( x, y[, dim] )`][@stdlib/blas/ddot]</span><span class="delimiter">: </span><span class="description">calculate the dot product of two double-precision floating-point vectors.</span>
- <span class="signature">[`dswap( x, y[, dim] )`][@stdlib/blas/dswap]</span><span class="delimiter">: </span><span class="description">interchange two double-precision floating-point vectors.</span>
- <span class="signature">[`ext`][@stdlib/blas/ext]</span><span class="delimiter">: </span><span class="description">extended basic linear algebra subprograms (BLAS).</span>
- <span class="signature">[`gdot( x, y )`][@stdlib/blas/gdot]</span><span class="delimiter">: </span><span class="description">calculate the dot product of two vectors.</span>
- <span class="signature">[`gswap( x, y )`][@stdlib/blas/gswap]</span><span class="delimiter">: </span><span class="description">interchange two vectors.</span>
- <span class="signature">[`nrm2( x[, options] )`][@stdlib/blas/nrm2]</span><span class="delimiter">: </span><span class="description">compute the L2-norm along one or more ndarray dimensions.</span>
- <span class="signature">[`sdot( x, y[, dim] )`][@stdlib/blas/sdot]</span><span class="delimiter">: </span><span class="description">calculate the dot product of two single-precision floating-point vectors.</span>
- <span class="signature">[`sswap( x, y[, dim] )`][@stdlib/blas/sswap]</span><span class="delimiter">: </span><span class="description">interchange two single-precision floating-point vectors.</span>

Expand Down Expand Up @@ -95,6 +97,8 @@ console.log( objectKeys( blas ) );

<!-- <toc-links> -->

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

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

[@stdlib/blas/ddot]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ddot
Expand All @@ -107,6 +111,8 @@ console.log( objectKeys( blas ) );

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

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

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

[@stdlib/blas/sswap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/sswap
Expand Down
3 changes: 3 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 @@ -376,6 +376,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">[`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>
- <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>
Expand Down Expand Up @@ -1097,6 +1098,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/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

[@stdlib/blas/ext/base/zxpy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zxpy
Expand Down
3 changes: 3 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 @@ -175,6 +175,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">[`zxdy( arrays )`][@stdlib/blas/ext/base/ndarray/zxdy]</span><span class="delimiter">: </span><span class="description">divide 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">[`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>
Expand Down Expand Up @@ -482,6 +483,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/zxdy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/zxdy

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