Skip to content

docs: update namespace table of contents #13479

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

docs: update namespace table of contents #13479

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
15 changes: 15 additions & 0 deletions lib/node_modules/@stdlib/blas/base/ndarray/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ The namespace exposes the following APIs:
- <span class="signature">[`daxpy( arrays )`][@stdlib/blas/base/ndarray/daxpy]</span><span class="delimiter">: </span><span class="description">multiply a one-dimensional double-precision floating-point ndarray `x` by a constant `alpha` and add the result to a one-dimensional double-precision floating-point ndarray `y`.</span>
- <span class="signature">[`dcopy( arrays )`][@stdlib/blas/base/ndarray/dcopy]</span><span class="delimiter">: </span><span class="description">copy values from a one-dimensional double-precision floating-point ndarray `x` into a one-dimensional double-precision floating-point ndarray `y`.</span>
- <span class="signature">[`ddot( arrays )`][@stdlib/blas/base/ndarray/ddot]</span><span class="delimiter">: </span><span class="description">calculate the dot product of two one-dimensional double-precision floating-point ndarrays.</span>
- <span class="signature">[`dgemv( arrays )`][@stdlib/blas/base/ndarray/dgemv]</span><span class="delimiter">: </span><span class="description">perform one of the matrix-vector operations `y = alpha*A*x + beta*y` or `y = alpha*A^T*x + beta*y`.</span>
- <span class="signature">[`dger( arrays )`][@stdlib/blas/base/ndarray/dger]</span><span class="delimiter">: </span><span class="description">perform the rank 1 operation `A = alpha*x*y^T + A`.</span>
- <span class="signature">[`dnrm2( arrays )`][@stdlib/blas/base/ndarray/dnrm2]</span><span class="delimiter">: </span><span class="description">compute the L2-norm of a one-dimensional double-precision floating-point ndarray.</span>
- <span class="signature">[`dscal( arrays )`][@stdlib/blas/base/ndarray/dscal]</span><span class="delimiter">: </span><span class="description">multiply a one-dimensional double-precision floating-point ndarray by a scalar constant.</span>
- <span class="signature">[`dsdot( arrays )`][@stdlib/blas/base/ndarray/dsdot]</span><span class="delimiter">: </span><span class="description">calculate the dot product of two one-dimensional single-precision floating-point ndarrays with double-precision accumulation.</span>
Expand All @@ -65,6 +67,7 @@ The namespace exposes the following APIs:
- <span class="signature">[`gaxpy( arrays )`][@stdlib/blas/base/ndarray/gaxpy]</span><span class="delimiter">: </span><span class="description">multiply a one-dimensional ndarray `x` by a constant `alpha` and add the result to a one-dimensional ndarray `y`.</span>
- <span class="signature">[`gcopy( arrays )`][@stdlib/blas/base/ndarray/gcopy]</span><span class="delimiter">: </span><span class="description">copy values from a one-dimensional ndarray `x` into a one-dimensional ndarray `y`.</span>
- <span class="signature">[`gdot( arrays )`][@stdlib/blas/base/ndarray/gdot]</span><span class="delimiter">: </span><span class="description">calculate the dot product of two one-dimensional ndarrays.</span>
- <span class="signature">[`ggemv( arrays )`][@stdlib/blas/base/ndarray/ggemv]</span><span class="delimiter">: </span><span class="description">perform one of the matrix-vector operations `y = alpha*A*x + beta*y` or `y = alpha*A^T*x + beta*y`.</span>
- <span class="signature">[`gnrm2( arrays )`][@stdlib/blas/base/ndarray/gnrm2]</span><span class="delimiter">: </span><span class="description">compute the L2-norm of a one-dimensional ndarray.</span>
- <span class="signature">[`gscal( arrays )`][@stdlib/blas/base/ndarray/gscal]</span><span class="delimiter">: </span><span class="description">multiply a one-dimensional ndarray by a scalar constant.</span>
- <span class="signature">[`gswap( arrays )`][@stdlib/blas/base/ndarray/gswap]</span><span class="delimiter">: </span><span class="description">interchange two one-dimensional ndarrays.</span>
Expand All @@ -78,6 +81,8 @@ The namespace exposes the following APIs:
- <span class="signature">[`scopy( arrays )`][@stdlib/blas/base/ndarray/scopy]</span><span class="delimiter">: </span><span class="description">copy values from a one-dimensional single-precision floating-point ndarray `x` into a one-dimensional single-precision floating-point ndarray `y`.</span>
- <span class="signature">[`sdot( arrays )`][@stdlib/blas/base/ndarray/sdot]</span><span class="delimiter">: </span><span class="description">calculate the dot product of two one-dimensional single-precision floating-point ndarrays.</span>
- <span class="signature">[`sdsdot( arrays )`][@stdlib/blas/base/ndarray/sdsdot]</span><span class="delimiter">: </span><span class="description">calculate the dot product of two one-dimensional single-precision floating-point ndarrays with extended accumulation.</span>
- <span class="signature">[`sgemv( arrays )`][@stdlib/blas/base/ndarray/sgemv]</span><span class="delimiter">: </span><span class="description">perform one of the matrix-vector operations `y = alpha*A*x + beta*y` or `y = alpha*A^T*x + beta*y`.</span>
- <span class="signature">[`sger( arrays )`][@stdlib/blas/base/ndarray/sger]</span><span class="delimiter">: </span><span class="description">perform the rank 1 operation `A = alpha*x*y^T + A`.</span>
- <span class="signature">[`snrm2( arrays )`][@stdlib/blas/base/ndarray/snrm2]</span><span class="delimiter">: </span><span class="description">compute the L2-norm of a one-dimensional single-precision floating-point ndarray.</span>
- <span class="signature">[`sscal( arrays )`][@stdlib/blas/base/ndarray/sscal]</span><span class="delimiter">: </span><span class="description">multiply a one-dimensional single-precision floating-point ndarray by a scalar constant.</span>
- <span class="signature">[`sswap( arrays )`][@stdlib/blas/base/ndarray/sswap]</span><span class="delimiter">: </span><span class="description">interchange two one-dimensional single-precision floating-point ndarrays.</span>
Expand Down Expand Up @@ -148,6 +153,10 @@ console.log( objectKeys( ns ) );

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

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

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

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

