Skip to content

docs: update namespace table of contents #12362

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
May 30, 2026
+18 −0
Merged

docs: update namespace table of contents #12362

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/ext/base/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ var o = ns;
- <span class="signature">[`csumkbn( N, x, strideX )`][@stdlib/blas/ext/base/csumkbn]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision complex floating-point strided array elements using an improved Kahan–Babuška algorithm.</span>
- <span class="signature">[`cunitspace( N, start, x, strideX )`][@stdlib/blas/ext/base/cunitspace]</span><span class="delimiter">: </span><span class="description">fill a single-precision complex floating-point strided array with linearly spaced numeric elements which increment by `1` starting from a specified value.</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">[`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">[`czeroTo( N, x, strideX )`][@stdlib/blas/ext/base/czero-to]</span><span class="delimiter">: </span><span class="description">fill a single-precision complex floating-point strided array with linearly spaced numeric elements which increment by `1` starting from zero.</span>
- <span class="signature">[`dapx( N, alpha, x, strideX )`][@stdlib/blas/ext/base/dapx]</span><span class="delimiter">: </span><span class="description">add a scalar constant to each element in a double-precision floating-point strided array.</span>
- <span class="signature">[`dapxsum( N, alpha, x, strideX )`][@stdlib/blas/ext/base/dapxsum]</span><span class="delimiter">: </span><span class="description">add a scalar constant to each double-precision floating-point strided array element and compute the sum.</span>
Expand All @@ -65,6 +66,7 @@ var o = ns;
- <span class="signature">[`dasumpw( N, x, strideX )`][@stdlib/blas/ext/base/dasumpw]</span><span class="delimiter">: </span><span class="description">calculate the sum of absolute values (_L1_ norm) of double-precision floating-point strided array elements using pairwise summation.</span>
- <span class="signature">[`daxpb( N, alpha, beta, x, strideX )`][@stdlib/blas/ext/base/daxpb]</span><span class="delimiter">: </span><span class="description">multiply each element in a double-precision floating-point strided array by a scalar constant and add a scalar constant to each result.</span>
- <span class="signature">[`dcartesianPower( order, N, k, x, strideX, out, LDO )`][@stdlib/blas/ext/base/dcartesian-power]</span><span class="delimiter">: </span><span class="description">compute the Cartesian power for a double-precision floating-point strided array.</span>
- <span class="signature">[`dcartesianProduct( order, M, N, x, strideX, y, strideY, out, LDO )`][@stdlib/blas/ext/base/dcartesian-product]</span><span class="delimiter">: </span><span class="description">compute the Cartesian product for two double-precision floating-point strided arrays.</span>
- <span class="signature">[`dcartesianSquare( order, N, x, strideX, out, LDO )`][@stdlib/blas/ext/base/dcartesian-square]</span><span class="delimiter">: </span><span class="description">compute the Cartesian square for a double-precision floating-point strided array.</span>
- <span class="signature">[`dcircshift( N, k, x, strideX )`][@stdlib/blas/ext/base/dcircshift]</span><span class="delimiter">: </span><span class="description">circularly shift the elements of a double-precision floating-point strided array by a specified number of positions.</span>
- <span class="signature">[`dcusum( N, sum, x, strideX, y, strideY )`][@stdlib/blas/ext/base/dcusum]</span><span class="delimiter">: </span><span class="description">calculate the cumulative sum of double-precision floating-point strided array elements.</span>
Expand Down Expand Up @@ -157,6 +159,7 @@ var o = ns;
- <span class="signature">[`glastIndexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/glast-index-of-row]</span><span class="delimiter">: </span><span class="description">return the index of the last row in an input matrix which has the same elements as a provided search vector.</span>
- <span class="signature">[`glastIndexOf( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/glast-index-of]</span><span class="delimiter">: </span><span class="description">return the last index of a specified search element in a strided array.</span>
- <span class="signature">[`glinspace( N, start, stop, endpoint, x, strideX )`][@stdlib/blas/ext/base/glinspace]</span><span class="delimiter">: </span><span class="description">fill a strided array with linearly spaced values over a specified interval.</span>
- <span class="signature">[`gmskrev( N, x, strideX, mask, strideMask )`][@stdlib/blas/ext/base/gmskrev]</span><span class="delimiter">: </span><span class="description">reverse a strided array in-place according to a mask.</span>
- <span class="signature">[`gnancount( N, x, strideX )`][@stdlib/blas/ext/base/gnancount]</span><span class="delimiter">: </span><span class="description">calculate the number of non-`NaN` elements in a strided array.</span>
- <span class="signature">[`gnannsumkbn( N, x, strideX, out, strideOut )`][@stdlib/blas/ext/base/gnannsumkbn]</span><span class="delimiter">: </span><span class="description">calculate the sum of strided array elements, ignoring `NaN` values and using an improved Kahan–Babuška algorithm.</span>
- <span class="signature">[`gnannsumpw( N, x, strideX, out, strideOut )`][@stdlib/blas/ext/base/gnannsumpw]</span><span class="delimiter">: </span><span class="description">calculate the sum of strided array elements, ignoring `NaN` values and using pairwise summation.</span>
Expand Down Expand Up @@ -244,6 +247,7 @@ var o = ns;
- <span class="signature">[`szeroTo( N, x, strideX )`][@stdlib/blas/ext/base/szero-to]</span><span class="delimiter">: </span><span class="description">fill a single-precision floating-point strided array with linearly spaced numeric elements which increment by `1` starting from zero.</span>
- <span class="signature">[`wasm`][@stdlib/blas/ext/base/wasm]</span><span class="delimiter">: </span><span class="description">extensions to basic linear algebra subprograms (BLAS) compiled to WebAssembly.</span>
- <span class="signature">[`zapx( N, alpha, x, strideX )`][@stdlib/blas/ext/base/zapx]</span><span class="delimiter">: </span><span class="description">add a scalar constant to each element in a double-precision complex floating-point strided array.</span>
- <span class="signature">[`zaxpb( N, alpha, beta, x, strideX )`][@stdlib/blas/ext/base/zaxpb]</span><span class="delimiter">: </span><span class="description">multiply each element in a double-precision complex floating-point strided array by a scalar constant and add a scalar constant to each result.</span>
- <span class="signature">[`zdiff( N, k, x, strideX, N1, prepend, strideP, N2, append, strideA, out, strideOut, workspace, strideW )`][@stdlib/blas/ext/base/zdiff]</span><span class="delimiter">: </span><span class="description">calculate the k-th discrete forward difference of a double-precision complex floating-point strided array.</span>
- <span class="signature">[`zfill( N, alpha, x, strideX )`][@stdlib/blas/ext/base/zfill]</span><span class="delimiter">: </span><span class="description">fill a double-precision complex floating-point strided array with a specified scalar constant.</span>
- <span class="signature">[`zindexOfColumn( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/zindex-of-column]</span><span class="delimiter">: </span><span class="description">return the index of the first column in a double-precision complex floating-point input matrix which has the same elements as a provided search vector.</span>
Expand Down Expand Up @@ -331,6 +335,8 @@ console.log( objectKeys( ns ) );

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

[@stdlib/blas/ext/base/zfill]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zfill
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 @@ -77,6 +77,7 @@ The namespace exposes the following APIs:
- <span class="signature">[`dsumors( arrays )`][@stdlib/blas/ext/base/ndarray/dsumors]</span><span class="delimiter">: </span><span class="description">compute the sum of a one-dimensional double-precision floating-point ndarray using ordinary recursive summation.</span>
- <span class="signature">[`dsumpw( arrays )`][@stdlib/blas/ext/base/ndarray/dsumpw]</span><span class="delimiter">: </span><span class="description">compute the sum of a one-dimensional double-precision floating-point ndarray using pairwise summation.</span>
- <span class="signature">[`dunitspace( arrays )`][@stdlib/blas/ext/base/ndarray/dunitspace]</span><span class="delimiter">: </span><span class="description">fill a one-dimensional double-precision floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from a specified value.</span>
- <span class="signature">[`dxsa( arrays )`][@stdlib/blas/ext/base/ndarray/dxsa]</span><span class="delimiter">: </span><span class="description">subtract a scalar constant from each element in a one-dimensional double-precision floating-point ndarray.</span>
- <span class="signature">[`dzeroTo( arrays )`][@stdlib/blas/ext/base/ndarray/dzero-to]</span><span class="delimiter">: </span><span class="description">fill a one-dimensional double-precision floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from zero.</span>
- <span class="signature">[`gcircshift( arrays )`][@stdlib/blas/ext/base/ndarray/gcircshift]</span><span class="delimiter">: </span><span class="description">circularly shift the elements of a one-dimensional ndarray by a specified number of positions.</span>
- <span class="signature">[`gcusum( arrays )`][@stdlib/blas/ext/base/ndarray/gcusum]</span><span class="delimiter">: </span><span class="description">compute the cumulative sum of a one-dimensional ndarray.</span>
Expand Down Expand Up @@ -106,6 +107,7 @@ The namespace exposes the following APIs:
- <span class="signature">[`gsumpw( arrays )`][@stdlib/blas/ext/base/ndarray/gsumpw]</span><span class="delimiter">: </span><span class="description">compute the sum of all elements in a one-dimensional ndarray using pairwise summation.</span>
- <span class="signature">[`gunitspace( arrays )`][@stdlib/blas/ext/base/ndarray/gunitspace]</span><span class="delimiter">: </span><span class="description">fill a one-dimensional ndarray with linearly spaced numeric elements which increment by `1` starting from a specified value.</span>
- <span class="signature">[`gzeroTo( arrays )`][@stdlib/blas/ext/base/ndarray/gzero-to]</span><span class="delimiter">: </span><span class="description">fill a one-dimensional ndarray with linearly spaced numeric elements which increment by `1` starting from zero.</span>
- <span class="signature">[`saxpb( arrays )`][@stdlib/blas/ext/base/ndarray/saxpb]</span><span class="delimiter">: </span><span class="description">multiply each element in a one-dimensional single-precision floating-point ndarray by a scalar constant and add a scalar constant to each result.</span>
- <span class="signature">[`scircshift( arrays )`][@stdlib/blas/ext/base/ndarray/scircshift]</span><span class="delimiter">: </span><span class="description">circularly shift the elements of a one-dimensional single-precision floating-point ndarray by a specified number of positions.</span>
- <span class="signature">[`scusum( arrays )`][@stdlib/blas/ext/base/ndarray/scusum]</span><span class="delimiter">: </span><span class="description">compute the cumulative sum of a one-dimensional single-precision floating-point ndarray.</span>
- <span class="signature">[`scusumkbn( arrays )`][@stdlib/blas/ext/base/ndarray/scusumkbn]</span><span class="delimiter">: </span><span class="description">compute the cumulative sum of a one-dimensional single-precision floating-point ndarray using an improved Kahan–Babuška algorithm.</span>
Expand Down Expand Up @@ -241,6 +243,8 @@ console.log( objectKeys( ns ) );

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

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

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

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

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

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

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

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