README.md (16282B)
1 <!-- 2 3 @license Apache-2.0 4 5 Copyright (c) 2018 The Stdlib Authors. 6 7 Licensed under the Apache License, Version 2.0 (the "License"); 8 you may not use this file except in compliance with the License. 9 You may obtain a copy of the License at 10 11 http://www.apache.org/licenses/LICENSE-2.0 12 13 Unless required by applicable law or agreed to in writing, software 14 distributed under the License is distributed on an "AS IS" BASIS, 15 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 See the License for the specific language governing permissions and 17 limitations under the License. 18 19 --> 20 21 # Pseudorandom Number Generator Iterators 22 23 > Standard library pseudorandom number generator (PRNG) iterators. 24 25 <section class="usage"> 26 27 ## Usage 28 29 ```javascript 30 var ns = require( '@stdlib/random/iter' ); 31 ``` 32 33 #### ns 34 35 Standard library pseudorandom number generator (PRNG) iterators. 36 37 ```javascript 38 var iterators = ns; 39 // returns {...} 40 ``` 41 42 The namespace contains the following functions for creating iterator protocol-compliant iterators: 43 44 <!-- <toc pattern="*"> --> 45 46 <div class="namespace-toc"> 47 48 - <span class="signature">[`arcsine( a, b[, options] )`][@stdlib/random/iter/arcsine]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from an arcsine distribution.</span> 49 - <span class="signature">[`bernoulli( p[, options] )`][@stdlib/random/iter/bernoulli]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a Bernoulli distribution.</span> 50 - <span class="signature">[`beta( alpha, beta[, options] )`][@stdlib/random/iter/beta]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a beta distribution.</span> 51 - <span class="signature">[`betaprime( alpha, beta[, options] )`][@stdlib/random/iter/betaprime]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a beta prime distribution.</span> 52 - <span class="signature">[`binomial( n, p[, options] )`][@stdlib/random/iter/binomial]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a binomial distribution.</span> 53 - <span class="signature">[`boxMuller( [options] )`][@stdlib/random/iter/box-muller]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a standard normal distribution using the Box-Muller transform.</span> 54 - <span class="signature">[`cauchy( x0, gamma[, options] )`][@stdlib/random/iter/cauchy]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a Cauchy distribution.</span> 55 - <span class="signature">[`chi( k[, options] )`][@stdlib/random/iter/chi]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a chi distribution.</span> 56 - <span class="signature">[`chisquare( k[, options] )`][@stdlib/random/iter/chisquare]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a chi-square distribution.</span> 57 - <span class="signature">[`cosine( mu, s[, options] )`][@stdlib/random/iter/cosine]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a raised cosine distribution.</span> 58 - <span class="signature">[`discreteUniform( a, b[, options] )`][@stdlib/random/iter/discrete-uniform]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a discrete uniform distribution.</span> 59 - <span class="signature">[`erlang( k, lambda[, options] )`][@stdlib/random/iter/erlang]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from an Erlang distribution.</span> 60 - <span class="signature">[`exponential( lambda[, options] )`][@stdlib/random/iter/exponential]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from an exponential distribution.</span> 61 - <span class="signature">[`f( d1, d2[, options] )`][@stdlib/random/iter/f]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from an F distribution.</span> 62 - <span class="signature">[`frechet( alpha, s, m[, options] )`][@stdlib/random/iter/frechet]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a Fréchet distribution.</span> 63 - <span class="signature">[`gamma( alpha, beta[, options] )`][@stdlib/random/iter/gamma]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a gamma distribution.</span> 64 - <span class="signature">[`geometric( p[, options] )`][@stdlib/random/iter/geometric]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a geometric distribution.</span> 65 - <span class="signature">[`gumbel( mu, beta[, options] )`][@stdlib/random/iter/gumbel]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a Gumbel distribution.</span> 66 - <span class="signature">[`hypergeometric( N, K, n[, options] )`][@stdlib/random/iter/hypergeometric]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a hypergeometric distribution.</span> 67 - <span class="signature">[`improvedZiggurat( [options] )`][@stdlib/random/iter/improved-ziggurat]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a standard normal distribution using the Improved Ziggurat algorithm.</span> 68 - <span class="signature">[`invgamma( alpha, beta[, options] )`][@stdlib/random/iter/invgamma]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from an inverse gamma distribution.</span> 69 - <span class="signature">[`kumaraswamy( a, b[, options] )`][@stdlib/random/iter/kumaraswamy]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a Kumaraswamy's double bounded distribution.</span> 70 - <span class="signature">[`laplace( mu, b[, options] )`][@stdlib/random/iter/laplace]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a Laplace (double exponential) distribution.</span> 71 - <span class="signature">[`levy( mu, c[, options] )`][@stdlib/random/iter/levy]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a Lévy distribution.</span> 72 - <span class="signature">[`logistic( mu, s[, options] )`][@stdlib/random/iter/logistic]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a logistic distribution.</span> 73 - <span class="signature">[`lognormal( mu, sigma[, options] )`][@stdlib/random/iter/lognormal]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a lognormal distribution.</span> 74 - <span class="signature">[`minstdShuffle( [options] )`][@stdlib/random/iter/minstd-shuffle]</span><span class="delimiter">: </span><span class="description">create an iterator for a linear congruential pseudorandom number generator (LCG) whose output is shuffled.</span> 75 - <span class="signature">[`minstd( [options] )`][@stdlib/random/iter/minstd]</span><span class="delimiter">: </span><span class="description">create an iterator for a linear congruential pseudorandom number generator (LCG) based on Park and Miller.</span> 76 - <span class="signature">[`mt19937( [options] )`][@stdlib/random/iter/mt19937]</span><span class="delimiter">: </span><span class="description">create an iterator for a 32-bit Mersenne Twister pseudorandom number generator.</span> 77 - <span class="signature">[`negativeBinomial( r, p[, options] )`][@stdlib/random/iter/negative-binomial]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a negative binomial distribution.</span> 78 - <span class="signature">[`normal( mu, sigma[, options] )`][@stdlib/random/iter/normal]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a normal distribution.</span> 79 - <span class="signature">[`pareto1( alpha, beta[, options] )`][@stdlib/random/iter/pareto-type1]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a Pareto (Type I) distribution.</span> 80 - <span class="signature">[`poisson( lambda[, options] )`][@stdlib/random/iter/poisson]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a Poisson distribution.</span> 81 - <span class="signature">[`randi( [options] )`][@stdlib/random/iter/randi]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers having integer values.</span> 82 - <span class="signature">[`randn( [options] )`][@stdlib/random/iter/randn]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a standard normal distribution.</span> 83 - <span class="signature">[`randu( [options] )`][@stdlib/random/iter/randu]</span><span class="delimiter">: </span><span class="description">create an iterator for generating uniformly distributed pseudorandom numbers between `0` and `1`.</span> 84 - <span class="signature">[`rayleigh( sigma[, options] )`][@stdlib/random/iter/rayleigh]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a Rayleigh distribution.</span> 85 - <span class="signature">[`t( v[, options] )`][@stdlib/random/iter/t]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a Student's t distribution.</span> 86 - <span class="signature">[`triangular( a, b, c[, options] )`][@stdlib/random/iter/triangular]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a triangular distribution.</span> 87 - <span class="signature">[`uniform( a, b[, options] )`][@stdlib/random/iter/uniform]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a continuous uniform distribution.</span> 88 - <span class="signature">[`weibull( k, lambda[, options] )`][@stdlib/random/iter/weibull]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a Weibull distribution.</span> 89 90 </div> 91 92 <!-- </toc> --> 93 94 </section> 95 96 <!-- /.usage --> 97 98 <section class="examples"> 99 100 ## Examples 101 102 <!-- TODO: better examples --> 103 104 <!-- eslint no-undef: "error" --> 105 106 ```javascript 107 var objectKeys = require( '@stdlib/utils/keys' ); 108 var ns = require( '@stdlib/random/iter' ); 109 110 console.log( objectKeys( ns ) ); 111 ``` 112 113 </section> 114 115 <!-- /.examples --> 116 117 <section class="links"> 118 119 <!-- <toc-links> --> 120 121 [@stdlib/random/iter/arcsine]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/arcsine 122 123 [@stdlib/random/iter/bernoulli]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/bernoulli 124 125 [@stdlib/random/iter/beta]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/beta 126 127 [@stdlib/random/iter/betaprime]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/betaprime 128 129 [@stdlib/random/iter/binomial]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/binomial 130 131 [@stdlib/random/iter/box-muller]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/box-muller 132 133 [@stdlib/random/iter/cauchy]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/cauchy 134 135 [@stdlib/random/iter/chi]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/chi 136 137 [@stdlib/random/iter/chisquare]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/chisquare 138 139 [@stdlib/random/iter/cosine]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/cosine 140 141 [@stdlib/random/iter/discrete-uniform]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/discrete-uniform 142 143 [@stdlib/random/iter/erlang]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/erlang 144 145 [@stdlib/random/iter/exponential]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/exponential 146 147 [@stdlib/random/iter/f]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/f 148 149 [@stdlib/random/iter/frechet]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/frechet 150 151 [@stdlib/random/iter/gamma]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/gamma 152 153 [@stdlib/random/iter/geometric]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/geometric 154 155 [@stdlib/random/iter/gumbel]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/gumbel 156 157 [@stdlib/random/iter/hypergeometric]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/hypergeometric 158 159 [@stdlib/random/iter/improved-ziggurat]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/improved-ziggurat 160 161 [@stdlib/random/iter/invgamma]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/invgamma 162 163 [@stdlib/random/iter/kumaraswamy]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/kumaraswamy 164 165 [@stdlib/random/iter/laplace]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/laplace 166 167 [@stdlib/random/iter/levy]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/levy 168 169 [@stdlib/random/iter/logistic]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/logistic 170 171 [@stdlib/random/iter/lognormal]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/lognormal 172 173 [@stdlib/random/iter/minstd-shuffle]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/minstd-shuffle 174 175 [@stdlib/random/iter/minstd]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/minstd 176 177 [@stdlib/random/iter/mt19937]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/mt19937 178 179 [@stdlib/random/iter/negative-binomial]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/negative-binomial 180 181 [@stdlib/random/iter/normal]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/normal 182 183 [@stdlib/random/iter/pareto-type1]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/pareto-type1 184 185 [@stdlib/random/iter/poisson]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/poisson 186 187 [@stdlib/random/iter/randi]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/randi 188 189 [@stdlib/random/iter/randn]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/randn 190 191 [@stdlib/random/iter/randu]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/randu 192 193 [@stdlib/random/iter/rayleigh]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/rayleigh 194 195 [@stdlib/random/iter/t]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/t 196 197 [@stdlib/random/iter/triangular]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/triangular 198 199 [@stdlib/random/iter/uniform]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/uniform 200 201 [@stdlib/random/iter/weibull]: https://www.npmjs.com/package/@stdlib/random/tree/main/iter/weibull 202 203 <!-- </toc-links> --> 204 205 </section> 206 207 <!-- /.links -->