Skip to content

docs: update namespace table of contents #12213

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 20, 2026
+12 −0
Merged

docs: update namespace table of contents #12213

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/blas/base/ndarray/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,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">[`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">[`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>
Expand Down Expand Up @@ -149,6 +150,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/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

[@stdlib/blas/base/ndarray/gswap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/gswap
Expand Down
6 changes: 6 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 @@ -61,6 +61,7 @@ var o = ns;
- <span class="signature">[`dapxsumors( N, alpha, x, strideX )`][@stdlib/blas/ext/base/dapxsumors]</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 using ordinary recursive summation.</span>
- <span class="signature">[`dapxsumpw( N, alpha, x, strideX )`][@stdlib/blas/ext/base/dapxsumpw]</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 using pairwise summation.</span>
- <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">[`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>
Expand Down Expand Up @@ -187,6 +188,7 @@ var o = ns;
- <span class="signature">[`sapxsumors( N, alpha, x, strideX )`][@stdlib/blas/ext/base/sapxsumors]</span><span class="delimiter">: </span><span class="description">add a scalar constant to each single-precision floating-point strided array element and compute the sum using ordinary recursive summation.</span>
- <span class="signature">[`sapxsumpw( N, alpha, x, strideX )`][@stdlib/blas/ext/base/sapxsumpw]</span><span class="delimiter">: </span><span class="description">add a scalar constant to each single-precision floating-point strided array element and compute the sum using pairwise summation.</span>
- <span class="signature">[`sasumpw( N, x, strideX )`][@stdlib/blas/ext/base/sasumpw]</span><span class="delimiter">: </span><span class="description">calculate the sum of absolute values (_L1_ norm) of single-precision floating-point strided array elements using pairwise summation.</span>
- <span class="signature">[`saxpb( N, alpha, beta, x, strideX )`][@stdlib/blas/ext/base/saxpb]</span><span class="delimiter">: </span><span class="description">multiply each element in a single-precision floating-point strided array by a scalar constant and add a scalar constant to each result.</span>
- <span class="signature">[`scartesianPower( order, N, k, x, strideX, out, LDO )`][@stdlib/blas/ext/base/scartesian-power]</span><span class="delimiter">: </span><span class="description">compute the Cartesian power for a single-precision floating-point strided array.</span>
- <span class="signature">[`scartesianSquare( order, N, x, strideX, out, LDO )`][@stdlib/blas/ext/base/scartesian-square]</span><span class="delimiter">: </span><span class="description">compute the Cartesian square for a single-precision floating-point strided array.</span>
- <span class="signature">[`scircshift( N, k, x, strideX )`][@stdlib/blas/ext/base/scircshift]</span><span class="delimiter">: </span><span class="description">circularly shift the elements of a single-precision floating-point strided array by a specified number of positions.</span>
Expand Down Expand Up @@ -332,6 +334,8 @@ console.log( objectKeys( ns ) );

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

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

[@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-square]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dcartesian-square
Expand Down Expand Up @@ -584,6 +588,8 @@ console.log( objectKeys( ns ) );

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

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

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

[@stdlib/blas/ext/base/scartesian-square]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/scartesian-square
Expand Down
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/ndarray/base/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,7 @@ var o = ns;
- <span class="signature">[`minmaxViewBufferIndex( shape, strides, offset )`][@stdlib/ndarray/base/minmax-view-buffer-index]</span><span class="delimiter">: </span><span class="description">compute the minimum and maximum linear indices in an underlying data buffer which are accessible to an array view.</span>
- <span class="signature">[`nansLike( x )`][@stdlib/ndarray/base/nans-like]</span><span class="delimiter">: </span><span class="description">create a NaN-filled ndarray having the same shape and data type as a provided ndarray.</span>
- <span class="signature">[`nans( dtype, shape, order )`][@stdlib/ndarray/base/nans]</span><span class="delimiter">: </span><span class="description">create a NaN-filled ndarray having a specified shape and data type.</span>
- <span class="signature">[`ndarraylike2descriptor( dtype, buffer, shape, strides, offset, order )`][@stdlib/ndarray/base/ndarraylike2descriptor]</span><span class="delimiter">: </span><span class="description">convert an ndarray-like object to an ndarray descriptor.</span>
- <span class="signature">[`ndarraylike2ndarray( x )`][@stdlib/ndarray/base/ndarraylike2ndarray]</span><span class="delimiter">: </span><span class="description">convert an ndarray-like object to an `ndarray`.</span>
- <span class="signature">[`ndarraylike2object( x )`][@stdlib/ndarray/base/ndarraylike2object]</span><span class="delimiter">: </span><span class="description">convert an `ndarray`-like object to an object likely to have the same "shape".</span>
- <span class="signature">[`ndarraylike2scalar( x )`][@stdlib/ndarray/base/ndarraylike2scalar]</span><span class="delimiter">: </span><span class="description">convert an ndarray-like object to a scalar value.</span>
Expand Down Expand Up @@ -507,6 +508,8 @@ console.log( objectKeys( ns ) );

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

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

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

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