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