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