From 5d0e5c92e38a58d0ae3d0777e6d93fbff12da0c3 Mon Sep 17 00:00:00 2001 From: Planeshifter <1913638+Planeshifter@users.noreply.github.com> Date: Thu, 7 May 2026 03:30:21 +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/README.md | 3 +++ lib/node_modules/@stdlib/ndarray/base/README.md | 9 +++++++++ lib/node_modules/@stdlib/stats/strided/README.md | 2 +- 5 files changed, 22 insertions(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/README.md b/lib/node_modules/@stdlib/blas/base/ndarray/README.md index d1d46bf7beb9..5ebf166bfcf5 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/README.md +++ b/lib/node_modules/@stdlib/blas/base/ndarray/README.md @@ -69,6 +69,7 @@ The namespace exposes the following APIs: - [`sswap( arrays )`][@stdlib/blas/base/ndarray/sswap]: interchange two one-dimensional single-precision floating-point ndarrays. - [`zaxpy( arrays )`][@stdlib/blas/base/ndarray/zaxpy]: 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`. - [`zcopy( arrays )`][@stdlib/blas/base/ndarray/zcopy]: copy values from a one-dimensional double-precision complex floating-point ndarray `x` into a one-dimensional double-precision complex floating-point ndarray `y`. +- [`zscal( arrays )`][@stdlib/blas/base/ndarray/zscal]: multiply a one-dimensional double-precision complex floating-point ndarray by a scalar constant. - [`zswap( arrays )`][@stdlib/blas/base/ndarray/zswap]: interchange two one-dimensional double-precision complex floating-point ndarrays. @@ -160,6 +161,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/base/ndarray/zcopy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/zcopy +[@stdlib/blas/base/ndarray/zscal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/zscal + [@stdlib/blas/base/ndarray/zswap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/zswap diff --git a/lib/node_modules/@stdlib/blas/ext/base/README.md b/lib/node_modules/@stdlib/blas/ext/base/README.md index 4807323fd696..dbda21d1e06a 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/README.md @@ -114,6 +114,7 @@ var o = ns; - [`dsumpw( N, x, strideX )`][@stdlib/blas/ext/base/dsumpw]: calculate the sum of double-precision floating-point strided array elements using pairwise summation. - [`dunitspace( N, start, x, strideX )`][@stdlib/blas/ext/base/dunitspace]: fill a double-precision floating-point strided array with linearly spaced numeric elements which increment by `1` starting from a specified value. - [`dvander( order, mode, M, N, x, strideX, out, ldo )`][@stdlib/blas/ext/base/dvander]: generate a double-precision floating-point Vandermonde matrix. +- [`dwhere( N, condition, strideC, x, strideX, y, strideY, out, strideOut )`][@stdlib/blas/ext/base/dwhere]: take elements from one of two double-precision floating-point strided arrays depending on a condition. - [`dzeroTo( N, x, strideX )`][@stdlib/blas/ext/base/dzero-to]: fill a double-precision floating-point strided array with linearly spaced numeric elements which increment by `1` starting from zero. - [`gapx( N, alpha, x, strideX )`][@stdlib/blas/ext/base/gapx]: add a scalar constant to each element in a strided array. - [`gapxsum( N, alpha, x, strideX )`][@stdlib/blas/ext/base/gapxsum]: add a scalar constant to each strided array element and compute the sum. @@ -123,6 +124,7 @@ var o = ns; - [`gapxsumpw( N, alpha, x, strideX )`][@stdlib/blas/ext/base/gapxsumpw]: add a scalar constant to each strided array element and compute the sum using pairwise summation. - [`gasumpw( N, x, strideX )`][@stdlib/blas/ext/base/gasumpw]: calculate the sum of absolute values (_L1_ norm) of strided array elements using pairwise summation. - [`gcartesianPower( order, N, k, x, strideX, out, LDO )`][@stdlib/blas/ext/base/gcartesian-power]: compute the Cartesian power for a strided array. +- [`gcartesianSquare( order, N, x, strideX, out, LDO )`][@stdlib/blas/ext/base/gcartesian-square]: compute the Cartesian square for a strided array. - [`gcircshift( N, k, x, strideX )`][@stdlib/blas/ext/base/gcircshift]: circularly shift the elements of a strided array by a specified number of positions. - [`gconjoin( N, prefix, suffix, conjunction, oxfordComma, x, strideX )`][@stdlib/blas/ext/base/gconjoin]: return a string created by joining strided array elements into a human-readable list using a conjunction. - [`gcusum( N, sum, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gcusum]: calculate the cumulative sum of strided array elements. @@ -423,6 +425,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/dvander]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dvander +[@stdlib/blas/ext/base/dwhere]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dwhere + [@stdlib/blas/ext/base/dzero-to]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dzero-to [@stdlib/blas/ext/base/gapx]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gapx @@ -441,6 +445,8 @@ console.log( objectKeys( ns ) ); [@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 + [@stdlib/blas/ext/base/gcircshift]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gcircshift [@stdlib/blas/ext/base/gconjoin]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gconjoin diff --git a/lib/node_modules/@stdlib/ndarray/README.md b/lib/node_modules/@stdlib/ndarray/README.md index 520c0b4b5262..1b19b303f5e4 100644 --- a/lib/node_modules/@stdlib/ndarray/README.md +++ b/lib/node_modules/@stdlib/ndarray/README.md @@ -118,6 +118,7 @@ The namespace exports the following functions to manipulate multidimensional arr - [`toFlippedlr( x )`][@stdlib/ndarray/to-flippedlr]: return a new `ndarray` where the order of elements along the last dimension of an input `ndarray` is reversed. - [`toFlippedud( x )`][@stdlib/ndarray/to-flippedud]: return a new `ndarray` where the order of elements along the second-to-last dimension of an input `ndarray` is reversed. - [`toReversedDimension( x[, options] )`][@stdlib/ndarray/to-reversed-dimension]: return a new ndarray where the order of elements of an input ndarray along a specified dimension is reversed. +- [`toReversedDimensions( x, dims )`][@stdlib/ndarray/to-reversed-dimensions]: return a new `ndarray` where the order of elements of an input `ndarray` along specified dimensions is reversed. - [`toReversed( x )`][@stdlib/ndarray/to-reversed]: return a new `ndarray` where the order of elements of an input `ndarray` is reversed along each dimension. - [`toRot180( x[, options] )`][@stdlib/ndarray/to-rot180]: return a new `ndarray` where an input `ndarray` is rotated `180` degrees in a specified plane. - [`toRot90( x[, options] )`][@stdlib/ndarray/to-rot90]: return a new `ndarray` where an input `ndarray` is rotated `90` degrees in a specified plane. @@ -522,6 +523,8 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/to-reversed-dimension]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-reversed-dimension +[@stdlib/ndarray/to-reversed-dimensions]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-reversed-dimensions + [@stdlib/ndarray/to-reversed]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-reversed [@stdlib/ndarray/to-rot180]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-rot180 diff --git a/lib/node_modules/@stdlib/ndarray/base/README.md b/lib/node_modules/@stdlib/ndarray/base/README.md index 37b33e50e365..543b4c4b0a5d 100644 --- a/lib/node_modules/@stdlib/ndarray/base/README.md +++ b/lib/node_modules/@stdlib/ndarray/base/README.md @@ -75,6 +75,7 @@ var o = ns; - [`char2dtype( [ch] )`][@stdlib/ndarray/base/char2dtype]: return the data type string associated with a provided single letter character abbreviation. - [`clampIndex( idx, max )`][@stdlib/ndarray/base/clamp-index]: restrict an index to the interval `[0,max]`. - [`complementShape( shape, dims )`][@stdlib/ndarray/base/complement-shape]: return the shape defined by the dimensions which are not included in a list of dimensions. +- [`consensusOrder( strides )`][@stdlib/ndarray/base/consensus-order]: resolve the most common underlying storage layout. - [`copy( x )`][@stdlib/ndarray/base/copy]: copy an input ndarray to a new ndarray having the same shape and data type. - [`countFalsy( arrays )`][@stdlib/ndarray/base/count-falsy]: count the number of falsy elements in an ndarray. - [`countIf( arrays, predicate[, thisArg] )`][@stdlib/ndarray/base/count-if]: count the number of elements in an ndarray which pass a test implemented by a predicate function. @@ -158,6 +159,7 @@ var o = ns; - [`ones( dtype, shape, order )`][@stdlib/ndarray/base/ones]: create a ones-filled ndarray having a specified shape and data type. - [`order( x )`][@stdlib/ndarray/base/order]: return the layout order of a provided ndarray. - [`outputDataType( dtypes, policy )`][@stdlib/ndarray/base/output-dtype]: resolve the output ndarray data type from a list of input ndarray data types. +- [`outputOrder( arrays )`][@stdlib/ndarray/base/output-order]: resolves the order (i.e. memory layout) of an output ndarray according to a list of input ndarrays. - [`outputPolicyEnum2Str( policy )`][@stdlib/ndarray/base/output-policy-enum2str]: return the policy string associated with an output ndarray data type policy enumeration constant. - [`outputPolicyResolveEnum( policy )`][@stdlib/ndarray/base/output-policy-resolve-enum]: return the enumeration constant associated with a supported ndarray data type policy value. - [`outputPolicyResolveStr( dtype )`][@stdlib/ndarray/base/output-policy-resolve-str]: return the policy string associated with a supported ndarray data type policy value. @@ -212,6 +214,7 @@ var o = ns; - [`toFlippedud( x )`][@stdlib/ndarray/base/to-flippedud]: return a new ndarray where the order of elements along the second-to-last dimension of an input ndarray is reversed. - [`toNormalizedIndices( indices, max )`][@stdlib/ndarray/base/to-normalized-indices]: normalize a list of indices to the interval `[0,max]`. - [`toReversedDimension( x, dim )`][@stdlib/ndarray/base/to-reversed-dimension]: return a new ndarray where the order of elements of an input ndarray along a specified dimension is reversed. +- [`toReversedDimensions( x, dims )`][@stdlib/ndarray/base/to-reversed-dimensions]: return a new ndarray where the order of elements of an input ndarray along specified dimensions is reversed. - [`toReversed( x )`][@stdlib/ndarray/base/to-reversed]: return a new ndarray where the order of elements of an input ndarray is reversed along each dimension. - [`toRot180( x, dims )`][@stdlib/ndarray/base/to-rot180]: return a new ndarray where an ndarray is rotated 180 degrees in a specified plane. - [`toRot90( x, dims, k )`][@stdlib/ndarray/base/to-rot90]: return a new ndarray where an ndarray is rotated 90 degrees in a specified plane. @@ -369,6 +372,8 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/base/complement-shape]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/complement-shape +[@stdlib/ndarray/base/consensus-order]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/consensus-order + [@stdlib/ndarray/base/copy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/copy [@stdlib/ndarray/base/count-falsy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/count-falsy @@ -535,6 +540,8 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/base/output-dtype]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/output-dtype +[@stdlib/ndarray/base/output-order]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/output-order + [@stdlib/ndarray/base/output-policy-enum2str]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/output-policy-enum2str [@stdlib/ndarray/base/output-policy-resolve-enum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/output-policy-resolve-enum @@ -643,6 +650,8 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/base/to-reversed-dimension]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/to-reversed-dimension +[@stdlib/ndarray/base/to-reversed-dimensions]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/to-reversed-dimensions + [@stdlib/ndarray/base/to-reversed]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/to-reversed [@stdlib/ndarray/base/to-rot180]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/to-rot180 diff --git a/lib/node_modules/@stdlib/stats/strided/README.md b/lib/node_modules/@stdlib/stats/strided/README.md index 1ef20a14f277..153e2ce1551a 100644 --- a/lib/node_modules/@stdlib/stats/strided/README.md +++ b/lib/node_modules/@stdlib/stats/strided/README.md @@ -108,7 +108,7 @@ The namespace exports the following: - [`dnanmskminabs( N, x, strideX, mask, strideMask )`][@stdlib/stats/strided/dnanmskminabs]: calculate the minimum absolute value of a double-precision floating-point strided array according to a mask, ignoring `NaN` values. - [`dnanmskrange( N, x, strideX, mask, strideMask )`][@stdlib/stats/strided/dnanmskrange]: calculate the range of a double-precision floating-point strided array according to a mask, ignoring `NaN` values. - [`dnanrange( N, x, strideX )`][@stdlib/stats/strided/dnanrange]: calculate the range of a double-precision floating-point strided array, ignoring `NaN` values. -- [`dnanrangeabs( N, \*X, strideX )`][@stdlib/stats/strided/dnanrangeabs]: compute the range of absolute values of a double-precision floating-point strided array, ignoring `NaN` values. +- [`dnanrangeabs( N, x, strideX )`][@stdlib/stats/strided/dnanrangeabs]: compute the range of absolute values of a double-precision floating-point strided array, ignoring `NaN` values. - [`dnanstdev( N, correction, x, strideX )`][@stdlib/stats/strided/dnanstdev]: calculate the standard deviation of a double-precision floating-point strided array ignoring `NaN` values. - [`dnanstdevch( N, correction, x, strideX )`][@stdlib/stats/strided/dnanstdevch]: calculate the standard deviation of a double-precision floating-point strided array ignoring `NaN` values and using a one-pass trial mean algorithm. - [`dnanstdevpn( N, correction, x, strideX )`][@stdlib/stats/strided/dnanstdevpn]: calculate the standard deviation of a double-precision floating-point strided array, ignoring `NaN` values and using a two-pass algorithm.