Skip to content

Commit f79b9dd

Browse files
committed
docs: fix and regenerate random namespace README
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 68446dc commit f79b9dd

File tree

1 file changed

+105
-1
lines changed

1 file changed

+105
-1
lines changed

lib/node_modules/@stdlib/random/README.md

Lines changed: 105 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,45 @@ The namespace exports the following functions to sample and shuffle elements fro
5454

5555
The namespace contains the following functions for generating pseudorandom values drawn from probability distributions:
5656

57-
<!-- <toc pattern="-(array|base|iter|streams|strided),-(sample|shuffle),-tools"> -->
57+
<!-- <toc pattern="*" ignore="array" ignore="base" ignore="iter" ignore="streams" ignore="strided" ignore="sample" ignore="shuffle" ignore="tools"> -->
58+
59+
<div class="namespace-toc">
60+
61+
- <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>
62+
- <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>
63+
- <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>
64+
- <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>
65+
- <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>
66+
- <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>
67+
- <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>
68+
- <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>
69+
- <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>
70+
- <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>
71+
- <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>
72+
- <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>
73+
- <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>
74+
- <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>
75+
- <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>
76+
- <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>
77+
- <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>
78+
- <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>
79+
- <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>
80+
- <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>
81+
- <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>
82+
- <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>
83+
- <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>
84+
- <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>
85+
- <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>
86+
- <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>
87+
- <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>
88+
- <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>
89+
- <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>
90+
- <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>
91+
- <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>
92+
- <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>
93+
- <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>
94+
95+
</div>
5896

5997
<!-- </toc> -->
6098

@@ -148,6 +186,72 @@ logEach( '%f, %f, %f', arr[ 0 ], arr[ 1 ], arr[ 2 ] );
148186

149187
[@stdlib/random/strided]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/strided
150188

189+
[@stdlib/random/arcsine]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/arcsine
190+
191+
[@stdlib/random/bernoulli]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/bernoulli
192+
193+
[@stdlib/random/beta]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/beta
194+
195+
[@stdlib/random/betaprime]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/betaprime
196+
197+
[@stdlib/random/binomial]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/binomial
198+
199+
[@stdlib/random/cauchy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/cauchy
200+
201+
[@stdlib/random/chi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/chi
202+
203+
[@stdlib/random/chisquare]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/chisquare
204+
205+
[@stdlib/random/cosine]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/cosine
206+
207+
[@stdlib/random/discrete-uniform]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/discrete-uniform
208+
209+
[@stdlib/random/erlang]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/erlang
210+
211+
[@stdlib/random/exponential]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/exponential
212+
213+
[@stdlib/random/f]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/f
214+
215+
[@stdlib/random/frechet]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/frechet
216+
217+
[@stdlib/random/gamma]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/gamma
218+
219+
[@stdlib/random/geometric]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/geometric
220+
221+
[@stdlib/random/gumbel]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/gumbel
222+
223+
[@stdlib/random/hypergeometric]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/hypergeometric
224+
225+
[@stdlib/random/invgamma]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/invgamma
226+
227+
[@stdlib/random/kumaraswamy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/kumaraswamy
228+
229+
[@stdlib/random/laplace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/laplace
230+
231+
[@stdlib/random/levy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/levy
232+
233+
[@stdlib/random/logistic]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/logistic
234+
235+
[@stdlib/random/lognormal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/lognormal
236+
237+
[@stdlib/random/negative-binomial]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/negative-binomial
238+
239+
[@stdlib/random/normal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/normal
240+
241+
[@stdlib/random/pareto-type1]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/pareto-type1
242+
243+
[@stdlib/random/poisson]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/poisson
244+
245+
[@stdlib/random/rayleigh]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/rayleigh
246+
247+
[@stdlib/random/t]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/t
248+
249+
[@stdlib/random/triangular]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/triangular
250+
251+
[@stdlib/random/uniform]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/uniform
252+
253+
[@stdlib/random/weibull]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/weibull
254+
151255
[@stdlib/random/sample]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/sample
152256

153257
[@stdlib/random/shuffle]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/shuffle

0 commit comments

Comments
 (0)