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