Skip to content

docs: update namespace table of contents #12141

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kgryte merged 1 commit into from
May 15, 2026
Merged

docs: update namespace table of contents #12141

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ var o = ns;
<div class="namespace-toc">

- <span class="signature">[`cfill( N, alpha, x, strideX )`][@stdlib/blas/ext/base/cfill]</span><span class="delimiter">: </span><span class="description">fill a single-precision complex floating-point strided array with a specified scalar constant.</span>
- <span class="signature">[`cindexOfColumn( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/cindex-of-column]</span><span class="delimiter">: </span><span class="description">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.</span>
- <span class="signature">[`cindexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/cindex-of-row]</span><span class="delimiter">: </span><span class="description">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.</span>
- <span class="signature">[`cindexOf( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/cindex-of]</span><span class="delimiter">: </span><span class="description">return the first index of a specified search element in a single-precision complex floating-point strided array.</span>
- <span class="signature">[`clastIndexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/clast-index-of-row]</span><span class="delimiter">: </span><span class="description">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.</span>
Expand Down Expand Up @@ -233,6 +234,7 @@ var o = ns;
- <span class="signature">[`szeroTo( N, x, strideX )`][@stdlib/blas/ext/base/szero-to]</span><span class="delimiter">: </span><span class="description">fill a single-precision floating-point strided array with linearly spaced numeric elements which increment by `1` starting from zero.</span>
- <span class="signature">[`wasm`][@stdlib/blas/ext/base/wasm]</span><span class="delimiter">: </span><span class="description">extensions to basic linear algebra subprograms (BLAS) compiled to WebAssembly.</span>
- <span class="signature">[`zfill( N, alpha, x, strideX )`][@stdlib/blas/ext/base/zfill]</span><span class="delimiter">: </span><span class="description">fill a double-precision complex floating-point strided array with a specified scalar constant.</span>
- <span class="signature">[`zindexOfColumn( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/zindex-of-column]</span><span class="delimiter">: </span><span class="description">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.</span>
- <span class="signature">[`zindexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/zindex-of-row]</span><span class="delimiter">: </span><span class="description">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.</span>
- <span class="signature">[`zindexOf( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/zindex-of]</span><span class="delimiter">: </span><span class="description">return the first index of a specified search element in a double-precision complex floating-point strided array.</span>
- <span class="signature">[`zlastIndexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/zlast-index-of-row]</span><span class="delimiter">: </span><span class="description">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.</span>
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/ndarray/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ The namespace exports the following functions to create multidimensional arrays:
- <span class="signature">[`scalar2ndarrayLike( x, value[, options] )`][@stdlib/ndarray/from-scalar-like]</span><span class="delimiter">: </span><span class="description">convert a scalar value to a zero-dimensional ndarray having the same data-type as a provided ndarray.</span>
- <span class="signature">[`scalar2ndarray( value[, options] )`][@stdlib/ndarray/from-scalar]</span><span class="delimiter">: </span><span class="description">convert a scalar value to a zero-dimensional ndarray.</span>
- <span class="signature">[`nansLike( x[, options] )`][@stdlib/ndarray/nans-like]</span><span class="delimiter">: </span><span class="description">create a NaN-filled ndarray having the same shape and data type as a provided ndarray.</span>
- <span class="signature">[`nans( shape[, options] )`][@stdlib/ndarray/nans]</span><span class="delimiter">: </span><span class="description">create a NaN-filled ndarray having a specified shape and data type.</span>
- <span class="signature">[`ndarraylike2ndarray( x[, options] )`][@stdlib/ndarray/ndarraylike2ndarray]</span><span class="delimiter">: </span><span class="description">convert an ndarray-like object to an `ndarray`.</span>
- <span class="signature">[`onesLike( x[, options] )`][@stdlib/ndarray/ones-like]</span><span class="delimiter">: </span><span class="description">create a ones-filled ndarray having the same shape and data type as a provided ndarray.</span>
- <span class="signature">[`ones( shape[, options] )`][@stdlib/ndarray/ones]</span><span class="delimiter">: </span><span class="description">create a ones-filled ndarray having a specified shape and data type.</span>
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/base/dists/discrete-uniform/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ The namespace contains the following distribution functions:
<div class="namespace-toc">

