Skip to content

docs: update namespace table of contents #13575

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

docs: update namespace table of contents #13575

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
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/assert/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -458,6 +458,7 @@ The remaining namespace utilities are as follows:
- <span class="signature">[`isHexString( value )`][@stdlib/assert/is-hex-string]</span><span class="delimiter">: </span><span class="description">test whether a string contains only hexadecimal digits.</span>
- <span class="signature">[`isInfinite( value )`][@stdlib/assert/is-infinite]</span><span class="delimiter">: </span><span class="description">test if a value is an infinite number.</span>
- <span class="signature">[`isInheritedProperty( value, property )`][@stdlib/assert/is-inherited-property]</span><span class="delimiter">: </span><span class="description">test if an object has an inherited property.</span>
- <span class="signature">[`isInt64( value )`][@stdlib/assert/is-int64]</span><span class="delimiter">: </span><span class="description">test if a value is a 64-bit signed integer.</span>
- <span class="signature">[`isIterableLike( value )`][@stdlib/assert/is-iterable-like]</span><span class="delimiter">: </span><span class="description">test if a value is `iterable`-like.</span>
- <span class="signature">[`isIteratorLike( value )`][@stdlib/assert/is-iterator-like]</span><span class="delimiter">: </span><span class="description">test if a value is `iterator`-like.</span>
- <span class="signature">[`isJSON( value )`][@stdlib/assert/is-json]</span><span class="delimiter">: </span><span class="description">test if a value is a parseable JSON string.</span>
Expand Down Expand Up @@ -693,6 +694,8 @@ console.log( objectKeys( assert ) );

[@stdlib/assert/is-inherited-property]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-inherited-property

