From ee229d2adfe9dc22f16d152464895cec376917a1 Mon Sep 17 00:00:00 2001 From: Planeshifter <1913638+Planeshifter@users.noreply.github.com> Date: Sun, 1 Jun 2025 02:58:08 +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/README.md | 6 +++--- lib/node_modules/@stdlib/ndarray/README.md | 9 +++++++++ lib/node_modules/@stdlib/ndarray/base/README.md | 6 ++++++ lib/node_modules/@stdlib/stats/base/README.md | 4 ++-- 4 files changed, 20 insertions(+), 5 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/README.md b/lib/node_modules/@stdlib/blas/base/README.md index 3985361c19cf..88282f103e5e 100644 --- a/lib/node_modules/@stdlib/blas/base/README.md +++ b/lib/node_modules/@stdlib/blas/base/README.md @@ -45,9 +45,9 @@ var o = blas;
-- [`caxpy( N, ca, cx, strideX, cy, strideY )`][@stdlib/blas/base/caxpy]: scale a single-precision complex floating-point vector by a single-precision complex floating-point constant and add the result to a single-precision complex floating-point vector. +- [`caxpy( N, alpha, x, strideX, y, strideY )`][@stdlib/blas/base/caxpy]: scale a single-precision complex floating-point vector by a single-precision complex floating-point constant and add the result to a single-precision complex floating-point vector. - [`ccopy( N, x, strideX, y, strideY )`][@stdlib/blas/base/ccopy]: copy values from one complex single-precision floating-point vector to another complex single-precision floating-point vector. -- [`cscal( N, ca, cx, strideX )`][@stdlib/blas/base/cscal]: scales a single-precision complex floating-point vector by a single-precision complex floating-point constant. +- [`cscal( N, alpha, x, strideX )`][@stdlib/blas/base/cscal]: scales a single-precision complex floating-point vector by a single-precision complex floating-point constant. - [`csrot( N, cx, strideX, cy, strideY, c, s )`][@stdlib/blas/base/csrot]: applies a plane rotation. - [`cswap( N, x, strideX, y, strideY )`][@stdlib/blas/base/cswap]: interchange two complex single-precision floating-point vectors. - [`dasum( N, x, stride )`][@stdlib/blas/base/dasum]: compute the sum of absolute values (_L1_ norm). @@ -84,7 +84,7 @@ var o = blas; - [`srotm( N, x, strideX, y, strideY, param )`][@stdlib/blas/base/srotm]: apply a modified Givens plane rotation. - [`sscal( N, alpha, x, stride )`][@stdlib/blas/base/sscal]: multiply a single-precision floating-point vector `x` by a constant `alpha`. - [`sswap( N, x, strideX, y, strideY )`][@stdlib/blas/base/sswap]: interchange two single-precision floating-point vectors. -- [`zaxpy( N, za, zx, strideX, zy, strideY )`][@stdlib/blas/base/zaxpy]: scale a double-precision complex floating-point vector by a double-precision complex floating-point constant and add the result to a double-precision complex floating-point vector. +- [`zaxpy( N, alpha, x, strideX, y, strideY )`][@stdlib/blas/base/zaxpy]: scale a double-precision complex floating-point vector by a double-precision complex floating-point constant and add the result to a double-precision complex floating-point vector. - [`zcopy( N, x, strideX, y, strideY )`][@stdlib/blas/base/zcopy]: copy values from one complex double-precision floating-point vector to another complex double-precision floating-point vector. - [`zdrot( N, zx, strideX, zy, strideY, c, s )`][@stdlib/blas/base/zdrot]: applies a plane rotation. - [`zdscal( N, da, zx, strideZX )`][@stdlib/blas/base/zdscal]: scale a double-precision complex floating-point vector by a double-precision floating-point constant. diff --git a/lib/node_modules/@stdlib/ndarray/README.md b/lib/node_modules/@stdlib/ndarray/README.md index 9950e6d16ef1..7d4ca511844a 100644 --- a/lib/node_modules/@stdlib/ndarray/README.md +++ b/lib/node_modules/@stdlib/ndarray/README.md @@ -75,6 +75,9 @@ In addition, the namespace contains the following multidimensional array utility - [`broadcastArray( x, shape )`][@stdlib/ndarray/broadcast-array]: broadcast an ndarray to a specified shape. - [`broadcastArrays( ...arrays )`][@stdlib/ndarray/broadcast-arrays]: broadcast ndarrays to a common shape. - [`castingModes()`][@stdlib/ndarray/casting-modes]: list of ndarray casting modes. +- [`countFalsy( x[, options] )`][@stdlib/ndarray/count-falsy]: count the number of falsy elements along one or more `ndarray` dimensions. +- [`countIf( x[, options], predicate[, thisArg] )`][@stdlib/ndarray/count-if]: count the number of truthy elements along one or more `ndarray` dimensions. +- [`countTruthy( x[, options] )`][@stdlib/ndarray/count-truthy]: count the number of truthy elements along one or more `ndarray` dimensions. - [`dataBuffer( x )`][@stdlib/ndarray/data-buffer]: return the underlying data buffer of a provided ndarray. - [`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. @@ -182,6 +185,12 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/casting-modes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/casting-modes +[@stdlib/ndarray/count-falsy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/count-falsy + +[@stdlib/ndarray/count-if]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/count-if + +[@stdlib/ndarray/count-truthy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/count-truthy + [@stdlib/ndarray/data-buffer]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/data-buffer [@stdlib/ndarray/defaults]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/defaults diff --git a/lib/node_modules/@stdlib/ndarray/base/README.md b/lib/node_modules/@stdlib/ndarray/base/README.md index 813b43ce380e..b223d0727d32 100644 --- a/lib/node_modules/@stdlib/ndarray/base/README.md +++ b/lib/node_modules/@stdlib/ndarray/base/README.md @@ -61,6 +61,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]`. - [`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. - [`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. @@ -136,6 +137,7 @@ var o = ns; - [`sliceFrom( x, start, strict, writable )`][@stdlib/ndarray/base/slice-from]: return a shifted view of an input ndarray. - [`sliceTo( x, stop, strict, writable )`][@stdlib/ndarray/base/slice-to]: return a truncated view of an input ndarray. - [`slice( x, slice, strict, writable )`][@stdlib/ndarray/base/slice]: return a view of an input ndarray. +- [`someBy( arrays, predicate[, thisArg ] )`][@stdlib/ndarray/base/some-by]: test whether at least `n` elements in an ndarray pass a test implemented by a predicate function. - [`spreadDimensions( ndims, x, dims )`][@stdlib/ndarray/base/spread-dimensions]: expand the shape of an array to a specified dimensionality by spreading its dimensions to specified dimension indices and inserting dimensions of size one for the remaining dimensions. - [`stride( x, dim )`][@stdlib/ndarray/base/stride]: return the stride along a specified dimension for a provided ndarray. - [`strides( x, copy )`][@stdlib/ndarray/base/strides]: return the strides of a provided ndarray. @@ -258,6 +260,8 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/base/count-falsy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/count-falsy +[@stdlib/ndarray/base/count-if]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/count-if + [@stdlib/ndarray/base/count-truthy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/count-truthy [@stdlib/ndarray/base/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/ctor @@ -408,6 +412,8 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/base/slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/slice +[@stdlib/ndarray/base/some-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/some-by + [@stdlib/ndarray/base/spread-dimensions]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/spread-dimensions [@stdlib/ndarray/base/stride]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/stride diff --git a/lib/node_modules/@stdlib/stats/base/README.md b/lib/node_modules/@stdlib/stats/base/README.md index f27a7dd8ef1a..7d18dacaab70 100644 --- a/lib/node_modules/@stdlib/stats/base/README.md +++ b/lib/node_modules/@stdlib/stats/base/README.md @@ -76,7 +76,7 @@ The namespace contains the following statistical functions: - [`dstdev( N, correction, x, strideX )`][@stdlib/stats/base/dstdev]: calculate the standard deviation of a double-precision floating-point strided array. - [`dvarm( N, mean, correction, x, stride )`][@stdlib/stats/base/dvarm]: calculate the variance of a double-precision floating-point strided array provided a known mean. - [`dvarmpn( N, mean, correction, x, stride )`][@stdlib/stats/base/dvarmpn]: calculate the variance of a double-precision floating-point strided array provided a known mean and using Neely's correction algorithm. -- [`maxBy( N, x, stride, clbk[, thisArg] )`][@stdlib/stats/base/max-by]: calculate the maximum value of a strided array via a callback function. +- [`maxBy( N, x, strideX, clbk[, thisArg] )`][@stdlib/stats/base/max-by]: calculate the maximum value of a strided array via a callback function. - [`max( N, x, strideX )`][@stdlib/stats/base/max]: calculate the maximum value of a strided array. - [`maxabs( N, x, strideX )`][@stdlib/stats/base/maxabs]: calculate the maximum absolute value of a strided array. - [`maxsorted( N, x, strideX )`][@stdlib/stats/base/maxsorted]: calculate the maximum value of a sorted strided array. @@ -88,7 +88,7 @@ The namespace contains the following statistical functions: - [`meanpw( N, x, stride )`][@stdlib/stats/base/meanpw]: calculate the arithmetic mean of a strided array using pairwise summation. - [`meanwd( N, x, strideX )`][@stdlib/stats/base/meanwd]: calculate the arithmetic mean of a strided array using Welford's algorithm. - [`mediansorted( N, x, strideX )`][@stdlib/stats/base/mediansorted]: calculate the median value of a sorted strided array. -- [`minBy( N, x, stride, clbk[, thisArg] )`][@stdlib/stats/base/min-by]: calculate the minimum value of a strided array via a callback function. +- [`minBy( N, x, strideX, clbk[, thisArg] )`][@stdlib/stats/base/min-by]: calculate the minimum value of a strided array via a callback function. - [`min( N, x, strideX )`][@stdlib/stats/base/min]: calculate the minimum value of a strided array. - [`minabs( N, x, strideX )`][@stdlib/stats/base/minabs]: calculate the minimum absolute value of a strided array. - [`minsorted( N, x, strideX )`][@stdlib/stats/base/minsorted]: calculate the minimum value of a sorted strided array.