README.md (6207B)
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 # Hypergeometric 22 23 > Hypergeometric distribution. 24 25 <section class="usage"> 26 27 ## Usage 28 29 ```javascript 30 var hypergeometric = require( '@stdlib/stats/base/dists/hypergeometric' ); 31 ``` 32 33 #### hypergeometric 34 35 Hypergeometric distribution. 36 37 ```javascript 38 var dist = hypergeometric; 39 // returns {...} 40 ``` 41 42 The namespace contains the following distribution functions: 43 44 <!-- <toc pattern="*+(cdf|pmf|mgf|quantile)*"> --> 45 46 <div class="namespace-toc"> 47 48 - <span class="signature">[`cdf( x, N, K, n )`][@stdlib/stats/base/dists/hypergeometric/cdf]</span><span class="delimiter">: </span><span class="description">hypergeometric distribution cumulative distribution function.</span> 49 - <span class="signature">[`logpmf( x, N, K, n )`][@stdlib/stats/base/dists/hypergeometric/logpmf]</span><span class="delimiter">: </span><span class="description">evaluate the natural logarithm of the probability mass function (PMF) for a hypergeometric distribution.</span> 50 - <span class="signature">[`pmf( x, N, K, n )`][@stdlib/stats/base/dists/hypergeometric/pmf]</span><span class="delimiter">: </span><span class="description">hypergeometric distribution probability mass function (PMF).</span> 51 - <span class="signature">[`quantile( p, N, K, n )`][@stdlib/stats/base/dists/hypergeometric/quantile]</span><span class="delimiter">: </span><span class="description">hypergeometric distribution quantile function.</span> 52 53 </div> 54 55 <!-- </toc> --> 56 57 The namespace contains the following functions for calculating distribution properties: 58 59 <!-- <toc pattern="*+(entropy|kurtosis|mean|median|mode|skewness|stdev|variance)*"> --> 60 61 <div class="namespace-toc"> 62 63 - <span class="signature">[`kurtosis( N, K, n )`][@stdlib/stats/base/dists/hypergeometric/kurtosis]</span><span class="delimiter">: </span><span class="description">hypergeometric distribution excess kurtosis.</span> 64 - <span class="signature">[`mean( N, K, n )`][@stdlib/stats/base/dists/hypergeometric/mean]</span><span class="delimiter">: </span><span class="description">hypergeometric distribution expected value.</span> 65 - <span class="signature">[`mode( N, K, n )`][@stdlib/stats/base/dists/hypergeometric/mode]</span><span class="delimiter">: </span><span class="description">hypergeometric distribution mode.</span> 66 - <span class="signature">[`skewness( N, K, n )`][@stdlib/stats/base/dists/hypergeometric/skewness]</span><span class="delimiter">: </span><span class="description">hypergeometric distribution skewness.</span> 67 - <span class="signature">[`stdev( N, K, n )`][@stdlib/stats/base/dists/hypergeometric/stdev]</span><span class="delimiter">: </span><span class="description">hypergeometric distribution standard deviation.</span> 68 - <span class="signature">[`variance( N, K, n )`][@stdlib/stats/base/dists/hypergeometric/variance]</span><span class="delimiter">: </span><span class="description">hypergeometric distribution variance.</span> 69 70 </div> 71 72 <!-- </toc> --> 73 74 The namespace contains a constructor function for creating a [hypergeometric][hypergeometric-distribution] distribution object. 75 76 <!-- <toc pattern="*ctor*"> --> 77 78 <div class="namespace-toc"> 79 80 - <span class="signature">[`Hypergeometric( N, K, n )`][@stdlib/stats/base/dists/hypergeometric/ctor]</span><span class="delimiter">: </span><span class="description">hypergeometric distribution constructor.</span> 81 82 </div> 83 84 <!-- </toc> --> 85 86 ```javascript 87 var Hypergeometric = require( '@stdlib/stats/base/dists/hypergeometric' ).Hypergeometric; 88 89 var dist = new Hypergeometric( 8, 2, 4 ); 90 91 var y = dist.cdf( 0.5 ); 92 // returns ~0.214 93 ``` 94 95 </section> 96 97 <!-- /.usage --> 98 99 <section class="examples"> 100 101 ## Examples 102 103 <!-- TODO: better examples --> 104 105 <!-- eslint no-undef: "error" --> 106 107 ```javascript 108 var objectKeys = require( '@stdlib/utils/keys' ); 109 var hypergeometric = require( '@stdlib/stats/base/dists/hypergeometric' ); 110 111 console.log( objectKeys( hypergeometric ) ); 112 ``` 113 114 </section> 115 116 <!-- /.examples --> 117 118 <section class="links"> 119 120 [hypergeometric-distribution]: https://en.wikipedia.org/wiki/Hypergeometric_distribution 121 122 <!-- <toc-links> --> 123 124 [@stdlib/stats/base/dists/hypergeometric/ctor]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/hypergeometric/ctor 125 126 [@stdlib/stats/base/dists/hypergeometric/kurtosis]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/hypergeometric/kurtosis 127 128 [@stdlib/stats/base/dists/hypergeometric/mean]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/hypergeometric/mean 129 130 [@stdlib/stats/base/dists/hypergeometric/mode]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/hypergeometric/mode 131 132 [@stdlib/stats/base/dists/hypergeometric/skewness]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/hypergeometric/skewness 133 134 [@stdlib/stats/base/dists/hypergeometric/stdev]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/hypergeometric/stdev 135 136 [@stdlib/stats/base/dists/hypergeometric/variance]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/hypergeometric/variance 137 138 [@stdlib/stats/base/dists/hypergeometric/cdf]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/hypergeometric/cdf 139 140 [@stdlib/stats/base/dists/hypergeometric/logpmf]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/hypergeometric/logpmf 141 142 [@stdlib/stats/base/dists/hypergeometric/pmf]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/hypergeometric/pmf 143 144 [@stdlib/stats/base/dists/hypergeometric/quantile]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/hypergeometric/quantile 145 146 <!-- </toc-links> --> 147 148 </section> 149 150 <!-- /.links -->