From bf775f61ab2f7efc6170563f27814ce4b3717c49 Mon Sep 17 00:00:00 2001 From: Planeshifter <1913638+Planeshifter@users.noreply.github.com> Date: Wed, 22 Jan 2025 02:36:40 +0000 Subject: [PATCH] docs: update namespace table of contents Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> --- .../@stdlib/lapack/base/README.md | 36 +++++++++++++++++++ lib/node_modules/@stdlib/stats/base/README.md | 3 -- 2 files changed, 36 insertions(+), 3 deletions(-) diff --git a/lib/node_modules/@stdlib/lapack/base/README.md b/lib/node_modules/@stdlib/lapack/base/README.md index 85d0d9d170dd..26b6cbe0402a 100644 --- a/lib/node_modules/@stdlib/lapack/base/README.md +++ b/lib/node_modules/@stdlib/lapack/base/README.md @@ -45,12 +45,24 @@ The namespace contains the following:
+- [`clacgv( N, cx, strideCX )`][@stdlib/lapack/base/clacgv]: conjugate each element in a single-precision complex floating-point vector. +- [`clacpy( order, uplo, M, N, A, LDA, B, LDB )`][@stdlib/lapack/base/clacpy]: copy all or part of a matrix `A` to another matrix `B`. +- [`claset( order, uplo, M, N, alpha, beta, A, LDA )`][@stdlib/lapack/base/claset]: set the off-diagonal elements and the diagonal elements of a single-precision complex floating-point matrix to specified values. +- [`crot( N, cx, strideCX, cy, strideCY, c, s )`][@stdlib/lapack/base/crot]: apply a plane rotation with real cosine and complex sine to a pair of single-precision complex floating-point vectors. +- [`dgetrans( order, M, N, A, LDA, out, LDO )`][@stdlib/lapack/base/dge-trans]: convert a matrix from row-major layout to column-major layout or vice versa. - [`dlacpy( order, uplo, M, N, A, LDA, B, LDB )`][@stdlib/lapack/base/dlacpy]: copy all or part of a matrix `A` to another matrix `B`. +- [`dlamch( cmach )`][@stdlib/lapack/base/dlamch]: determine double-precision floating-point machine parameters. - [`dlassq( N, X, strideX, scale, sumsq )`][@stdlib/lapack/base/dlassq]: return an updated sum of squares represented in scaled form. - [`dlaswp( N, A, LDA, k1, k2, IPIV, incx )`][@stdlib/lapack/base/dlaswp]: perform a series of row interchanges on an input matrix. - [`dpttrf( N, D, E )`][@stdlib/lapack/base/dpttrf]: compute the `L * D * L^T` factorization of a real symmetric positive definite tridiagonal matrix `A`. +- [`sgetrans( order, M, N, A, LDA, out, LDO )`][@stdlib/lapack/base/sge-trans]: convert a matrix from row-major layout to column-major layout or vice versa. - [`slacpy( order, uplo, M, N, A, LDA, B, LDB )`][@stdlib/lapack/base/slacpy]: copy all or part of a matrix `A` to another matrix `B`. +- [`slaswp( N, A, LDA, k1, k2, IPIV, incx )`][@stdlib/lapack/base/slaswp]: perform a series of row interchanges on an input matrix. - [`spttrf( N, D, E )`][@stdlib/lapack/base/spttrf]: compute the `L * D * L^T` factorization of a real symmetric positive definite tridiagonal matrix `A`. +- [`zlacgv( N, zx, strideZX )`][@stdlib/lapack/base/zlacgv]: conjugate each element in a double-precision complex floating-point vector. +- [`zlacpy( order, uplo, M, N, A, LDA, B, LDB )`][@stdlib/lapack/base/zlacpy]: copy all or part of a matrix `A` to another matrix `B`. +- [`zlaset( order, uplo, M, N, alpha, beta, A, LDA )`][@stdlib/lapack/base/zlaset]: set the off-diagonal elements and the diagonal elements of a double-precision complex floating-point matrix to specified values. +- [`zrot( N, zx, strideX, zy, strideY, c, s )`][@stdlib/lapack/base/zrot]: apply a plane rotation with real cosine and complex sine to a pair of double-precision complex floating-point vectors.
@@ -93,18 +105,42 @@ console.log( objectKeys( lapack ) ); +[@stdlib/lapack/base/clacgv]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/lapack/base/clacgv + +[@stdlib/lapack/base/clacpy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/lapack/base/clacpy + +[@stdlib/lapack/base/claset]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/lapack/base/claset + +[@stdlib/lapack/base/crot]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/lapack/base/crot + +[@stdlib/lapack/base/dge-trans]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/lapack/base/dge-trans + [@stdlib/lapack/base/dlacpy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/lapack/base/dlacpy +[@stdlib/lapack/base/dlamch]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/lapack/base/dlamch + [@stdlib/lapack/base/dlassq]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/lapack/base/dlassq [@stdlib/lapack/base/dlaswp]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/lapack/base/dlaswp [@stdlib/lapack/base/dpttrf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/lapack/base/dpttrf +[@stdlib/lapack/base/sge-trans]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/lapack/base/sge-trans + [@stdlib/lapack/base/slacpy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/lapack/base/slacpy +[@stdlib/lapack/base/slaswp]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/lapack/base/slaswp + [@stdlib/lapack/base/spttrf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/lapack/base/spttrf +[@stdlib/lapack/base/zlacgv]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/lapack/base/zlacgv + +[@stdlib/lapack/base/zlacpy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/lapack/base/zlacpy + +[@stdlib/lapack/base/zlaset]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/lapack/base/zlaset + +[@stdlib/lapack/base/zrot]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/lapack/base/zrot + diff --git a/lib/node_modules/@stdlib/stats/base/README.md b/lib/node_modules/@stdlib/stats/base/README.md index 12db012765fc..5d016ed0934e 100644 --- a/lib/node_modules/@stdlib/stats/base/README.md +++ b/lib/node_modules/@stdlib/stats/base/README.md @@ -61,7 +61,6 @@ The namespace contains the following statistical functions: - [`cumaxabs( N, x, strideX, y, strideY )`][@stdlib/stats/base/cumaxabs]: calculate the cumulative maximum absolute value of a strided array. - [`cumin( N, x, strideX, y, strideY )`][@stdlib/stats/base/cumin]: calculate the cumulative minimum of a strided array. - [`cuminabs( N, x, strideX, y, strideY )`][@stdlib/stats/base/cuminabs]: calculate the cumulative minimum absolute value of a strided array. -- [`dcumaxabs( N, x, strideX, y, strideY )`][@stdlib/stats/strided/dcumaxabs]: calculate the cumulative maximum absolute value of double-precision floating-point strided array elements. - [`dcumin( N, x, strideX, y, strideY )`][@stdlib/stats/base/dcumin]: calculate the cumulative minimum of double-precision floating-point strided array elements. - [`dcuminabs( N, x, strideX, y, strideY )`][@stdlib/stats/base/dcuminabs]: calculate the cumulative minimum absolute value of double-precision floating-point strided array elements. - [`dmaxabs( N, x, strideX )`][@stdlib/stats/base/dmaxabs]: calculate the maximum absolute value of a double-precision floating-point strided array. @@ -330,8 +329,6 @@ console.log( objectKeys( ns ) ); [@stdlib/stats/base/cuminabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/cuminabs -[@stdlib/stats/strided/dcumaxabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dcumaxabs - [@stdlib/stats/base/dcumin]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dcumin [@stdlib/stats/base/dcuminabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dcuminabs