README.md (11734B)
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 # Probability Distributions 22 23 > Standard library probability distribution modules. 24 25 <section class="usage"> 26 27 ## Usage 28 29 ```javascript 30 var dists = require( '@stdlib/stats/base/dists' ); 31 ``` 32 33 #### dists 34 35 Standard library probability distribution modules. 36 37 ```javascript 38 var distributions = dists; 39 // returns {...} 40 ``` 41 42 ### Continuous Distributions 43 44 <!-- <toc keywords="+continuous, -discrete"> --> 45 46 <div class="namespace-toc"> 47 48 - <span class="signature">[`arcsine`][@stdlib/stats/base/dists/arcsine]</span><span class="delimiter">: </span><span class="description">arcsine distribution.</span> 49 - <span class="signature">[`beta`][@stdlib/stats/base/dists/beta]</span><span class="delimiter">: </span><span class="description">beta distribution.</span> 50 - <span class="signature">[`betaprime`][@stdlib/stats/base/dists/betaprime]</span><span class="delimiter">: </span><span class="description">beta prime distribution.</span> 51 - <span class="signature">[`cauchy`][@stdlib/stats/base/dists/cauchy]</span><span class="delimiter">: </span><span class="description">Cauchy distribution.</span> 52 - <span class="signature">[`chi`][@stdlib/stats/base/dists/chi]</span><span class="delimiter">: </span><span class="description">Chi distribution.</span> 53 - <span class="signature">[`chisquare`][@stdlib/stats/base/dists/chisquare]</span><span class="delimiter">: </span><span class="description">Chi-squared distribution.</span> 54 - <span class="signature">[`cosine`][@stdlib/stats/base/dists/cosine]</span><span class="delimiter">: </span><span class="description">raised cosine distribution.</span> 55 - <span class="signature">[`erlang`][@stdlib/stats/base/dists/erlang]</span><span class="delimiter">: </span><span class="description">Erlang distribution.</span> 56 - <span class="signature">[`exponential`][@stdlib/stats/base/dists/exponential]</span><span class="delimiter">: </span><span class="description">exponential distribution.</span> 57 - <span class="signature">[`f`][@stdlib/stats/base/dists/f]</span><span class="delimiter">: </span><span class="description">fisher's F distribution.</span> 58 - <span class="signature">[`frechet`][@stdlib/stats/base/dists/frechet]</span><span class="delimiter">: </span><span class="description">Fréchet distribution.</span> 59 - <span class="signature">[`gamma`][@stdlib/stats/base/dists/gamma]</span><span class="delimiter">: </span><span class="description">gamma distribution.</span> 60 - <span class="signature">[`gumbel`][@stdlib/stats/base/dists/gumbel]</span><span class="delimiter">: </span><span class="description">Gumbel distribution.</span> 61 - <span class="signature">[`invgamma`][@stdlib/stats/base/dists/invgamma]</span><span class="delimiter">: </span><span class="description">inverse gamma distribution.</span> 62 - <span class="signature">[`kumaraswamy`][@stdlib/stats/base/dists/kumaraswamy]</span><span class="delimiter">: </span><span class="description">Kumaraswamy's double bounded distribution.</span> 63 - <span class="signature">[`laplace`][@stdlib/stats/base/dists/laplace]</span><span class="delimiter">: </span><span class="description">Laplace distribution.</span> 64 - <span class="signature">[`levy`][@stdlib/stats/base/dists/levy]</span><span class="delimiter">: </span><span class="description">Lévy distribution.</span> 65 - <span class="signature">[`logistic`][@stdlib/stats/base/dists/logistic]</span><span class="delimiter">: </span><span class="description">logistic distribution.</span> 66 - <span class="signature">[`lognormal`][@stdlib/stats/base/dists/lognormal]</span><span class="delimiter">: </span><span class="description">lognormal distribution.</span> 67 - <span class="signature">[`normal`][@stdlib/stats/base/dists/normal]</span><span class="delimiter">: </span><span class="description">normal distribution.</span> 68 - <span class="signature">[`pareto1`][@stdlib/stats/base/dists/pareto-type1]</span><span class="delimiter">: </span><span class="description">Pareto (Type I) distribution.</span> 69 - <span class="signature">[`rayleigh`][@stdlib/stats/base/dists/rayleigh]</span><span class="delimiter">: </span><span class="description">Rayleigh distribution.</span> 70 - <span class="signature">[`signrank`][@stdlib/stats/base/dists/signrank]</span><span class="delimiter">: </span><span class="description">distribution of the Wilcoxon signed rank test statistic.</span> 71 - <span class="signature">[`t`][@stdlib/stats/base/dists/t]</span><span class="delimiter">: </span><span class="description">Student's t distribution.</span> 72 - <span class="signature">[`triangular`][@stdlib/stats/base/dists/triangular]</span><span class="delimiter">: </span><span class="description">triangular distribution.</span> 73 - <span class="signature">[`truncatedNormal`][@stdlib/stats/base/dists/truncated-normal]</span><span class="delimiter">: </span><span class="description">truncated normal distribution.</span> 74 - <span class="signature">[`uniform`][@stdlib/stats/base/dists/uniform]</span><span class="delimiter">: </span><span class="description">continuous uniform distribution.</span> 75 76 </div> 77 78 <!-- </toc> --> 79 80 ### Discrete Distributions 81 82 <!-- <toc keywords="-continuous, +discrete"> --> 83 84 <div class="namespace-toc"> 85 86 - <span class="signature">[`bernoulli`][@stdlib/stats/base/dists/bernoulli]</span><span class="delimiter">: </span><span class="description">Bernoulli distribution.</span> 87 - <span class="signature">[`binomial`][@stdlib/stats/base/dists/binomial]</span><span class="delimiter">: </span><span class="description">binomial distribution.</span> 88 - <span class="signature">[`discreteUniform`][@stdlib/stats/base/dists/discrete-uniform]</span><span class="delimiter">: </span><span class="description">discrete uniform distribution.</span> 89 - <span class="signature">[`geometric`][@stdlib/stats/base/dists/geometric]</span><span class="delimiter">: </span><span class="description">geometric distribution.</span> 90 - <span class="signature">[`hypergeometric`][@stdlib/stats/base/dists/hypergeometric]</span><span class="delimiter">: </span><span class="description">hypergeometric distribution.</span> 91 - <span class="signature">[`negativeBinomial`][@stdlib/stats/base/dists/negative-binomial]</span><span class="delimiter">: </span><span class="description">negative binomial distribution.</span> 92 - <span class="signature">[`poisson`][@stdlib/stats/base/dists/poisson]</span><span class="delimiter">: </span><span class="description">Poisson distribution.</span> 93 94 </div> 95 96 <!-- </toc> --> 97 98 ### Other 99 100 <!-- <toc keywords="+degenerate"> --> 101 102 <div class="namespace-toc"> 103 104 - <span class="signature">[`degenerate`][@stdlib/stats/base/dists/degenerate]</span><span class="delimiter">: </span><span class="description">degenerate distribution.</span> 105 106 </div> 107 108 <!-- </toc> --> 109 110 </section> 111 112 <!-- /.usage --> 113 114 <section class="examples"> 115 116 ## Examples 117 118 <!-- TODO: better examples --> 119 120 <!-- eslint no-undef: "error" --> 121 122 ```javascript 123 var objectKeys = require( '@stdlib/utils/keys' ); 124 var dists = require( '@stdlib/stats/base/dists' ); 125 126 console.log( objectKeys( dists ) ); 127 ``` 128 129 </section> 130 131 <!-- /.examples --> 132 133 <section class="links"> 134 135 <!-- <toc-links> --> 136 137 [@stdlib/stats/base/dists/degenerate]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/degenerate 138 139 [@stdlib/stats/base/dists/bernoulli]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/bernoulli 140 141 [@stdlib/stats/base/dists/binomial]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/binomial 142 143 [@stdlib/stats/base/dists/discrete-uniform]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/discrete-uniform 144 145 [@stdlib/stats/base/dists/geometric]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/geometric 146 147 [@stdlib/stats/base/dists/hypergeometric]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/hypergeometric 148 149 [@stdlib/stats/base/dists/negative-binomial]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/negative-binomial 150 151 [@stdlib/stats/base/dists/poisson]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/poisson 152 153 [@stdlib/stats/base/dists/arcsine]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/arcsine 154 155 [@stdlib/stats/base/dists/beta]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/beta 156 157 [@stdlib/stats/base/dists/betaprime]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/betaprime 158 159 [@stdlib/stats/base/dists/cauchy]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/cauchy 160 161 [@stdlib/stats/base/dists/chi]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/chi 162 163 [@stdlib/stats/base/dists/chisquare]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/chisquare 164 165 [@stdlib/stats/base/dists/cosine]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/cosine 166 167 [@stdlib/stats/base/dists/erlang]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/erlang 168 169 [@stdlib/stats/base/dists/exponential]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/exponential 170 171 [@stdlib/stats/base/dists/f]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/f 172 173 [@stdlib/stats/base/dists/frechet]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/frechet 174 175 [@stdlib/stats/base/dists/gamma]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/gamma 176 177 [@stdlib/stats/base/dists/gumbel]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/gumbel 178 179 [@stdlib/stats/base/dists/invgamma]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/invgamma 180 181 [@stdlib/stats/base/dists/kumaraswamy]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/kumaraswamy 182 183 [@stdlib/stats/base/dists/laplace]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/laplace 184 185 [@stdlib/stats/base/dists/levy]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/levy 186 187 [@stdlib/stats/base/dists/logistic]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/logistic 188 189 [@stdlib/stats/base/dists/lognormal]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/lognormal 190 191 [@stdlib/stats/base/dists/normal]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/normal 192 193 [@stdlib/stats/base/dists/pareto-type1]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/pareto-type1 194 195 [@stdlib/stats/base/dists/rayleigh]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/rayleigh 196 197 [@stdlib/stats/base/dists/signrank]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/signrank 198 199 [@stdlib/stats/base/dists/t]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/t 200 201 [@stdlib/stats/base/dists/triangular]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/triangular 202 203 [@stdlib/stats/base/dists/truncated-normal]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/truncated-normal 204 205 [@stdlib/stats/base/dists/uniform]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/uniform 206 207 <!-- </toc-links> --> 208 209 </section> 210 211 <!-- /.links -->