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