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