From dfb8ad9d5ecf27052856df0a5da203a10df69b0e Mon Sep 17 00:00:00 2001 From: Planeshifter <1913638+Planeshifter@users.noreply.github.com> Date: Sat, 7 Jun 2025 02:45:48 +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/ndarray/base/README.md | 6 ++++++ lib/node_modules/@stdlib/stats/README.md | 3 +++ lib/node_modules/@stdlib/stats/base/README.md | 12 ------------ 3 files changed, 9 insertions(+), 12 deletions(-) diff --git a/lib/node_modules/@stdlib/ndarray/base/README.md b/lib/node_modules/@stdlib/ndarray/base/README.md index 8976a7c2c7df..392e2e7f74ec 100644 --- a/lib/node_modules/@stdlib/ndarray/base/README.md +++ b/lib/node_modules/@stdlib/ndarray/base/README.md @@ -155,6 +155,8 @@ var o = ns; - [`unaryLoopOrder( shape, stridesX, stridesY )`][@stdlib/ndarray/base/unary-loop-interchange-order]: reorder ndarray dimensions and associated strides for loop interchange. - [`unaryOutputDataType( dtype, policy )`][@stdlib/ndarray/base/unary-output-dtype]: resolve the output ndarray data type for a unary function. - [`unaryReduceStrided1dBy( fcn, arrays, dims[, options], clbk[, thisArg] )`][@stdlib/ndarray/base/unary-reduce-strided1d-by]: perform a reduction over a list of specified dimensions in an input ndarray via a one-dimensional strided array reduction function accepting a callback and assign results to a provided output ndarray. +- [`unaryReduceStrided1dDispatchByFactory( table, idtypes, odtypes, policies )`][@stdlib/ndarray/base/unary-reduce-strided1d-dispatch-by-factory]: create a function for performing a reduction on an input ndarray according to a callback function. +- [`unaryReduceStrided1dDispatchBy( table, idtypes, odtypes, policies )`][@stdlib/ndarray/base/unary-reduce-strided1d-dispatch-by]: constructor for performing a reduction on an input ndarray according to a callback function. - [`unaryReduceStrided1dDispatchFactory( table, idtypes, odtypes, policies )`][@stdlib/ndarray/base/unary-reduce-strided1d-dispatch-factory]: create a function for performing a reduction on an input ndarray. - [`unaryReduceStrided1dDispatch( table, idtypes, odtypes, policies )`][@stdlib/ndarray/base/unary-reduce-strided1d-dispatch]: constructor for performing a reduction on an input ndarray. - [`unaryReduceStrided1d( fcn, arrays, dims[, options] )`][@stdlib/ndarray/base/unary-reduce-strided1d]: perform a reduction over a list of specified dimensions in an input ndarray via a one-dimensional strided array reduction function and assign results to a provided output ndarray. @@ -449,6 +451,10 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/base/unary-reduce-strided1d-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/unary-reduce-strided1d-by +[@stdlib/ndarray/base/unary-reduce-strided1d-dispatch-by-factory]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/unary-reduce-strided1d-dispatch-by-factory + +[@stdlib/ndarray/base/unary-reduce-strided1d-dispatch-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/unary-reduce-strided1d-dispatch-by + [@stdlib/ndarray/base/unary-reduce-strided1d-dispatch-factory]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/unary-reduce-strided1d-dispatch-factory [@stdlib/ndarray/base/unary-reduce-strided1d-dispatch]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/unary-reduce-strided1d-dispatch diff --git a/lib/node_modules/@stdlib/stats/README.md b/lib/node_modules/@stdlib/stats/README.md index 0bd25f25676f..a4929651332a 100644 --- a/lib/node_modules/@stdlib/stats/README.md +++ b/lib/node_modules/@stdlib/stats/README.md @@ -113,6 +113,7 @@ Other statistical functions included are: - [`cumax( x[, options] )`][@stdlib/stats/cumax]: compute the cumulative maximum value along one or more ndarray dimensions. - [`kde2d()`][@stdlib/stats/kde2d]: two-dimensional kernel density estimation. - [`lowess( x, y[, opts] )`][@stdlib/stats/lowess]: locally-weighted polynomial regression via the LOWESS algorithm. +- [`maxBy( x[, options], clbk[, thisArg] )`][@stdlib/stats/max-by]: compute the maximum value along one or more ndarray dimensions according to a callback function. - [`max( x[, options] )`][@stdlib/stats/max]: compute the maximum value along one or more ndarray dimensions. - [`padjust( pvals, method[, comparisons] )`][@stdlib/stats/padjust]: adjust supplied p-values for multiple comparisons. - [`ranks( arr[, opts] )`][@stdlib/stats/ranks]: compute ranks for values of an array-like object. @@ -164,6 +165,8 @@ console.log( objectKeys( statistics ) ); [@stdlib/stats/lowess]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/lowess +[@stdlib/stats/max-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/max-by + [@stdlib/stats/max]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/max [@stdlib/stats/padjust]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/padjust diff --git a/lib/node_modules/@stdlib/stats/base/README.md b/lib/node_modules/@stdlib/stats/base/README.md index fb2796a54a0a..7399a5161329 100644 --- a/lib/node_modules/@stdlib/stats/base/README.md +++ b/lib/node_modules/@stdlib/stats/base/README.md @@ -65,10 +65,6 @@ The namespace contains the following statistical functions: - [`dmeanstdevpn( N, correction, x, strideX, out, strideOut )`][@stdlib/stats/base/dmeanstdevpn]: calculate the mean and standard deviation of a double-precision floating-point strided array using a two-pass algorithm. - [`dmeanvar( N, correction, x, strideX, out, strideOut )`][@stdlib/stats/base/dmeanvar]: calculate the mean and variance of a double-precision floating-point strided array. - [`dmeanvarpn( N, correction, x, strideX, out, strideOut )`][@stdlib/stats/base/dmeanvarpn]: calculate the mean and variance of a double-precision floating-point strided array using a two-pass algorithm. -- [`dnanmskmax( N, x, strideX, mask, strideMask )`][@stdlib/stats/strided/dnanmskmax]: calculate the maximum value of a double-precision floating-point strided array according to a mask, ignoring `NaN` values. -- [`dnanmskmin( N, x, strideX, mask, strideMask )`][@stdlib/stats/strided/dnanmskmin]: calculate the minimum 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. -- [`dnanstdev( N, correction, x, strideX )`][@stdlib/stats/strided/dnanstdev]: calculate the standard deviation of a double-precision floating-point strided array ignoring `NaN` values. - [`dsem( N, correction, x, strideX )`][@stdlib/stats/base/dsem]: calculate the standard error of the mean of a double-precision floating-point strided array. - [`dsempn( N, correction, x, strideX )`][@stdlib/stats/base/dsempn]: calculate the standard error of the mean of a double-precision floating-point strided array using a two-pass algorithm. - [`dstdev( N, correction, x, strideX )`][@stdlib/stats/base/dstdev]: calculate the standard deviation of a double-precision floating-point strided array. @@ -229,14 +225,6 @@ console.log( objectKeys( ns ) ); [@stdlib/stats/base/dmeanvarpn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dmeanvarpn -[@stdlib/stats/strided/dnanmskmax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dnanmskmax - -[@stdlib/stats/strided/dnanmskmin]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dnanmskmin - -[@stdlib/stats/strided/dnanmskrange]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dnanmskrange - -[@stdlib/stats/strided/dnanstdev]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dnanstdev - [@stdlib/stats/base/dsem]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dsem [@stdlib/stats/base/dsempn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dsempn