Skip to content

docs: update namespace table of contents #12416

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
Jun 1, 2026
+40 −1
Merged

docs: update namespace table of contents #12416

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
12 changes: 12 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 @@ -58,6 +58,7 @@ The namespace exposes the following APIs:
- <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">[`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">[`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>
Expand All @@ -66,6 +67,9 @@ The namespace exposes the following APIs:
- <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">[`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>
- <span class="signature">[`sasum( arrays )`][@stdlib/blas/base/ndarray/sasum]</span><span class="delimiter">: </span><span class="description">calculate the sum of absolute values for all elements in a one-dimensional single-precision floating-point ndarray.</span>
- <span class="signature">[`saxpy( arrays )`][@stdlib/blas/base/ndarray/saxpy]</span><span class="delimiter">: </span><span class="description">multiply a one-dimensional single-precision floating-point ndarray `x` by a constant `alpha` and add the result to a one-dimensional single-precision floating-point ndarray `y`.</span>
- <span class="signature">[`scasum( arrays )`][@stdlib/blas/base/ndarray/scasum]</span><span class="delimiter">: </span><span class="description">calculate the sum of absolute values for all elements in a one-dimensional single-precision complex floating-point ndarray.</span>
Expand Down Expand Up @@ -149,6 +153,8 @@ 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/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

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

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

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

[@stdlib/blas/base/ndarray/saxpy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/saxpy
Expand Down
15 changes: 15 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 @@ -83,6 +83,7 @@ var o = ns;
- <span class="signature">[`dlastIndexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/dlast-index-of-row]</span><span class="delimiter">: </span><span class="description">return the index of the last row in a double-precision floating-point input matrix which has the same elements as a provided search vector.</span>
- <span class="signature">[`dlastIndexOf( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/dlast-index-of]</span><span class="delimiter">: </span><span class="description">return the last index of a specified search element in a double-precision floating-point strided array.</span>
- <span class="signature">[`dlinspace( N, start, stop, endpoint, x, strideX )`][@stdlib/blas/ext/base/dlinspace]</span><span class="delimiter">: </span><span class="description">fill a double-precision floating-point strided array with linearly spaced values over a specified interval.</span>
- <span class="signature">[`dmskrev( N, x, strideX, mask, strideMask )`][@stdlib/blas/ext/base/dmskrev]</span><span class="delimiter">: </span><span class="description">reverse a double-precision floating-point strided array in-place according to a mask.</span>
- <span class="signature">[`dnanasum( N, x, strideX )`][@stdlib/blas/ext/base/dnanasum]</span><span class="delimiter">: </span><span class="description">calculate the sum of absolute values (_L1_ norm) of double-precision floating-point strided array elements, ignoring `NaN` values.</span>
- <span class="signature">[`dnanasumors( N, x, strideX )`][@stdlib/blas/ext/base/dnanasumors]</span><span class="delimiter">: </span><span class="description">calculate the sum of absolute values (_L1_ norm) of double-precision floating-point strided array elements, ignoring `NaN` values and using ordinary recursive summation.</span>
- <span class="signature">[`dnancount( N, x, strideX )`][@stdlib/blas/ext/base/dnancount]</span><span class="delimiter">: </span><span class="description">calculate the number of non-`NaN` elements in a double-precision floating-point strided array.</span>
Expand Down Expand Up @@ -137,6 +138,7 @@ var o = ns;
- <span class="signature">[`gapxsumpw( N, alpha, x, strideX )`][@stdlib/blas/ext/base/gapxsumpw]</span><span class="delimiter">: </span><span class="description">add a scalar constant to each strided array element and compute the sum using pairwise summation.</span>
- <span class="signature">[`gasumpw( N, x, strideX )`][@stdlib/blas/ext/base/gasumpw]</span><span class="delimiter">: </span><span class="description">calculate the sum of absolute values (_L1_ norm) of strided array elements using pairwise summation.</span>
- <span class="signature">[`gaxpb( N, alpha, beta, x, strideX )`][@stdlib/blas/ext/base/gaxpb]</span><span class="delimiter">: </span><span class="description">multiply each element in a strided array by a scalar constant and add a scalar constant to each result.</span>
- <span class="signature">[`gaxpby( N, alpha, x, strideX, beta, y, strideY )`][@stdlib/blas/ext/base/gaxpby]</span><span class="delimiter">: </span><span class="description">multiply a strided array `x` by a constant and add the result to a strided array `y` multiplied by a constant.</span>
- <span class="signature">[`gcartesianPower( order, N, k, x, strideX, out, LDO )`][@stdlib/blas/ext/base/gcartesian-power]</span><span class="delimiter">: </span><span class="description">compute the Cartesian power for a strided array.</span>
- <span class="signature">[`gcartesianSquare( order, N, x, strideX, out, LDO )`][@stdlib/blas/ext/base/gcartesian-square]</span><span class="delimiter">: </span><span class="description">compute the Cartesian square for a strided array.</span>
- <span class="signature">[`gcircshift( N, k, x, strideX )`][@stdlib/blas/ext/base/gcircshift]</span><span class="delimiter">: </span><span class="description">circularly shift the elements of a strided array by a specified number of positions.</span>
Expand Down Expand Up @@ -188,6 +190,8 @@ var o = ns;
- <span class="signature">[`gunitspace( N, start, x, strideX )`][@stdlib/blas/ext/base/gunitspace]</span><span class="delimiter">: </span><span class="description">fill a strided array with linearly spaced numeric elements which increment by `1` starting from a specified value.</span>
- <span class="signature">[`gvander( order, mode, M, N, x, strideX, out, ldo )`][@stdlib/blas/ext/base/gvander]</span><span class="delimiter">: </span><span class="description">generate a Vandermonde matrix.</span>
- <span class="signature">[`gwhere( N, condition, strideC, x, strideX, y, strideY, out, strideOut )`][@stdlib/blas/ext/base/gwhere]</span><span class="delimiter">: </span><span class="description">take elements from one of two strided arrays depending on a condition.</span>
- <span class="signature">[`gwxsa( N, alpha, x, strideX, y, strideY )`][@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 `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>
- <span class="signature">[`gzeroTo( N, x, strideX )`][@stdlib/blas/ext/base/gzero-to]</span><span class="delimiter">: </span><span class="description">fill a strided array with linearly spaced numeric elements which increment by `1` starting from zero.</span>
- <span class="signature">[`ndarray`][@stdlib/blas/ext/base/ndarray]</span><span class="delimiter">: </span><span class="description">base ndarray extended BLAS functions.</span>
Expand Down Expand Up @@ -222,6 +226,7 @@ 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">[`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">[`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">[`smskrev( N, x, strideX, mask, strideMask )`][@stdlib/blas/ext/base/smskrev]</span><span class="delimiter">: </span><span class="description">reverse a single-precision floating-point strided array in-place according to a mask.</span>
- <span class="signature">[`snancount( N, x, strideX )`][@stdlib/blas/ext/base/snancount]</span><span class="delimiter">: </span><span class="description">calculate the number of non-`NaN` elements in a single-precision floating-point strided array.</span>
- <span class="signature">[`snansum( N, x, strideX )`][@stdlib/blas/ext/base/snansum]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision floating-point strided array elements, ignoring `NaN` values.</span>
- <span class="signature">[`snansumkbn( N, x, strideX )`][@stdlib/blas/ext/base/snansumkbn]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision floating-point strided array elements, ignoring `NaN` values and using an improved Kahan–Babuška algorithm.</span>
Expand Down Expand Up @@ -394,6 +399,8 @@ console.log( objectKeys( ns ) );

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

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

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

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

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

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

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

[@stdlib/blas/ext/base/gcartesian-square]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gcartesian-square
Expand Down Expand Up @@ -604,6 +613,10 @@ console.log( objectKeys( ns ) );

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

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

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

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

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

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

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

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