[@stdlib/assert/is-int64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-int64

[@stdlib/assert/is-iterable-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-iterable-like

[@stdlib/assert/is-iterator-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-iterator-like
Expand Down
24 changes: 24 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,24 +55,29 @@ 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">[`dgemm( arrays )`][@stdlib/blas/base/ndarray/dgemm]</span><span class="delimiter">: </span><span class="description">perform the matrix-matrix operation `C = alpha*op(A)*op(B) + beta*C`.</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>
- <span class="signature">[`dspr( arrays )`][@stdlib/blas/base/ndarray/dspr]</span><span class="delimiter">: </span><span class="description">perform the symmetric rank 1 operation `A = alpha*x*x^T + A` for a symmetric matrix `A` supplied in packed form.</span>
- <span class="signature">[`dswap( arrays )`][@stdlib/blas/base/ndarray/dswap]</span><span class="delimiter">: </span><span class="description">interchange two one-dimensional double-precision floating-point ndarrays.</span>
- <span class="signature">[`dsyr( arrays )`][@stdlib/blas/base/ndarray/dsyr]</span><span class="delimiter">: </span><span class="description">perform the symmetric rank 1 operation `A = alpha*x*x^T + A`.</span>
- <span class="signature">[`dsyr2( arrays )`][@stdlib/blas/base/ndarray/dsyr2]</span><span class="delimiter">: </span><span class="description">perform the symmetric rank 2 operation `A = alpha*x*y^T + alpha*y*x^T + A`.</span>
- <span class="signature">[`dzasum( arrays )`][@stdlib/blas/base/ndarray/dzasum]</span><span class="delimiter">: </span><span class="description">calculate the sum of absolute values for all elements in a one-dimensional double-precision complex floating-point ndarray.</span>
- <span class="signature">[`dznrm2( arrays )`][@stdlib/blas/base/ndarray/dznrm2]</span><span class="delimiter">: </span><span class="description">compute the L2-norm of a one-dimensional double-precision complex floating-point ndarray.</span>
- <span class="signature">[`gasum( arrays )`][@stdlib/blas/base/ndarray/gasum]</span><span class="delimiter">: </span><span class="description">calculate the sum of absolute values for all elements in a one-dimensional ndarray.</span>
- <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">[`ggemm( arrays )`][@stdlib/blas/base/ndarray/ggemm]</span><span class="delimiter">: </span><span class="description">perform the matrix-matrix operation `C = alpha*op(A)*op(B) + beta*C`.</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">[`gger( arrays )`][@stdlib/blas/base/ndarray/gger]</span><span class="delimiter">: </span><span class="description">perform the rank 1 operation `A = alpha*x*y^T + A`.</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>
- <span class="signature">[`gsyr( arrays )`][@stdlib/blas/base/ndarray/gsyr]</span><span class="delimiter">: </span><span class="description">perform the symmetric rank 1 operation `A = alpha*x*x^T + A`.</span>
- <span class="signature">[`idamax( arrays )`][@stdlib/blas/base/ndarray/idamax]</span><span class="delimiter">: </span><span class="description">find the index of the first element having the maximum absolute value for all elements in a one-dimensional double-precision floating-point ndarray.</span>
- <span class="signature">[`igamax( arrays )`][@stdlib/blas/base/ndarray/igamax]</span><span class="delimiter">: </span><span class="description">find the index of the first element having the maximum absolute value for all elements in a one-dimensional ndarray.</span>
- <span class="signature">[`isamax( arrays )`][@stdlib/blas/base/ndarray/isamax]</span><span class="delimiter">: </span><span class="description">find the index of the first element having the maximum absolute value for all elements in a one-dimensional single-precision floating-point ndarray.</span>
Expand All @@ -83,12 +88,15 @@ 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">[`sgemm( arrays )`][@stdlib/blas/base/ndarray/sgemm]</span><span class="delimiter">: </span><span class="description">perform the matrix-matrix operation `C = alpha*op(A)*op(B) + beta*C`.</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">[`sspr( arrays )`][@stdlib/blas/base/ndarray/sspr]</span><span class="delimiter">: </span><span class="description">perform the symmetric rank 1 operation `A = alpha*x*x^T + A` for a symmetric matrix `A` supplied in packed form.</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>
- <span class="signature">[`ssyr( arrays )`][@stdlib/blas/base/ndarray/ssyr]</span><span class="delimiter">: </span><span class="description">perform the symmetric rank 1 operation `A = alpha*x*x^T + A`.</span>
- <span class="signature">[`ssyr2( arrays )`][@stdlib/blas/base/ndarray/ssyr2]</span><span class="delimiter">: </span><span class="description">perform the symmetric rank 2 operation `A = alpha*x*y^T + alpha*y*x^T + A`.</span>
- <span class="signature">[`zaxpy( arrays )`][@stdlib/blas/base/ndarray/zaxpy]</span><span class="delimiter">: </span><span class="description">multiply a one-dimensional double-precision complex floating-point ndarray `x` by a constant `alpha` and add the result to a one-dimensional double-precision complex floating-point ndarray `y`.</span>
- <span class="signature">[`zcopy( arrays )`][@stdlib/blas/base/ndarray/zcopy]</span><span class="delimiter">: </span><span class="description">copy values from a one-dimensional double-precision complex floating-point ndarray `x` into a one-dimensional double-precision complex floating-point ndarray `y`.</span>
- <span class="signature">[`zdscal( arrays )`][@stdlib/blas/base/ndarray/zdscal]</span><span class="delimiter">: </span><span class="description">multiply a one-dimensional double-precision complex floating-point ndarray by a double-precision floating-point scalar constant.</span>
Expand Down Expand Up @@ -156,6 +164,8 @@ 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/dgemm]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/dgemm

[@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
Expand All @@ -170,6 +180,10 @@ console.log( objectKeys( ns ) );

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

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

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

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

[@stdlib/blas/base/ndarray/dznrm2]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/dznrm2
Expand All @@ -182,6 +196,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/ggemm]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/ggemm

[@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/gger]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/gger
Expand All @@ -192,6 +208,8 @@ console.log( objectKeys( ns ) );

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

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

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

[@stdlib/blas/base/ndarray/igamax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/igamax
Expand All @@ -212,6 +230,8 @@ 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/sgemm]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/sgemm

[@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
Expand All @@ -224,6 +244,10 @@ console.log( objectKeys( ns ) );

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

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

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

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

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