[@stdlib/blas/base/ndarray/dscal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/dscal
Expand All @@ -168,6 +177,8 @@ console.log( objectKeys( ns ) );

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

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

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

[@stdlib/blas/base/ndarray/gscal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/gscal
Expand All @@ -194,6 +205,10 @@ console.log( objectKeys( ns ) );

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

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

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

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

[@stdlib/blas/base/ndarray/sscal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/sscal
Expand Down
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 @@ -160,6 +160,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">[`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>
- <span class="signature">[`dxpy( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/dxpy]</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 `y`.</span>
- <span class="signature">[`dxsa( N, alpha, x, strideX )`][@stdlib/blas/ext/base/dxsa]</span><span class="delimiter">: </span><span class="description">subtract a scalar constant from each element in a double-precision floating-point strided array.</span>
Expand Down Expand Up @@ -258,6 +259,7 @@ var o = ns;
- <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>
- <span class="signature">[`gwxsy( N, x, strideX, y, strideY, w, strideW )`][@stdlib/blas/ext/base/gwxsy]</span><span class="delimiter">: </span><span class="description">subtract elements of a strided array `y` from the corresponding elements of a strided array `x` and assign the results to elements in a strided array `w`.</span>
- <span class="signature">[`gxdy( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gxdy]</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 `y`.</span>
- <span class="signature">[`gxmy( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gxmy]</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 `y`.</span>
- <span class="signature">[`gxpy( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gxpy]</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 `y`.</span>
- <span class="signature">[`gxsa( N, alpha, x, strideX )`][@stdlib/blas/ext/base/gxsa]</span><span class="delimiter">: </span><span class="description">subtract a scalar constant from each element in a strided array.</span>
Expand Down Expand Up @@ -343,6 +345,7 @@ var o = ns;
- <span class="signature">[`swax( N, alpha, x, strideX, w, strideW )`][@stdlib/blas/ext/base/swax]</span><span class="delimiter">: </span><span class="description">multiply each element in a single-precision floating-point strided array `x` by a scalar constant and assign the results to elements in a single-precision floating-point strided array `w`.</span>
- <span class="signature">[`swhere( N, condition, strideC, x, strideX, y, strideY, out, strideOut )`][@stdlib/blas/ext/base/swhere]</span><span class="delimiter">: </span><span class="description">take elements from one of two single-precision floating-point strided arrays depending on a condition.</span>
- <span class="signature">[`swxsa( N, alpha, x, strideX, w, strideW )`][@stdlib/blas/ext/base/swxsa]</span><span class="delimiter">: </span><span class="description">subtract a scalar constant from each element in a single-precision floating-point strided array `x` and assign the results to elements in a single-precision floating-point strided array `w`.</span>
- <span class="signature">[`sxdy( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/sxdy]</span><span class="delimiter">: </span><span class="description">divide elements of a single-precision floating-point strided array `x` by the corresponding elements of a single-precision floating-point strided array `y` and assign the results to `y`.</span>
- <span class="signature">[`sxmy( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/sxmy]</span><span class="delimiter">: </span><span class="description">multiply elements of a single-precision floating-point strided array `x` by the corresponding elements of a single-precision floating-point strided array `y` and assign the results to `y`.</span>
- <span class="signature">[`sxpy( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/sxpy]</span><span class="delimiter">: </span><span class="description">add elements of a single-precision floating-point strided array `x` to the corresponding elements of a single-precision floating-point strided array `y` and assign the results to `y`.</span>
- <span class="signature">[`sxsa( N, alpha, x, strideX )`][@stdlib/blas/ext/base/sxsa]</span><span class="delimiter">: </span><span class="description">subtract a scalar constant from each element in a single-precision floating-point strided array.</span>
Expand Down Expand Up @@ -657,6 +660,8 @@ console.log( objectKeys( ns ) );

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

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

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

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

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

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

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

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

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

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

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