From 7037f85b43c66465f20a28395616272ee3e09f0f Mon Sep 17 00:00:00 2001 From: Planeshifter <1913638+Planeshifter@users.noreply.github.com> Date: Thu, 21 May 2026 03:31:55 +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/assert/README.md | 23 +++++++++++-------- .../@stdlib/blas/ext/base/README.md | 9 ++++++++ .../@stdlib/stats/base/ndarray/README.md | 3 +++ 3 files changed, 25 insertions(+), 10 deletions(-) diff --git a/lib/node_modules/@stdlib/assert/README.md b/lib/node_modules/@stdlib/assert/README.md index fa84d939ddb7..22543fabb586 100644 --- a/lib/node_modules/@stdlib/assert/README.md +++ b/lib/node_modules/@stdlib/assert/README.md @@ -196,6 +196,7 @@ The namespace includes utilities for validating `ndarray`s (n-dimensional arrays - [`isFloat64ndarrayLike( value )`][@stdlib/assert/is-float64ndarray-like]: test if a value is an ndarray-like object containing double-precision floating-point numbers. - [`isFloat64VectorLike( value )`][@stdlib/assert/is-float64vector-like]: test if a value is a 1-dimensional ndarray-like object containing double-precision floating-point numbers. - [`isMatrixLike( value )`][@stdlib/assert/is-matrix-like]: test if a value is 2-dimensional ndarray-like object. +- [`isndarrayDescriptor( value )`][@stdlib/assert/is-ndarray-descriptor]: test if a value is an ndarray descriptor. - [`isndarrayLikeWithDataType( value, dtype )`][@stdlib/assert/is-ndarray-like-with-data-type]: test if a value is an ndarray-like object having a specified data type. - [`isndarrayLike( value )`][@stdlib/assert/is-ndarray-like]: test if a value is ndarray-like. - [`isNonSymmetricMatrix( value )`][@stdlib/assert/is-nonsymmetric-matrix]: test if a value is a non-symmetric matrix. @@ -242,11 +243,11 @@ The namespace includes utilities for validating other special arrays or buffers: - [`isAlmostEqualComplex64array( v1, v2, maxULP )`][@stdlib/assert/is-almost-equal-complex64array]: test if two arguments are both Complex64Arrays and contain respective elements which are approximately equal within a specified number of ULPs (units in the last place). - [`isAlmostEqualFloat32array( v1, v2, maxULP )`][@stdlib/assert/is-almost-equal-float32array]: test if two arguments are both Float32Arrays and contain respective elements which are approximately equal within a specified number of ULPs (units in the last place). - [`isAlmostEqualFloat64Array( v1, v2, maxULP )`][@stdlib/assert/is-almost-equal-float64array]: test if two arguments are both Float64Arrays and contain respective elements which are approximately equal within a specified number of ULPs (units in the last place). -- [`isAlmostSameValueArray( v1, v2, maxULP )`][@stdlib/assert/is-almost-same-value-array]: test if two arguments are both generic arrays and contain respective elements which are approximately the same value within a specified number of ULPs (units in the last place). -- [`isAlmostSameValueComplex128Array( v1, v2, maxULP )`][@stdlib/assert/is-almost-same-value-complex128array]: test if two arguments are both Complex128Arrays and contain respective elements which are approximately the same value within a specified number of ULPs (units in the last place). -- [`isAlmostSameValueComplex64Array( v1, v2, maxULP )`][@stdlib/assert/is-almost-same-value-complex64array]: test if two arguments are both Complex64Arrays and contain respective elements which are approximately the same value within a specified number of ULPs (units in the last place). -- [`isAlmostSameValueFloat32Array( v1, v2, maxULP )`][@stdlib/assert/is-almost-same-value-float32array]: test if two arguments are both Float32Arrays and contain respective elements which are approximately the same value within a specified number of ULPs (units in the last place). -- [`isAlmostSameValueFloat64Array( v1, v2, maxULP )`][@stdlib/assert/is-almost-same-value-float64array]: test if two arguments are both Float64Arrays and contain respective elements which are approximately the same value within a specified number of ULPs (units in the last place). +- [`isAlmostSameArray( v1, v2, maxULP )`][@stdlib/assert/is-almost-same-array]: test if two arguments are both generic arrays and contain respective elements which are approximately the same value within a specified number of ULPs (units in the last place). +- [`isAlmostSameComplex128Array( v1, v2, maxULP )`][@stdlib/assert/is-almost-same-complex128array]: test if two arguments are both Complex128Arrays and contain respective elements which are approximately the same value within a specified number of ULPs (units in the last place). +- [`isAlmostSameComplex64Array( v1, v2, maxULP )`][@stdlib/assert/is-almost-same-complex64array]: test if two arguments are both Complex64Arrays and contain respective elements which are approximately the same value within a specified number of ULPs (units in the last place). +- [`isAlmostSameFloat32Array( v1, v2, maxULP )`][@stdlib/assert/is-almost-same-float32array]: test if two arguments are both Float32Arrays and contain respective elements which are approximately the same value within a specified number of ULPs (units in the last place). +- [`isAlmostSameFloat64Array( v1, v2, maxULP )`][@stdlib/assert/is-almost-same-float64array]: test if two arguments are both Float64Arrays and contain respective elements which are approximately the same value within a specified number of ULPs (units in the last place). - [`isArrayLength( value )`][@stdlib/assert/is-array-length]: test if a value is a valid array length. - [`isArrayLikeObject( value )`][@stdlib/assert/is-array-like-object]: test if a value is an array-like object. - [`isArrayLike( value )`][@stdlib/assert/is-array-like]: test if a value is array-like. @@ -979,15 +980,15 @@ console.log( objectKeys( assert ) ); [@stdlib/assert/is-almost-equal-float64array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-almost-equal-float64array -[@stdlib/assert/is-almost-same-value-array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-almost-same-value-array +[@stdlib/assert/is-almost-same-array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-almost-same-array -[@stdlib/assert/is-almost-same-value-complex128array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-almost-same-value-complex128array +[@stdlib/assert/is-almost-same-complex128array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-almost-same-complex128array -[@stdlib/assert/is-almost-same-value-complex64array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-almost-same-value-complex64array +[@stdlib/assert/is-almost-same-complex64array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-almost-same-complex64array -[@stdlib/assert/is-almost-same-value-float32array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-almost-same-value-float32array +[@stdlib/assert/is-almost-same-float32array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-almost-same-float32array -[@stdlib/assert/is-almost-same-value-float64array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-almost-same-value-float64array +[@stdlib/assert/is-almost-same-float64array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-almost-same-float64array [@stdlib/assert/is-array-length]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-array-length @@ -1117,6 +1118,8 @@ console.log( objectKeys( assert ) ); [@stdlib/assert/is-matrix-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-matrix-like +[@stdlib/assert/is-ndarray-descriptor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-ndarray-descriptor + [@stdlib/assert/is-ndarray-like-with-data-type]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-ndarray-like-with-data-type [@stdlib/assert/is-ndarray-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-ndarray-like diff --git a/lib/node_modules/@stdlib/blas/ext/base/README.md b/lib/node_modules/@stdlib/blas/ext/base/README.md index 118562b85808..d50dcb08d002 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/README.md @@ -71,6 +71,7 @@ var o = ns; - [`dcusumors( N, sum, x, strideX, y, strideY )`][@stdlib/blas/ext/base/dcusumors]: calculate the cumulative sum of double-precision floating-point strided array elements using ordinary recursive summation. - [`dcusumpw( N, sum, x, strideX, y, strideY )`][@stdlib/blas/ext/base/dcusumpw]: calculate the cumulative sum of double-precision floating-point strided array elements using pairwise summation. - [`ddiff( N, k, x, strideX, N1, prepend, strideP, N2, append, strideA, out, strideOut, workspace, strideW )`][@stdlib/blas/ext/base/ddiff]: calculate the k-th discrete forward difference of a double-precision floating-point strided array. +- [`dediff( N, x, strideX, N1, prepend, strideP, N2, append, strideA, out, strideOut )`][@stdlib/blas/ext/base/dediff]: calculate the differences between consecutive elements of a double-precision floating-point strided array. - [`dfill( N, alpha, x, strideX )`][@stdlib/blas/ext/base/dfill]: fill a double-precision floating-point strided array with a specified scalar constant. - [`dindexOfColumn( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/dindex-of-column]: return the index of the first column in a double-precision floating-point input matrix which has the same elements as a provided search vector. - [`dindexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/dindex-of-row]: return the index of the first row in a double-precision floating-point input matrix which has the same elements as a provided search vector. @@ -204,6 +205,7 @@ var o = ns; - [`sdsnansumpw( N, x, strideX )`][@stdlib/blas/ext/base/sdsnansumpw]: calculate the sum of single-precision floating-point strided array elements, ignoring `NaN` values and using pairwise summation with extended accumulation. - [`sdssum( N, x, strideX )`][@stdlib/blas/ext/base/sdssum]: calculate the sum of single-precision floating-point strided array elements using extended accumulation. - [`sdssumpw( N, x, strideX )`][@stdlib/blas/ext/base/sdssumpw]: calculate the sum of single-precision floating-point strided array elements using pairwise summation with extended accumulation. +- [`sediff( N, x, strideX, N1, prepend, strideP, N2, append, strideA, out, strideOut )`][@stdlib/blas/ext/base/sediff]: calculate the differences between consecutive elements of a single-precision floating-point strided array. - [`sfill( N, alpha, x, strideX )`][@stdlib/blas/ext/base/sfill]: fill a single-precision floating-point strided array with a specified scalar constant. - [`sindexOfColumn( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/sindex-of-column]: return the index of the first column in a single-precision floating-point input matrix which has the same elements as a provided search vector. - [`sindexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/sindex-of-row]: return the index of the first row in a single-precision floating-point input matrix which has the same elements as a provided search vector. @@ -236,6 +238,7 @@ var o = ns; - [`swhere( N, condition, strideC, x, strideX, y, strideY, out, strideOut )`][@stdlib/blas/ext/base/swhere]: take elements from one of two single-precision floating-point strided arrays depending on a condition. - [`szeroTo( N, x, strideX )`][@stdlib/blas/ext/base/szero-to]: fill a single-precision floating-point strided array with linearly spaced numeric elements which increment by `1` starting from zero. - [`wasm`][@stdlib/blas/ext/base/wasm]: extensions to basic linear algebra subprograms (BLAS) compiled to WebAssembly. +- [`zdiff( N, k, x, strideX, N1, prepend, strideP, N2, append, strideA, out, strideOut, workspace, strideW )`][@stdlib/blas/ext/base/zdiff]: calculate the k-th discrete forward difference of a double-precision complex floating-point strided array. - [`zfill( N, alpha, x, strideX )`][@stdlib/blas/ext/base/zfill]: fill a double-precision complex floating-point strided array with a specified scalar constant. - [`zindexOfColumn( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/zindex-of-column]: return the index of the first column in a double-precision complex floating-point input matrix which has the same elements as a provided search vector. - [`zindexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/zindex-of-row]: return the index of the first row in a double-precision complex floating-point input matrix which has the same elements as a provided search vector. @@ -354,6 +357,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/ddiff]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ddiff +[@stdlib/blas/ext/base/dediff]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dediff + [@stdlib/blas/ext/base/dfill]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dfill [@stdlib/blas/ext/base/dindex-of-column]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dindex-of-column @@ -620,6 +625,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/sdssumpw]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/sdssumpw +[@stdlib/blas/ext/base/sediff]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/sediff + [@stdlib/blas/ext/base/sfill]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/sfill [@stdlib/blas/ext/base/sindex-of-column]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/sindex-of-column @@ -684,6 +691,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/wasm]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/wasm +[@stdlib/blas/ext/base/zdiff]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zdiff + [@stdlib/blas/ext/base/zfill]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zfill [@stdlib/blas/ext/base/zindex-of-column]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zindex-of-column diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/README.md b/lib/node_modules/@stdlib/stats/base/ndarray/README.md index ae1a476ba0d5..0f79b342cde2 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/README.md +++ b/lib/node_modules/@stdlib/stats/base/ndarray/README.md @@ -104,6 +104,7 @@ The namespace exposes the following APIs: - [`dstdevtk( arrays )`][@stdlib/stats/base/ndarray/dstdevtk]: calculate the standard deviation of a one-dimensional double-precision floating-point ndarray using a one-pass textbook algorithm. - [`dstdevwd( arrays )`][@stdlib/stats/base/ndarray/dstdevwd]: calculate the standard deviation of a one-dimensional double-precision floating-point ndarray using Welford's algorithm. - [`dstdevyc( arrays )`][@stdlib/stats/base/ndarray/dstdevyc]: calculate the standard deviation of a one-dimensional double-precision floating-point ndarray using a one-pass algorithm proposed by Youngs and Cramer. +- [`dvariance( arrays )`][@stdlib/stats/base/ndarray/dvariance]: calculate the variance of a one-dimensional double-precision floating-point ndarray. - [`dztest( arrays )`][@stdlib/stats/base/ndarray/dztest]: compute a one-sample Z-test for a one-dimensional double-precision floating-point ndarray. - [`dztest2( arrays )`][@stdlib/stats/base/ndarray/dztest2]: compute a two-sample Z-test for two one-dimensional double-precision floating-point ndarrays. - [`maxBy( arrays, clbk[, thisArg ] )`][@stdlib/stats/base/ndarray/max-by]: compute the maximum value of a one-dimensional ndarray via a callback function. @@ -388,6 +389,8 @@ console.log( objectKeys( ns ) ); [@stdlib/stats/base/ndarray/dstdevyc]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/ndarray/dstdevyc +[@stdlib/stats/base/ndarray/dvariance]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/ndarray/dvariance + [@stdlib/stats/base/ndarray/dztest]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/ndarray/dztest [@stdlib/stats/base/ndarray/dztest2]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/ndarray/dztest2