From 02e9ce56cc273f4db076523f506c99919f6de9f2 Mon Sep 17 00:00:00 2001 From: Planeshifter <1913638+Planeshifter@users.noreply.github.com> Date: Wed, 20 May 2026 03:30:32 +0000 Subject: [PATCH] docs: update namespace table of contents Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> --- lib/node_modules/@stdlib/blas/base/ndarray/README.md | 3 +++ lib/node_modules/@stdlib/blas/ext/base/README.md | 6 ++++++ lib/node_modules/@stdlib/ndarray/base/README.md | 3 +++ 3 files changed, 12 insertions(+) diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/README.md b/lib/node_modules/@stdlib/blas/base/ndarray/README.md index 6754ef84bf47..237c85dbb300 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/README.md +++ b/lib/node_modules/@stdlib/blas/base/ndarray/README.md @@ -61,6 +61,7 @@ The namespace exposes the following APIs: - [`gaxpy( arrays )`][@stdlib/blas/base/ndarray/gaxpy]: multiply a one-dimensional ndarray `x` by a constant `alpha` and add the result to a one-dimensional ndarray `y`. - [`gcopy( arrays )`][@stdlib/blas/base/ndarray/gcopy]: copy values from a one-dimensional ndarray `x` into a one-dimensional ndarray `y`. - [`gdot( arrays )`][@stdlib/blas/base/ndarray/gdot]: calculate the dot product of two one-dimensional ndarrays. +- [`gnrm2( arrays )`][@stdlib/blas/base/ndarray/gnrm2]: compute the L2-norm of a one-dimensional ndarray. - [`gscal( arrays )`][@stdlib/blas/base/ndarray/gscal]: multiply a one-dimensional ndarray by a scalar constant. - [`gswap( arrays )`][@stdlib/blas/base/ndarray/gswap]: interchange two one-dimensional ndarrays. - [`sasum( arrays )`][@stdlib/blas/base/ndarray/sasum]: calculate the sum of absolute values for all elements in a one-dimensional single-precision floating-point ndarray. @@ -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 diff --git a/lib/node_modules/@stdlib/blas/ext/base/README.md b/lib/node_modules/@stdlib/blas/ext/base/README.md index 413a562b97fc..118562b85808 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/README.md @@ -61,6 +61,7 @@ var o = ns; - [`dapxsumors( N, alpha, x, strideX )`][@stdlib/blas/ext/base/dapxsumors]: add a scalar constant to each double-precision floating-point strided array element and compute the sum using ordinary recursive summation. - [`dapxsumpw( N, alpha, x, strideX )`][@stdlib/blas/ext/base/dapxsumpw]: add a scalar constant to each double-precision floating-point strided array element and compute the sum using pairwise summation. - [`dasumpw( N, x, strideX )`][@stdlib/blas/ext/base/dasumpw]: calculate the sum of absolute values (_L1_ norm) of double-precision floating-point strided array elements using pairwise summation. +- [`daxpb( N, alpha, beta, x, strideX )`][@stdlib/blas/ext/base/daxpb]: multiply each element in a double-precision floating-point strided array by a scalar constant and add a scalar constant to each result. - [`dcartesianPower( order, N, k, x, strideX, out, LDO )`][@stdlib/blas/ext/base/dcartesian-power]: compute the Cartesian power for a double-precision floating-point strided array. - [`dcartesianSquare( order, N, x, strideX, out, LDO )`][@stdlib/blas/ext/base/dcartesian-square]: compute the Cartesian square for a double-precision floating-point strided array. - [`dcircshift( N, k, x, strideX )`][@stdlib/blas/ext/base/dcircshift]: circularly shift the elements of a double-precision floating-point strided array by a specified number of positions. @@ -187,6 +188,7 @@ var o = ns; - [`sapxsumors( N, alpha, x, strideX )`][@stdlib/blas/ext/base/sapxsumors]: add a scalar constant to each single-precision floating-point strided array element and compute the sum using ordinary recursive summation. - [`sapxsumpw( N, alpha, x, strideX )`][@stdlib/blas/ext/base/sapxsumpw]: add a scalar constant to each single-precision floating-point strided array element and compute the sum using pairwise summation. - [`sasumpw( N, x, strideX )`][@stdlib/blas/ext/base/sasumpw]: calculate the sum of absolute values (_L1_ norm) of single-precision floating-point strided array elements using pairwise summation. +- [`saxpb( N, alpha, beta, x, strideX )`][@stdlib/blas/ext/base/saxpb]: multiply each element in a single-precision floating-point strided array by a scalar constant and add a scalar constant to each result. - [`scartesianPower( order, N, k, x, strideX, out, LDO )`][@stdlib/blas/ext/base/scartesian-power]: compute the Cartesian power for a single-precision floating-point strided array. - [`scartesianSquare( order, N, x, strideX, out, LDO )`][@stdlib/blas/ext/base/scartesian-square]: compute the Cartesian square for a single-precision floating-point strided array. - [`scircshift( N, k, x, strideX )`][@stdlib/blas/ext/base/scircshift]: circularly shift the elements of a single-precision floating-point strided array by a specified number of positions. @@ -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 @@ -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 diff --git a/lib/node_modules/@stdlib/ndarray/base/README.md b/lib/node_modules/@stdlib/ndarray/base/README.md index 866cdaa074d7..7ef8585d23f4 100644 --- a/lib/node_modules/@stdlib/ndarray/base/README.md +++ b/lib/node_modules/@stdlib/ndarray/base/README.md @@ -140,6 +140,7 @@ var o = ns; - [`minmaxViewBufferIndex( shape, strides, offset )`][@stdlib/ndarray/base/minmax-view-buffer-index]: compute the minimum and maximum linear indices in an underlying data buffer which are accessible to an array view. - [`nansLike( x )`][@stdlib/ndarray/base/nans-like]: create a NaN-filled ndarray having the same shape and data type as a provided ndarray. - [`nans( dtype, shape, order )`][@stdlib/ndarray/base/nans]: create a NaN-filled ndarray having a specified shape and data type. +- [`ndarraylike2descriptor( dtype, buffer, shape, strides, offset, order )`][@stdlib/ndarray/base/ndarraylike2descriptor]: convert an ndarray-like object to an ndarray descriptor. - [`ndarraylike2ndarray( x )`][@stdlib/ndarray/base/ndarraylike2ndarray]: convert an ndarray-like object to an `ndarray`. - [`ndarraylike2object( x )`][@stdlib/ndarray/base/ndarraylike2object]: convert an `ndarray`-like object to an object likely to have the same "shape". - [`ndarraylike2scalar( x )`][@stdlib/ndarray/base/ndarraylike2scalar]: convert an ndarray-like object to a scalar value. @@ -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