time-to-botec/squiggle/node_modules/@stdlib/stats/base/dists/weibull/README.md

163 lines
6.9 KiB
Markdown
Raw Normal View History

<!--
@license Apache-2.0
Copyright (c) 2018 The Stdlib Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
# Weibull
> Weibull distribution.
<section class="usage">
## Usage
```javascript
var weibull = require( '@stdlib/stats/base/dists/weibull' );
```
#### weibull
Weibull distribution.
```javascript
var dist = weibull;
// returns {...}
```
The namespace contains the following distribution functions:
<!-- <toc pattern="*+(cdf|pdf|mgf|quantile)*"> -->
<div class="namespace-toc">
- <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>
- <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>
- <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>
- <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>
- <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>
- <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>
</div>
<!-- </toc> -->
The namespace contains the following functions for calculating distribution properties:
<!-- <toc pattern="*+(entropy|kurtosis|mean|median|mode|skewness|stdev|variance)*"> -->
<div class="namespace-toc">
- <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>
- <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>
- <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>
- <span class="signature">[`median( k, lambda )`][@stdlib/stats/base/dists/weibull/median]</span><span class="delimiter">: </span><span class="description">Weibull distribution median.</span>
- <span class="signature">[`mode( k, lambda )`][@stdlib/stats/base/dists/weibull/mode]</span><span class="delimiter">: </span><span class="description">Weibull distribution mode.</span>
- <span class="signature">[`skewness( k, lambda )`][@stdlib/stats/base/dists/weibull/skewness]</span><span class="delimiter">: </span><span class="description">Weibull distribution skewness.</span>
- <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>
- <span class="signature">[`variance( k, lambda )`][@stdlib/stats/base/dists/weibull/variance]</span><span class="delimiter">: </span><span class="description">Weibull distribution variance.</span>
</div>
<!-- </toc> -->
The namespace contains a constructor function for creating a [Weibull][weibull-distribution] distribution object.
<!-- <toc pattern="*ctor*"> -->
<div class="namespace-toc">
- <span class="signature">[`Weibull( [k, lambda] )`][@stdlib/stats/base/dists/weibull/ctor]</span><span class="delimiter">: </span><span class="description">Weibull distribution constructor.</span>
</div>
<!-- </toc> -->
```javascript
var Weibull = require( '@stdlib/stats/base/dists/weibull' ).Weibull;
var dist = new Weibull( 2.0, 4.0 );
var y = dist.pdf( 0.8 );
// returns ~0.096
```
</section>
<!-- /.usage -->
<section class="examples">
## Examples
<!-- TODO: better examples -->
<!-- eslint no-undef: "error" -->
```javascript
var objectKeys = require( '@stdlib/utils/keys' );
var weibull = require( '@stdlib/stats/base/dists/weibull' );
console.log( objectKeys( weibull ) );
```
</section>
<!-- /.examples -->
<section class="links">
[weibull-distribution]: https://en.wikipedia.org/wiki/Weibull_distribution
<!-- <toc-links> -->
[@stdlib/stats/base/dists/weibull/ctor]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/weibull/ctor
[@stdlib/stats/base/dists/weibull/entropy]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/weibull/entropy
[@stdlib/stats/base/dists/weibull/kurtosis]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/weibull/kurtosis
[@stdlib/stats/base/dists/weibull/mean]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/weibull/mean
[@stdlib/stats/base/dists/weibull/median]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/weibull/median
[@stdlib/stats/base/dists/weibull/mode]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/weibull/mode
[@stdlib/stats/base/dists/weibull/skewness]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/weibull/skewness
[@stdlib/stats/base/dists/weibull/stdev]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/weibull/stdev
[@stdlib/stats/base/dists/weibull/variance]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/weibull/variance
[@stdlib/stats/base/dists/weibull/cdf]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/weibull/cdf
[@stdlib/stats/base/dists/weibull/logcdf]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/weibull/logcdf
[@stdlib/stats/base/dists/weibull/logpdf]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/weibull/logpdf
[@stdlib/stats/base/dists/weibull/mgf]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/weibull/mgf
[@stdlib/stats/base/dists/weibull/pdf]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/weibull/pdf
[@stdlib/stats/base/dists/weibull/quantile]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/weibull/quantile
<!-- </toc-links> -->
</section>
<!-- /.links -->