- <span class="signature">[`cdf( x, a, b )`][@stdlib/stats/base/dists/discrete-uniform/cdf]</span><span class="delimiter">: </span><span class="description">discrete uniform distribution cumulative distribution function.</span>
- <span class="signature">[`logcdf( x, a, b )`][@stdlib/stats/base/dists/discrete-uniform/logcdf]</span><span class="delimiter">: </span><span class="description">evaluate the natural logarithm of the cumulative distribution function for a discrete uniform distribution.</span>
- <span class="signature">[`logcdf( x, a, b )`][@stdlib/stats/base/dists/discrete-uniform/logcdf]</span><span class="delimiter">: </span><span class="description">discrete uniform distribution logarithm of cumulative distribution function.</span>
- <span class="signature">[`logpmf( x, a, b )`][@stdlib/stats/base/dists/discrete-uniform/logpmf]</span><span class="delimiter">: </span><span class="description">evaluate the natural logarithm of the probability mass function (PMF) for a discrete uniform distribution.</span>
- <span class="signature">[`mgf( t, a, b )`][@stdlib/stats/base/dists/discrete-uniform/mgf]</span><span class="delimiter">: </span><span class="description">discrete uniform distribution moment-generating function (MGF).</span>
- <span class="signature">[`pmf( x, a, b )`][@stdlib/stats/base/dists/discrete-uniform/pmf]</span><span class="delimiter">: </span><span class="description">discrete uniform distribution probability mass function (PMF).</span>
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/base/dists/exponential/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ The namespace contains the following distribution functions:
<div class="namespace-toc">

- <span class="signature">[`cdf( x, lambda )`][@stdlib/stats/base/dists/exponential/cdf]</span><span class="delimiter">: </span><span class="description">exponential distribution cumulative distribution function.</span>
- <span class="signature">[`logcdf( x, lambda )`][@stdlib/stats/base/dists/exponential/logcdf]</span><span class="delimiter">: </span><span class="description">evaluate the natural logarithm of the cumulative distribution function for an exponential distribution.</span>
- <span class="signature">[`logcdf( x, lambda )`][@stdlib/stats/base/dists/exponential/logcdf]</span><span class="delimiter">: </span><span class="description">exponential distribution logarithm of cumulative distribution function.</span>
- <span class="signature">[`logpdf( x, lambda )`][@stdlib/stats/base/dists/exponential/logpdf]</span><span class="delimiter">: </span><span class="description">evaluate the natural logarithm of the probability density function (PDF) for an exponential distribution.</span>
- <span class="signature">[`mgf( t, lambda )`][@stdlib/stats/base/dists/exponential/mgf]</span><span class="delimiter">: </span><span class="description">exponential distribution moment-generating function (MGF).</span>
- <span class="signature">[`pdf( x, lambda )`][@stdlib/stats/base/dists/exponential/pdf]</span><span class="delimiter">: </span><span class="description">exponential distribution probability density function (PDF).</span>
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/base/dists/pareto-type1/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ The namespace contains the following distribution functions:
<div class="namespace-toc">

- <span class="signature">[`cdf( x, alpha, beta )`][@stdlib/stats/base/dists/pareto-type1/cdf]</span><span class="delimiter">: </span><span class="description">Pareto (Type I) distribution cumulative distribution function.</span>
- <span class="signature">[`logcdf( x, alpha, beta )`][@stdlib/stats/base/dists/pareto-type1/logcdf]</span><span class="delimiter">: </span><span class="description">evaluate the natural logarithm of the cumulative distribution function for a Pareto (Type I) distribution.</span>
- <span class="signature">[`logcdf( x, alpha, beta )`][@stdlib/stats/base/dists/pareto-type1/logcdf]</span><span class="delimiter">: </span><span class="description">Pareto (Type I) distribution logarithm of cumulative distribution function.</span>
- <span class="signature">[`logpdf( x, alpha, beta )`][@stdlib/stats/base/dists/pareto-type1/logpdf]</span><span class="delimiter">: </span><span class="description">evaluate the natural logarithm of the probability density function (PDF) for a Pareto (Type I) distribution.</span>
- <span class="signature">[`pdf( x, alpha, beta )`][@stdlib/stats/base/dists/pareto-type1/pdf]</span><span class="delimiter">: </span><span class="description">Pareto (Type I) distribution probability density function (PDF).</span>
- <span class="signature">[`quantile( p, alpha, beta )`][@stdlib/stats/base/dists/pareto-type1/quantile]</span><span class="delimiter">: </span><span class="description">Pareto (Type I) distribution quantile function.</span>
Expand Down