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