From dcfdd95505b7491dee02981d990820e47a7d96bc Mon Sep 17 00:00:00 2001 From: Planeshifter <1913638+Planeshifter@users.noreply.github.com> Date: Mon, 4 May 2026 03:29:49 +0000 Subject: [PATCH] docs: update namespace table of contents Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> --- .../@stdlib/blas/base/ndarray/README.md | 6 +++++ .../@stdlib/blas/ext/base/README.md | 3 +++ lib/node_modules/@stdlib/ndarray/README.md | 27 ++++++++++++++----- .../@stdlib/ndarray/base/README.md | 9 +++++++ .../@stdlib/stats/strided/README.md | 6 +++++ 5 files changed, 45 insertions(+), 6 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/README.md b/lib/node_modules/@stdlib/blas/base/ndarray/README.md index d26c591d806e..44d8438a1125 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/README.md +++ b/lib/node_modules/@stdlib/blas/base/ndarray/README.md @@ -47,6 +47,7 @@ The namespace exposes the following APIs: - [`caxpy( arrays )`][@stdlib/blas/base/ndarray/caxpy]: multiply a one-dimensional single-precision complex floating-point ndarray `x` by a constant `alpha` and add the result to a one-dimensional single-precision complex floating-point ndarray `y`. - [`ccopy( arrays )`][@stdlib/blas/base/ndarray/ccopy]: copy values from a one-dimensional single-precision complex floating-point ndarray `x` into a one-dimensional single-precision complex floating-point ndarray `y`. +- [`cswap( arrays )`][@stdlib/blas/base/ndarray/cswap]: interchange two one-dimensional complex single-precision floating-point ndarrays. - [`dasum( arrays )`][@stdlib/blas/base/ndarray/dasum]: calculate the sum of absolute values for all elements in a one-dimensional double-precision floating-point ndarray. - [`daxpy( arrays )`][@stdlib/blas/base/ndarray/daxpy]: multiply a one-dimensional double-precision floating-point ndarray `x` by a constant `alpha` and add the result to a one-dimensional double-precision floating-point ndarray `y`. - [`dcopy( arrays )`][@stdlib/blas/base/ndarray/dcopy]: copy values from a one-dimensional double-precision floating-point ndarray `x` into a one-dimensional double-precision floating-point ndarray `y`. @@ -64,6 +65,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`. +- [`zswap( arrays )`][@stdlib/blas/base/ndarray/zswap]: interchange two one-dimensional complex double-precision floating-point ndarrays. @@ -110,6 +112,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/base/ndarray/ccopy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/ccopy +[@stdlib/blas/base/ndarray/cswap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/cswap + [@stdlib/blas/base/ndarray/dasum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/dasum [@stdlib/blas/base/ndarray/daxpy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/daxpy @@ -144,6 +148,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/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 a7d7fce6f882..301b1c3b1799 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/README.md @@ -57,6 +57,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. +- [`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. - [`dcusum( N, sum, x, strideX, y, strideY )`][@stdlib/blas/ext/base/dcusum]: calculate the cumulative sum of double-precision floating-point strided array elements. @@ -305,6 +306,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/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 [@stdlib/blas/ext/base/dcircshift]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dcircshift diff --git a/lib/node_modules/@stdlib/ndarray/README.md b/lib/node_modules/@stdlib/ndarray/README.md index 21202a959e0e..a30da04f3ee3 100644 --- a/lib/node_modules/@stdlib/ndarray/README.md +++ b/lib/node_modules/@stdlib/ndarray/README.md @@ -80,6 +80,7 @@ The namespace exports the following functions to manipulate multidimensional arr - [`colcat( arrays )`][@stdlib/ndarray/colcat]: concatenate a list of one-dimensional or two-dimensional ndarrays as columns. - [`concat( arrays[, options] )`][@stdlib/ndarray/concat]: concatenate a list of ndarrays along a specified ndarray dimension. - [`concat1d( ...arrays )`][@stdlib/ndarray/concat1d]: return a one-dimensional ndarray formed by concatenating provided input arguments. +- [`diagonal( x[, options] )`][@stdlib/ndarray/diagonal]: return a **read-only** view of the diagonal of a matrix (or stack of matrices). - [`fillBy( x, fcn[, thisArg] )`][@stdlib/ndarray/fill-by]: fill an input ndarray according to a callback function. - [`fillSlice( x, value, ...s[, options] )`][@stdlib/ndarray/fill-slice]: fill an input `ndarray` view with a specified value. - [`fill( x, value )`][@stdlib/ndarray/fill]: fill an input `ndarray` with a specified value. @@ -98,6 +99,7 @@ The namespace exports the following functions to manipulate multidimensional arr - [`push( x, ...values )`][@stdlib/ndarray/push]: return a one-dimensional ndarray formed by appending provided scalar values to a one-dimensional input ndarray. - [`removeSingletonDimensions( x )`][@stdlib/ndarray/remove-singleton-dimensions]: return a read-only view of an input ndarray with singleton dimensions removed. - [`reverseDimension( x, dim )`][@stdlib/ndarray/reverse-dimension]: return a **read-only** view of an input `ndarray` in which the order of elements along a specified dimension is reversed. +- [`reverseDimensions( x, dims )`][@stdlib/ndarray/reverse-dimensions]: return a **read-only** view of an input `ndarray` in which the order of elements along specified dimensions is reversed. - [`reverse( x )`][@stdlib/ndarray/reverse]: return a **read-only** view of an input `ndarray` in which the order of elements along each dimension is reversed. - [`rot180( x[, options] )`][@stdlib/ndarray/rot180]: return a **read-only** view of an input ndarray rotated `180` degrees in a specified plane. - [`rot90( x[, options] )`][@stdlib/ndarray/rot90]: return a **read-only** view of an input ndarray rotated `90` degrees in a specified plane. @@ -121,6 +123,8 @@ The namespace exports the following functions to manipulate multidimensional arr - [`toRot90( x[, options] )`][@stdlib/ndarray/to-rot90]: return a new `ndarray` where an input `ndarray` is rotated `90` degrees in a specified plane. - [`toRotl90( x, k )`][@stdlib/ndarray/to-rotl90]: return a new `ndarray` where a matrix (or a stack of matrices) is rotated 90 degrees counterclockwise. - [`toRotr90( x, k )`][@stdlib/ndarray/to-rotr90]: return a new `ndarray` where a matrix (or a stack of matrices) is rotated 90 degrees clockwise. +- [`toUnflattened( x, dim, sizes )`][@stdlib/ndarray/to-unflattened]: return a new `ndarray` in which a specified dimension of an input `ndarray` is expanded over multiple dimensions. +- [`unflatten( x, dim, sizes )`][@stdlib/ndarray/unflatten]: return a read-only view of an input ndarray in which a specified dimension is expanded over multiple dimensions. - [`unshift( x, ...values )`][@stdlib/ndarray/unshift]: return a one-dimensional ndarray formed by prepending provided scalar values to a one-dimensional input ndarray. - [`vconcat( arrays )`][@stdlib/ndarray/vconcat]: concatenate a list of ndarrays along the second-to-last dimension. - [`ndarrayWith( x, indices, value )`][@stdlib/ndarray/with]: return a new ndarray with the element at a specified index replaced by a provided value. @@ -191,9 +195,11 @@ The namespace exports the following functions to index multidimensional arrays:
- [`at( x[, ...indices] )`][@stdlib/ndarray/at]: return an `ndarray` element. +- [`first( x[, options] )`][@stdlib/ndarray/first]: return a read-only view of the first element (or subarray) along one or more `ndarray` dimensions. - [`ind2sub( shape, idx[, options] )`][@stdlib/ndarray/ind2sub]: convert a linear index to an array of subscripts. - [`indexModes()`][@stdlib/ndarray/index-modes]: list of ndarray index modes. - [`ndindex( x[, options] )`][@stdlib/ndarray/index]: ndarray index constructor. +- [`last( x[, options] )`][@stdlib/ndarray/last]: return a read-only view of the last element (or subarray) along one or more `ndarray` dimensions. - [`sub2ind( shape, ...subscripts[, options] )`][@stdlib/ndarray/sub2ind]: convert subscripts to a linear index.
@@ -208,6 +214,7 @@ The namespace exports the following functions to convert multidimensional arrays
+- [`ndarraylike2scalar( x )`][@stdlib/ndarray/ndarraylike2scalar]: convert an ndarray-like object to a scalar value. - [`ndarray2array( x )`][@stdlib/ndarray/to-array]: convert an ndarray to a generic array. - [`ndarray2json( x )`][@stdlib/ndarray/to-json]: serialize an ndarray as a JSON object. - [`ndarray2localeString( x[, locales[, options]] )`][@stdlib/ndarray/to-locale-string]: serialize an ndarray as a locale-aware string. @@ -268,9 +275,7 @@ The namespace contains the following multidimensional array utility functions: - [`defaults()`][@stdlib/ndarray/defaults]: default ndarray settings. - [`dispatch( fcns, types, data, nargs, nin, nout )`][@stdlib/ndarray/dispatch]: create an ndarray function interface which performs multiple dispatch. - [`forEach( x, fcn[, thisArg] )`][@stdlib/ndarray/for-each]: invoke a callback function once for each ndarray element. -- [`ndarraylike2scalar( x )`][@stdlib/ndarray/ndarraylike2scalar]: convert an ndarray-like object to a scalar value. - [`orders()`][@stdlib/ndarray/orders]: list of ndarray orders. -- [`unflatten( x, dim, sizes )`][@stdlib/ndarray/unflatten]: return a read-only view of an input ndarray in which a specified dimension is expanded over multiple dimensions.
@@ -319,12 +324,8 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/for-each]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/for-each -[@stdlib/ndarray/ndarraylike2scalar]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ndarraylike2scalar - [@stdlib/ndarray/orders]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/orders -[@stdlib/ndarray/unflatten]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/unflatten - [@stdlib/ndarray/base]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base [@stdlib/ndarray/iter]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter @@ -353,6 +354,8 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/same-kind-casts]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/same-kind-casts +[@stdlib/ndarray/ndarraylike2scalar]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ndarraylike2scalar + [@stdlib/ndarray/to-array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-array [@stdlib/ndarray/to-json]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-json @@ -363,12 +366,16 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/at]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/at +[@stdlib/ndarray/first]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/first + [@stdlib/ndarray/ind2sub]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub [@stdlib/ndarray/index-modes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/index-modes [@stdlib/ndarray/index]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/index +[@stdlib/ndarray/last]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/last + [@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/sub2ind [@stdlib/ndarray/data-buffer]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/data-buffer @@ -439,6 +446,8 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/concat1d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/concat1d +[@stdlib/ndarray/diagonal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/diagonal + [@stdlib/ndarray/fill-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/fill-by [@stdlib/ndarray/fill-slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/fill-slice @@ -475,6 +484,8 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/reverse-dimension]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/reverse-dimension +[@stdlib/ndarray/reverse-dimensions]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/reverse-dimensions + [@stdlib/ndarray/reverse]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/reverse [@stdlib/ndarray/rot180]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/rot180 @@ -521,6 +532,10 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/to-rotr90]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-rotr90 +[@stdlib/ndarray/to-unflattened]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-unflattened + +[@stdlib/ndarray/unflatten]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/unflatten + [@stdlib/ndarray/unshift]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/unshift [@stdlib/ndarray/vconcat]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vconcat diff --git a/lib/node_modules/@stdlib/ndarray/base/README.md b/lib/node_modules/@stdlib/ndarray/base/README.md index 97b83edcc42b..37b33e50e365 100644 --- a/lib/node_modules/@stdlib/ndarray/base/README.md +++ b/lib/node_modules/@stdlib/ndarray/base/README.md @@ -81,6 +81,7 @@ var o = ns; - [`countTruthy( arrays )`][@stdlib/ndarray/base/count-truthy]: count the number of truthy elements in an ndarray. - [`ndarray( dtype, buffer, shape, strides, offset, order )`][@stdlib/ndarray/base/ctor]: create a multidimensional array. - [`data( x )`][@stdlib/ndarray/base/data-buffer]: return the underlying data buffer of a provided ndarray. +- [`diagonal( x, dims, k, writable )`][@stdlib/ndarray/base/diagonal]: return a view of the diagonal of a matrix (or stack of matrices). - [`dtypeAlignment( [dtype] )`][@stdlib/ndarray/base/dtype-alignment]: return the alignment (in bytes) for an underlying array data type. - [`dtypeChar( [dtype] )`][@stdlib/ndarray/base/dtype-char]: return the single letter abbreviation for an underlying array data type. - [`dtypeChars( [kind] )`][@stdlib/ndarray/base/dtype-chars]: list of ndarray data type single letter character abbreviations. @@ -104,6 +105,7 @@ var o = ns; - [`expandDimensions( x, dim, writable )`][@stdlib/ndarray/base/expand-dimensions]: expand the shape of an array by inserting a new dimension of size one at a specified dimension index. - [`falses( dtype, shape, order )`][@stdlib/ndarray/base/falses]: create an ndarray filled with `false` values and having a specified shape and data type. - [`fillBy( x, fcn[, thisArg] )`][@stdlib/ndarray/base/fill-by]: fill an input ndarray according to a callback function. +- [`fillDiagonal( x, value, dims, k )`][@stdlib/ndarray/base/fill-diagonal]: fill a specified diagonal of a matrix (or stack of matrices) with a scalar value. - [`fill( x, value )`][@stdlib/ndarray/base/fill]: fill an input ndarray with a specified value. - [`find( arrays, predicate[, thisArg] )`][@stdlib/ndarray/base/find]: return the first element in an ndarray which passes a test implemented by a predicate function. - [`flag( x, name )`][@stdlib/ndarray/base/flag]: return a specified flag for a provided ndarray. @@ -173,6 +175,7 @@ var o = ns; - [`reinterpretComplex64( x )`][@stdlib/ndarray/base/reinterpret-complex64]: reinterpret a single-precision complex floating-point ndarray as a real-valued single-precision floating-point ndarray containing interleaved real and imaginary components. - [`removeSingletonDimensions( x, writable )`][@stdlib/ndarray/base/remove-singleton-dimensions]: remove singleton dimensions. - [`reverseDimension( x, dim, writable )`][@stdlib/ndarray/base/reverse-dimension]: return a view of an input ndarray in which the order of elements along a specified dimension is reversed. +- [`reverseDimensions( x, dims, writable )`][@stdlib/ndarray/base/reverse-dimensions]: return a view of an input ndarray in which the order of elements along specified dimensions is reversed. - [`reverse( x, writable )`][@stdlib/ndarray/base/reverse]: return a view of an input ndarray in which the order of elements along each dimension is reversed. - [`rot180( x, dims, writable )`][@stdlib/ndarray/base/rot180]: rotate an ndarray 180 degrees in a specified plane. - [`rot90( x, dims, k, writable )`][@stdlib/ndarray/base/rot90]: rotate an ndarray 90 degrees in a specified plane. @@ -378,6 +381,8 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/base/data-buffer]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/data-buffer +[@stdlib/ndarray/base/diagonal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/diagonal + [@stdlib/ndarray/base/dtype-alignment]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/dtype-alignment [@stdlib/ndarray/base/dtype-char]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/dtype-char @@ -424,6 +429,8 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/base/fill-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/fill-by +[@stdlib/ndarray/base/fill-diagonal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/fill-diagonal + [@stdlib/ndarray/base/fill]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/fill [@stdlib/ndarray/base/find]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/find @@ -562,6 +569,8 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/base/reverse-dimension]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/reverse-dimension +[@stdlib/ndarray/base/reverse-dimensions]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/reverse-dimensions + [@stdlib/ndarray/base/reverse]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/reverse [@stdlib/ndarray/base/rot180]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/rot180 diff --git a/lib/node_modules/@stdlib/stats/strided/README.md b/lib/node_modules/@stdlib/stats/strided/README.md index f2a1d4a621ee..1ef20a14f277 100644 --- a/lib/node_modules/@stdlib/stats/strided/README.md +++ b/lib/node_modules/@stdlib/stats/strided/README.md @@ -82,6 +82,7 @@ The namespace exports the following: - [`dmeanwd( N, x, strideX )`][@stdlib/stats/strided/dmeanwd]: calculate the arithmetic mean of a double-precision floating-point strided array using Welford's algorithm. - [`dmediansorted( N, x, strideX )`][@stdlib/stats/strided/dmediansorted]: calculate the median value of a sorted double-precision floating-point strided array. - [`dmidrange( N, x, strideX )`][@stdlib/stats/strided/dmidrange]: calculate the mid-range of a double-precision floating-point strided array. +- [`dmidrangeabs( N, x, strideX )`][@stdlib/stats/strided/dmidrangeabs]: compute the mid-range of absolute values of a double-precision floating-point strided array. - [`dmin( N, x, strideX )`][@stdlib/stats/strided/dmin]: calculate the minimum value of a double-precision floating-point strided array. - [`dminabs( N, x, strideX )`][@stdlib/stats/strided/dminabs]: calculate the minimum absolute value of a double-precision floating-point strided array. - [`dminsorted( N, x, strideX )`][@stdlib/stats/strided/dminsorted]: calculate the minimum value of a sorted double-precision floating-point strided array. @@ -120,6 +121,7 @@ The namespace exports the following: - [`dnanvariancetk( N, correction, x, strideX )`][@stdlib/stats/strided/dnanvariancetk]: calculate the variance of a double-precision floating-point strided array ignoring `NaN` values and using a one-pass textbook algorithm. - [`dnanvariancewd( N, correction, x, strideX )`][@stdlib/stats/strided/dnanvariancewd]: calculate the variance of a double-precision floating-point strided array ignoring `NaN` values and using Welford's algorithm. - [`dnanvarianceyc( N, correction, x, strideX )`][@stdlib/stats/strided/dnanvarianceyc]: calculate the variance of a double-precision floating-point strided array ignoring `NaN` values and using a one-pass algorithm proposed by Youngs and Cramer. +- [`dpcorr( N, x, strideX, y, strideY )`][@stdlib/stats/strided/dpcorr]: calculate the sample Pearson product-moment correlation coefficient of two double-precision floating-point strided arrays. - [`dpcorrwd( N, x, strideX, y, strideY )`][@stdlib/stats/strided/dpcorrwd]: calculate the sample Pearson product-moment correlation coefficient of two double-precision floating-point strided arrays using Welford's algorithm. - [`drange( N, x, strideX )`][@stdlib/stats/strided/drange]: calculate the range of a double-precision floating-point strided array. - [`drangeabs( N, x, strideX )`][@stdlib/stats/strided/drangeabs]: compute the range of absolute values of a double-precision floating-point strided array. @@ -399,6 +401,8 @@ console.log( objectKeys( ns ) ); [@stdlib/stats/strided/dmidrange]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dmidrange +[@stdlib/stats/strided/dmidrangeabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dmidrangeabs + [@stdlib/stats/strided/dmin]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dmin [@stdlib/stats/strided/dminabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dminabs @@ -475,6 +479,8 @@ console.log( objectKeys( ns ) ); [@stdlib/stats/strided/dnanvarianceyc]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dnanvarianceyc +[@stdlib/stats/strided/dpcorr]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dpcorr + [@stdlib/stats/strided/dpcorrwd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dpcorrwd [@stdlib/stats/strided/drange]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/drange