Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -168,6 +168,7 @@ A total of 10 issues were closed in this release:
 
 <details>
 
+-   [`f79b9dd`](https://github.com/stdlib-js/stdlib/commit/f79b9dd302d7278cb14028a3e847293a83403cf9) - **docs:** fix and regenerate `random` namespace README _(by Philipp Burckhardt)_
 -   [`68446dc`](https://github.com/stdlib-js/stdlib/commit/68446dcb55d7b08e39baf6efae7ba5ba038c923f) - **docs:** update namespace table of contents [(#9848)](https://github.com/stdlib-js/stdlib/pull/9848) _(by stdlib-bot)_
 -   [`0472076`](https://github.com/stdlib-js/stdlib/commit/04720767c484e6277ad9411dff3dc5a116c31378) - **docs:** remove duplicated words in documentation and comments _(by Philipp Burckhardt)_
 -   [`8b93c8d`](https://github.com/stdlib-js/stdlib/commit/8b93c8d51432c3ceb2a41f80bda77f77021e021e) - **feat:** update `random/tools` TypeScript declarations [(#9718)](https://github.com/stdlib-js/stdlib/pull/9718) _(by stdlib-bot)_

README.md

@@ -87,7 +87,45 @@ The namespace exports the following functions to sample and shuffle elements fro
 
 The namespace contains the following functions for generating pseudorandom values drawn from probability distributions:
 
-<!-- <toc pattern="-(array|base|iter|streams|strided),-(sample|shuffle),-tools"> -->
+<!-- <toc pattern="*" ignore="array" ignore="base" ignore="iter" ignore="streams" ignore="strided" ignore="sample" ignore="shuffle" ignore="tools"> -->
+
+<div class="namespace-toc">
+
+-   <span class="signature">[`arcsine( shape, a, b[, options] )`][@stdlib/random/arcsine]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from an arcsine distribution.</span>
+-   <span class="signature">[`bernoulli( shape, p[, options] )`][@stdlib/random/bernoulli]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from a Bernoulli distribution.</span>
+-   <span class="signature">[`beta( shape, a, b[, options] )`][@stdlib/random/beta]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from a beta distribution.</span>
+-   <span class="signature">[`betaprime( shape, alpha, beta[, options] )`][@stdlib/random/betaprime]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from a betaprime distribution.</span>
+-   <span class="signature">[`binomial( shape, n, p[, options] )`][@stdlib/random/binomial]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from a binomial distribution.</span>
+-   <span class="signature">[`cauchy( shape, x0, gamma[, options] )`][@stdlib/random/cauchy]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from a Cauchy distribution.</span>
+-   <span class="signature">[`chi( shape, k[, options] )`][@stdlib/random/chi]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from a chi distribution.</span>
+-   <span class="signature">[`chisquare( shape, k[, options] )`][@stdlib/random/chisquare]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from a chi-square distribution.</span>
+-   <span class="signature">[`cosine( shape, mu, s[, options] )`][@stdlib/random/cosine]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from a raised cosine distribution.</span>
+-   <span class="signature">[`discreteUniform( shape, a, b[, options] )`][@stdlib/random/discrete-uniform]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from a discrete uniform distribution.</span>
+-   <span class="signature">[`erlang( shape, k, lambda[, options] )`][@stdlib/random/erlang]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from an Erlang distribution.</span>
+-   <span class="signature">[`exponential( shape, lambda[, options] )`][@stdlib/random/exponential]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from an exponential distribution.</span>
+-   <span class="signature">[`f( shape, d1, d2[, options] )`][@stdlib/random/f]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from an F distribution.</span>
+-   <span class="signature">[`frechet( shape, alpha, s, m[, options] )`][@stdlib/random/frechet]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from a Fréchet distribution.</span>
+-   <span class="signature">[`gamma( shape, alpha, beta[, options] )`][@stdlib/random/gamma]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from a gamma distribution.</span>
+-   <span class="signature">[`geometric( shape, p[, options] )`][@stdlib/random/geometric]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from a geometric distribution.</span>
+-   <span class="signature">[`gumbel( shape, mu, beta[, options] )`][@stdlib/random/gumbel]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from a Gumbel distribution.</span>
+-   <span class="signature">[`hypergeometric( shape, N, K, n[, options] )`][@stdlib/random/hypergeometric]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from a hypergeometric distribution.</span>
+-   <span class="signature">[`invgamma( shape, alpha, beta[, options] )`][@stdlib/random/invgamma]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from an inverse gamma distribution.</span>
+-   <span class="signature">[`kumaraswamy( shape, a, b[, options] )`][@stdlib/random/kumaraswamy]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from a Kumaraswamy distribution.</span>
+-   <span class="signature">[`laplace( shape, mu, b[, options] )`][@stdlib/random/laplace]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from a Laplace (double exponential) distribution.</span>
+-   <span class="signature">[`levy( shape, mu, c[, options] )`][@stdlib/random/levy]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from a Lévy distribution.</span>
+-   <span class="signature">[`logistic( shape, mu, s[, options] )`][@stdlib/random/logistic]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from a logistic distribution.</span>
+-   <span class="signature">[`lognormal( shape, mu, sigma[, options] )`][@stdlib/random/lognormal]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from a lognormal distribution.</span>
+-   <span class="signature">[`negativeBinomial( shape, r, p[, options] )`][@stdlib/random/negative-binomial]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from a negative binomial distribution.</span>
+-   <span class="signature">[`normal( shape, mu, sigma[, options] )`][@stdlib/random/normal]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from a normal distribution.</span>
+-   <span class="signature">[`pareto1( shape, alpha, beta[, options] )`][@stdlib/random/pareto-type1]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from a Pareto (Type I) distribution.</span>
+-   <span class="signature">[`poisson( shape, lambda[, options] )`][@stdlib/random/poisson]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from a Poisson distribution.</span>
+-   <span class="signature">[`rayleigh( shape, sigma[, options] )`][@stdlib/random/rayleigh]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from a Rayleigh distribution.</span>
+-   <span class="signature">[`t( shape, v[, options] )`][@stdlib/random/t]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from a Student's t-distribution.</span>
+-   <span class="signature">[`triangular( shape, a, b, c[, options] )`][@stdlib/random/triangular]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from a triangular distribution.</span>
+-   <span class="signature">[`uniform( shape, a, b[, options] )`][@stdlib/random/uniform]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from a continuous uniform distribution.</span>
+-   <span class="signature">[`weibull( shape, k, lambda[, options] )`][@stdlib/random/weibull]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from a Weibull distribution.</span>
+
+</div>
 
 <!-- </toc> -->
 
@@ -249,6 +287,72 @@ Copyright &copy; 2016-2026. The Stdlib [Authors][stdlib-authors].
 
 [@stdlib/random/strided]: https://github.com/stdlib-js/random/tree/main/strided
 
+[@stdlib/random/arcsine]: https://github.com/stdlib-js/random/tree/main/arcsine
+
+[@stdlib/random/bernoulli]: https://github.com/stdlib-js/random/tree/main/bernoulli
+
+[@stdlib/random/beta]: https://github.com/stdlib-js/random/tree/main/beta
+
+[@stdlib/random/betaprime]: https://github.com/stdlib-js/random/tree/main/betaprime
+
+[@stdlib/random/binomial]: https://github.com/stdlib-js/random/tree/main/binomial
+
+[@stdlib/random/cauchy]: https://github.com/stdlib-js/random/tree/main/cauchy
+
+[@stdlib/random/chi]: https://github.com/stdlib-js/random/tree/main/chi
+
+[@stdlib/random/chisquare]: https://github.com/stdlib-js/random/tree/main/chisquare
+
+[@stdlib/random/cosine]: https://github.com/stdlib-js/random/tree/main/cosine
+
+[@stdlib/random/discrete-uniform]: https://github.com/stdlib-js/random/tree/main/discrete-uniform
+
+[@stdlib/random/erlang]: https://github.com/stdlib-js/random/tree/main/erlang
+
+[@stdlib/random/exponential]: https://github.com/stdlib-js/random/tree/main/exponential
+
+[@stdlib/random/f]: https://github.com/stdlib-js/random/tree/main/f
+
+[@stdlib/random/frechet]: https://github.com/stdlib-js/random/tree/main/frechet
+
+[@stdlib/random/gamma]: https://github.com/stdlib-js/random/tree/main/gamma
+
+[@stdlib/random/geometric]: https://github.com/stdlib-js/random/tree/main/geometric
+
+[@stdlib/random/gumbel]: https://github.com/stdlib-js/random/tree/main/gumbel
+
+[@stdlib/random/hypergeometric]: https://github.com/stdlib-js/random/tree/main/hypergeometric
+
+[@stdlib/random/invgamma]: https://github.com/stdlib-js/random/tree/main/invgamma
+
+[@stdlib/random/kumaraswamy]: https://github.com/stdlib-js/random/tree/main/kumaraswamy
+
+[@stdlib/random/laplace]: https://github.com/stdlib-js/random/tree/main/laplace
+
+[@stdlib/random/levy]: https://github.com/stdlib-js/random/tree/main/levy
+
+[@stdlib/random/logistic]: https://github.com/stdlib-js/random/tree/main/logistic
+
+[@stdlib/random/lognormal]: https://github.com/stdlib-js/random/tree/main/lognormal
+
+[@stdlib/random/negative-binomial]: https://github.com/stdlib-js/random/tree/main/negative-binomial
+
+[@stdlib/random/normal]: https://github.com/stdlib-js/random/tree/main/normal
+
+[@stdlib/random/pareto-type1]: https://github.com/stdlib-js/random/tree/main/pareto-type1
+
+[@stdlib/random/poisson]: https://github.com/stdlib-js/random/tree/main/poisson
+
+[@stdlib/random/rayleigh]: https://github.com/stdlib-js/random/tree/main/rayleigh
+
+[@stdlib/random/t]: https://github.com/stdlib-js/random/tree/main/t
+
+[@stdlib/random/triangular]: https://github.com/stdlib-js/random/tree/main/triangular
+
+[@stdlib/random/uniform]: https://github.com/stdlib-js/random/tree/main/uniform
+
+[@stdlib/random/weibull]: https://github.com/stdlib-js/random/tree/main/weibull
+
 [@stdlib/random/sample]: https://github.com/stdlib-js/random/tree/main/sample
 
 [@stdlib/random/shuffle]: https://github.com/stdlib-js/random/tree/main/shuffle