From e9329be70f68fe7653e167dd60e5ac4a4bc24706 Mon Sep 17 00:00:00 2001 From: Planeshifter <1913638+Planeshifter@users.noreply.github.com> Date: Fri, 15 May 2026 03:31:05 +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/ext/base/README.md | 6 ++++++ lib/node_modules/@stdlib/ndarray/README.md | 3 +++ .../@stdlib/stats/base/dists/discrete-uniform/README.md | 2 +- .../@stdlib/stats/base/dists/exponential/README.md | 2 +- .../@stdlib/stats/base/dists/pareto-type1/README.md | 2 +- 5 files changed, 12 insertions(+), 3 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/README.md b/lib/node_modules/@stdlib/blas/ext/base/README.md index 5617d3402d62..aeaeef8e21a3 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/README.md @@ -44,6 +44,7 @@ var o = ns;
- [`cfill( N, alpha, x, strideX )`][@stdlib/blas/ext/base/cfill]: fill a single-precision complex floating-point strided array with a specified scalar constant. +- [`cindexOfColumn( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/cindex-of-column]: return the index of the first column in a single-precision complex floating-point input matrix which has the same elements as a provided search vector. - [`cindexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/cindex-of-row]: return the index of the first row in a single-precision complex floating-point input matrix which has the same elements as a provided search vector. - [`cindexOf( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/cindex-of]: return the first index of a specified search element in a single-precision complex floating-point strided array. - [`clastIndexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/clast-index-of-row]: return the index of the last row in a single-precision complex floating-point input matrix which has the same elements as a provided search vector. @@ -233,6 +234,7 @@ var o = ns; - [`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. - [`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. - [`zindexOf( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/zindex-of]: return the first index of a specified search element in a double-precision complex floating-point strided array. - [`zlastIndexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/zlast-index-of-row]: return the index of the last row in a double-precision complex floating-point input matrix which has the same elements as a provided search vector. @@ -295,6 +297,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/cfill]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/cfill +[@stdlib/blas/ext/base/cindex-of-column]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/cindex-of-column + [@stdlib/blas/ext/base/cindex-of-row]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/cindex-of-row [@stdlib/blas/ext/base/cindex-of]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/cindex-of @@ -673,6 +677,8 @@ console.log( objectKeys( ns ) ); [@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 + [@stdlib/blas/ext/base/zindex-of-row]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zindex-of-row [@stdlib/blas/ext/base/zindex-of]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zindex-of diff --git a/lib/node_modules/@stdlib/ndarray/README.md b/lib/node_modules/@stdlib/ndarray/README.md index 2513e0358b5d..bf8baf890bf6 100644 --- a/lib/node_modules/@stdlib/ndarray/README.md +++ b/lib/node_modules/@stdlib/ndarray/README.md @@ -56,6 +56,7 @@ The namespace exports the following functions to create multidimensional arrays: - [`scalar2ndarrayLike( x, value[, options] )`][@stdlib/ndarray/from-scalar-like]: convert a scalar value to a zero-dimensional ndarray having the same data-type as a provided ndarray. - [`scalar2ndarray( value[, options] )`][@stdlib/ndarray/from-scalar]: convert a scalar value to a zero-dimensional ndarray. - [`nansLike( x[, options] )`][@stdlib/ndarray/nans-like]: create a NaN-filled ndarray having the same shape and data type as a provided ndarray. +- [`nans( shape[, options] )`][@stdlib/ndarray/nans]: create a NaN-filled ndarray having a specified shape and data type. - [`ndarraylike2ndarray( x[, options] )`][@stdlib/ndarray/ndarraylike2ndarray]: convert an ndarray-like object to an `ndarray`. - [`onesLike( x[, options] )`][@stdlib/ndarray/ones-like]: create a ones-filled ndarray having the same shape and data type as a provided ndarray. - [`ones( shape[, options] )`][@stdlib/ndarray/ones]: create a ones-filled ndarray having a specified shape and data type. @@ -571,6 +572,8 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/nans-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/nans-like +[@stdlib/ndarray/nans]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/nans + [@stdlib/ndarray/ndarraylike2ndarray]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ndarraylike2ndarray [@stdlib/ndarray/ones-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ones-like diff --git a/lib/node_modules/@stdlib/stats/base/dists/discrete-uniform/README.md b/lib/node_modules/@stdlib/stats/base/dists/discrete-uniform/README.md index 07cdb8b8927f..f576918e4009 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/discrete-uniform/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/discrete-uniform/README.md @@ -46,7 +46,7 @@ The namespace contains the following distribution functions:
- [`cdf( x, a, b )`][@stdlib/stats/base/dists/discrete-uniform/cdf]: discrete uniform distribution cumulative distribution function. -- [`logcdf( x, a, b )`][@stdlib/stats/base/dists/discrete-uniform/logcdf]: evaluate the natural logarithm of the cumulative distribution function for a discrete uniform distribution. +- [`logcdf( x, a, b )`][@stdlib/stats/base/dists/discrete-uniform/logcdf]: discrete uniform distribution logarithm of cumulative distribution function. - [`logpmf( x, a, b )`][@stdlib/stats/base/dists/discrete-uniform/logpmf]: evaluate the natural logarithm of the probability mass function (PMF) for a discrete uniform distribution. - [`mgf( t, a, b )`][@stdlib/stats/base/dists/discrete-uniform/mgf]: discrete uniform distribution moment-generating function (MGF). - [`pmf( x, a, b )`][@stdlib/stats/base/dists/discrete-uniform/pmf]: discrete uniform distribution probability mass function (PMF). diff --git a/lib/node_modules/@stdlib/stats/base/dists/exponential/README.md b/lib/node_modules/@stdlib/stats/base/dists/exponential/README.md index 5161e75cbd40..fc7121f4054b 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/exponential/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/exponential/README.md @@ -46,7 +46,7 @@ The namespace contains the following distribution functions:
- [`cdf( x, lambda )`][@stdlib/stats/base/dists/exponential/cdf]: exponential distribution cumulative distribution function. -- [`logcdf( x, lambda )`][@stdlib/stats/base/dists/exponential/logcdf]: evaluate the natural logarithm of the cumulative distribution function for an exponential distribution. +- [`logcdf( x, lambda )`][@stdlib/stats/base/dists/exponential/logcdf]: exponential distribution logarithm of cumulative distribution function. - [`logpdf( x, lambda )`][@stdlib/stats/base/dists/exponential/logpdf]: evaluate the natural logarithm of the probability density function (PDF) for an exponential distribution. - [`mgf( t, lambda )`][@stdlib/stats/base/dists/exponential/mgf]: exponential distribution moment-generating function (MGF). - [`pdf( x, lambda )`][@stdlib/stats/base/dists/exponential/pdf]: exponential distribution probability density function (PDF). diff --git a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/README.md b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/README.md index cf1e143331bb..54473b4ecd0a 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/README.md @@ -46,7 +46,7 @@ The namespace contains the following distribution functions:
- [`cdf( x, alpha, beta )`][@stdlib/stats/base/dists/pareto-type1/cdf]: Pareto (Type I) distribution cumulative distribution function. -- [`logcdf( x, alpha, beta )`][@stdlib/stats/base/dists/pareto-type1/logcdf]: evaluate the natural logarithm of the cumulative distribution function for a Pareto (Type I) distribution. +- [`logcdf( x, alpha, beta )`][@stdlib/stats/base/dists/pareto-type1/logcdf]: Pareto (Type I) distribution logarithm of cumulative distribution function. - [`logpdf( x, alpha, beta )`][@stdlib/stats/base/dists/pareto-type1/logpdf]: evaluate the natural logarithm of the probability density function (PDF) for a Pareto (Type I) distribution. - [`pdf( x, alpha, beta )`][@stdlib/stats/base/dists/pareto-type1/pdf]: Pareto (Type I) distribution probability density function (PDF). - [`quantile( p, alpha, beta )`][@stdlib/stats/base/dists/pareto-type1/quantile]: Pareto (Type I) distribution quantile function.