From 9cd48804d669708d940ee389ad762b77d1f1bd83 Mon Sep 17 00:00:00 2001 From: Planeshifter <1913638+Planeshifter@users.noreply.github.com> Date: Wed, 4 Jun 2025 02:47: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/stats/base/README.md | 2 +- lib/node_modules/@stdlib/stats/base/ndarray/README.md | 3 +++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/README.md b/lib/node_modules/@stdlib/stats/base/README.md index 7d18dacaab70..93af1eef883d 100644 --- a/lib/node_modules/@stdlib/stats/base/README.md +++ b/lib/node_modules/@stdlib/stats/base/README.md @@ -124,7 +124,7 @@ The namespace contains the following statistical functions: - [`nanvarianceyc( N, correction, x, strideX )`][@stdlib/stats/base/nanvarianceyc]: calculate the variance of a strided array ignoring `NaN` values and using a one-pass algorithm proposed by Youngs and Cramer. - [`ndarray`][@stdlib/stats/base/ndarray]: base ndarray statistical functions. - [`rangeBy( N, x, stride, clbk[, thisArg] )`][@stdlib/stats/base/range-by]: calculate the range of a strided array via a callback function. -- [`range( N, x, stride )`][@stdlib/stats/base/range]: calculate the range of a strided array. +- [`range( N, x, strideX )`][@stdlib/stats/base/range]: calculate the range of a strided array. - [`sdsnanmean( N, x, stride )`][@stdlib/stats/base/sdsnanmean]: calculate the arithmetic mean of a single-precision floating-point strided array, ignoring `NaN` values and using extended accumulation. - [`sdsnanmeanors( N, x, stride )`][@stdlib/stats/base/sdsnanmeanors]: calculate the arithmetic mean of a single-precision floating-point strided array, ignoring `NaN` values and using ordinary recursive summation with extended accumulation. - [`smean( N, x, strideX )`][@stdlib/stats/base/smean]: calculate the arithmetic mean of a single-precision floating-point strided array. diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/README.md b/lib/node_modules/@stdlib/stats/base/ndarray/README.md index 2688a2075c5e..e6f87e07fcd3 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/README.md +++ b/lib/node_modules/@stdlib/stats/base/ndarray/README.md @@ -48,6 +48,7 @@ The namespace exposes the following APIs: - [`cumax( arrays )`][@stdlib/stats/base/ndarray/cumax]: compute the cumulative maximum value of a one-dimensional ndarray. - [`dcumax( arrays )`][@stdlib/stats/base/ndarray/dcumax]: compute the cumulative maximum value of a one-dimensional double-precision floating-point ndarray. - [`dmax( arrays )`][@stdlib/stats/base/ndarray/dmax]: compute the maximum value of a one-dimensional double-precision floating-point ndarray. +- [`maxBy( arrays, clbk[, thisArg ] )`][@stdlib/stats/base/ndarray/max-by]: compute the maximum value of a one-dimensional ndarray via a callback function. - [`max( arrays )`][@stdlib/stats/base/ndarray/max]: compute the maximum value of a one-dimensional ndarray. - [`scumax( arrays )`][@stdlib/stats/base/ndarray/scumax]: compute the cumulative maximum value of a one-dimensional single-precision floating-point ndarray. - [`smax( arrays )`][@stdlib/stats/base/ndarray/smax]: compute the maximum value of a one-dimensional single-precision floating-point ndarray. @@ -99,6 +100,8 @@ console.log( objectKeys( ns ) ); [@stdlib/stats/base/ndarray/dmax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/ndarray/dmax +[@stdlib/stats/base/ndarray/max-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/ndarray/max-by + [@stdlib/stats/base/ndarray/max]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/ndarray/max [@stdlib/stats/base/ndarray/scumax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/ndarray/scumax