README.md (6400B)
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 # Erlang 22 23 > Erlang distribution. 24 25 <section class="usage"> 26 27 ## Usage 28 29 ```javascript 30 var erlang = require( '@stdlib/stats/base/dists/erlang' ); 31 ``` 32 33 #### erlang 34 35 Erlang distribution. 36 37 ```javascript 38 var dist = erlang; 39 // returns {...} 40 ``` 41 42 The namespace contains the following distribution functions: 43 44 <!-- <toc pattern="*+(cdf|pdf|mgf|quantile)*"> --> 45 46 <div class="namespace-toc"> 47 48 - <span class="signature">[`cdf( x, k, lambda )`][@stdlib/stats/base/dists/erlang/cdf]</span><span class="delimiter">: </span><span class="description">Erlang distribution cumulative distribution function.</span> 49 - <span class="signature">[`logpdf( x, k, lambda )`][@stdlib/stats/base/dists/erlang/logpdf]</span><span class="delimiter">: </span><span class="description">evaluate the natural logarithm of the probability density function (PDF) for an Erlang distribution.</span> 50 - <span class="signature">[`mgf( t, k, lambda )`][@stdlib/stats/base/dists/erlang/mgf]</span><span class="delimiter">: </span><span class="description">Erlang distribution moment-generating function (MGF).</span> 51 - <span class="signature">[`pdf( x, k, lambda )`][@stdlib/stats/base/dists/erlang/pdf]</span><span class="delimiter">: </span><span class="description">Erlang distribution probability density function (PDF).</span> 52 - <span class="signature">[`quantile( p, k, lambda )`][@stdlib/stats/base/dists/erlang/quantile]</span><span class="delimiter">: </span><span class="description">Erlang 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( k, lambda )`][@stdlib/stats/base/dists/erlang/entropy]</span><span class="delimiter">: </span><span class="description">Erlang distribution differential entropy.</span> 65 - <span class="signature">[`kurtosis( k, lambda )`][@stdlib/stats/base/dists/erlang/kurtosis]</span><span class="delimiter">: </span><span class="description">Erlang distribution excess kurtosis.</span> 66 - <span class="signature">[`mean( k, lambda )`][@stdlib/stats/base/dists/erlang/mean]</span><span class="delimiter">: </span><span class="description">Erlang distribution expected value.</span> 67 - <span class="signature">[`mode( k, lambda )`][@stdlib/stats/base/dists/erlang/mode]</span><span class="delimiter">: </span><span class="description">Erlang distribution mode.</span> 68 - <span class="signature">[`skewness( k, lambda )`][@stdlib/stats/base/dists/erlang/skewness]</span><span class="delimiter">: </span><span class="description">Erlang distribution skewness.</span> 69 - <span class="signature">[`stdev( k, lambda )`][@stdlib/stats/base/dists/erlang/stdev]</span><span class="delimiter">: </span><span class="description">Erlang distribution standard deviation.</span> 70 - <span class="signature">[`variance( k, lambda )`][@stdlib/stats/base/dists/erlang/variance]</span><span class="delimiter">: </span><span class="description">Erlang distribution variance.</span> 71 72 </div> 73 74 <!-- </toc> --> 75 76 The namespace contains a constructor function for creating an [Erlang][erlang-distribution] distribution object. 77 78 <!-- <toc pattern="*ctor*"> --> 79 80 <div class="namespace-toc"> 81 82 - <span class="signature">[`Erlang( [k, lambda] )`][@stdlib/stats/base/dists/erlang/ctor]</span><span class="delimiter">: </span><span class="description">Erlang distribution constructor.</span> 83 84 </div> 85 86 <!-- </toc> --> 87 88 ```javascript 89 var Erlang = require( '@stdlib/stats/base/dists/erlang' ).Erlang; 90 91 var dist = new Erlang( 2, 4.0 ); 92 93 var y = dist.logpdf( 0.8 ); 94 // returns ~-0.65 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 erlang = require( '@stdlib/stats/base/dists/erlang' ); 112 113 console.log( objectKeys( erlang ) ); 114 ``` 115 116 </section> 117 118 <!-- /.examples --> 119 120 <section class="links"> 121 122 [erlang-distribution]: https://en.wikipedia.org/wiki/Erlang_distribution 123 124 <!-- <toc-links> --> 125 126 [@stdlib/stats/base/dists/erlang/ctor]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/erlang/ctor 127 128 [@stdlib/stats/base/dists/erlang/entropy]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/erlang/entropy 129 130 [@stdlib/stats/base/dists/erlang/kurtosis]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/erlang/kurtosis 131 132 [@stdlib/stats/base/dists/erlang/mean]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/erlang/mean 133 134 [@stdlib/stats/base/dists/erlang/mode]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/erlang/mode 135 136 [@stdlib/stats/base/dists/erlang/skewness]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/erlang/skewness 137 138 [@stdlib/stats/base/dists/erlang/stdev]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/erlang/stdev 139 140 [@stdlib/stats/base/dists/erlang/variance]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/erlang/variance 141 142 [@stdlib/stats/base/dists/erlang/cdf]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/erlang/cdf 143 144 [@stdlib/stats/base/dists/erlang/logpdf]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/erlang/logpdf 145 146 [@stdlib/stats/base/dists/erlang/mgf]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/erlang/mgf 147 148 [@stdlib/stats/base/dists/erlang/pdf]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/erlang/pdf 149 150 [@stdlib/stats/base/dists/erlang/quantile]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/erlang/quantile 151 152 <!-- </toc-links> --> 153 154 </section> 155 156 <!-- /.links -->