160 lines
6.6 KiB
Markdown
160 lines
6.6 KiB
Markdown
|
<!--
|
||
|
|
|
||
|
|
@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.
|
||
|
|
|
||
|
|
-->
|
||
|
|
|
||
|
|
# Rayleigh
|
||
|
|
|
||
|
|
> Rayleigh distribution.
|
||
|
|
|
||
|
|
<section class="usage">
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var rayleigh = require( '@stdlib/stats/base/dists/rayleigh' );
|
||
|
|
```
|
||
|
|
|
||
|
|
#### rayleigh
|
||
|
|
|
||
|
|
Rayleigh distribution.
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var dist = rayleigh;
|
||
|
|
// returns {...}
|
||
|
|
```
|
||
|
|
|
||
|
|
The namespace contains the following distribution functions:
|
||
|
|
|
||
|
|
<!-- <toc pattern="*+(cdf|pdf|mgf|quantile)*"> -->
|
||
|
|
|
||
|
|
<div class="namespace-toc">
|
||
|
|
|
||
|
|
- <span class="signature">[`cdf( x, sigma )`][@stdlib/stats/base/dists/rayleigh/cdf]</span><span class="delimiter">: </span><span class="description">Rayleigh distribution cumulative distribution function.</span>
|
||
|
|
- <span class="signature">[`logcdf( x, sigma )`][@stdlib/stats/base/dists/rayleigh/logcdf]</span><span class="delimiter">: </span><span class="description">Rayleigh distribution logarithm of cumulative distribution function.</span>
|
||
|
|
- <span class="signature">[`logpdf( x, sigma )`][@stdlib/stats/base/dists/rayleigh/logpdf]</span><span class="delimiter">: </span><span class="description">Rayleigh distribution logarithm of probability density function (PDF).</span>
|
||
|
|
- <span class="signature">[`mgf( t, sigma )`][@stdlib/stats/base/dists/rayleigh/mgf]</span><span class="delimiter">: </span><span class="description">Rayleigh distribution moment-generating function (MGF).</span>
|
||
|
|
- <span class="signature">[`pdf( x, sigma )`][@stdlib/stats/base/dists/rayleigh/pdf]</span><span class="delimiter">: </span><span class="description">Rayleigh distribution probability density function (PDF).</span>
|
||
|
|
- <span class="signature">[`quantile( p, sigma )`][@stdlib/stats/base/dists/rayleigh/quantile]</span><span class="delimiter">: </span><span class="description">Rayleigh 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( sigma )`][@stdlib/stats/base/dists/rayleigh/entropy]</span><span class="delimiter">: </span><span class="description">Rayleigh distribution differential entropy.</span>
|
||
|
|
- <span class="signature">[`kurtosis( sigma )`][@stdlib/stats/base/dists/rayleigh/kurtosis]</span><span class="delimiter">: </span><span class="description">Rayleigh distribution excess kurtosis.</span>
|
||
|
|
- <span class="signature">[`mean( sigma )`][@stdlib/stats/base/dists/rayleigh/mean]</span><span class="delimiter">: </span><span class="description">Rayleigh distribution expected value.</span>
|
||
|
|
- <span class="signature">[`median( sigma )`][@stdlib/stats/base/dists/rayleigh/median]</span><span class="delimiter">: </span><span class="description">Rayleigh distribution median.</span>
|
||
|
|
- <span class="signature">[`mode( sigma )`][@stdlib/stats/base/dists/rayleigh/mode]</span><span class="delimiter">: </span><span class="description">Rayleigh distribution mode.</span>
|
||
|
|
- <span class="signature">[`skewness( sigma )`][@stdlib/stats/base/dists/rayleigh/skewness]</span><span class="delimiter">: </span><span class="description">Rayleigh distribution skewness.</span>
|
||
|
|
- <span class="signature">[`variance( sigma )`][@stdlib/stats/base/dists/rayleigh/variance]</span><span class="delimiter">: </span><span class="description">Rayleigh distribution variance.</span>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!-- </toc> -->
|
||
|
|
|
||
|
|
The namespace contains a constructor function for creating a [Rayleigh][rayleigh-distribution] distribution object.
|
||
|
|
|
||
|
|
<!-- <toc pattern="*ctor*"> -->
|
||
|
|
|
||
|
|
<div class="namespace-toc">
|
||
|
|
|
||
|
|
- <span class="signature">[`Rayleigh( [sigma] )`][@stdlib/stats/base/dists/rayleigh/ctor]</span><span class="delimiter">: </span><span class="description">Rayleigh distribution constructor.</span>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!-- </toc> -->
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var Rayleigh = require( '@stdlib/stats/base/dists/rayleigh' ).Rayleigh;
|
||
|
|
|
||
|
|
var dist = new Rayleigh( 2.0 );
|
||
|
|
|
||
|
|
var y = dist.pdf( 0.8 );
|
||
|
|
// returns ~0.185
|
||
|
|
```
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.usage -->
|
||
|
|
|
||
|
|
<section class="examples">
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
<!-- TODO: better examples -->
|
||
|
|
|
||
|
|
<!-- eslint no-undef: "error" -->
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var objectKeys = require( '@stdlib/utils/keys' );
|
||
|
|
var rayleigh = require( '@stdlib/stats/base/dists/rayleigh' );
|
||
|
|
|
||
|
|
console.log( objectKeys( rayleigh ) );
|
||
|
|
```
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.examples -->
|
||
|
|
|
||
|
|
<section class="links">
|
||
|
|
|
||
|
|
[rayleigh-distribution]: https://en.wikipedia.org/wiki/Rayleigh_distribution
|
||
|
|
|
||
|
|
<!-- <toc-links> -->
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/rayleigh/ctor]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/rayleigh/ctor
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/rayleigh/entropy]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/rayleigh/entropy
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/rayleigh/kurtosis]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/rayleigh/kurtosis
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/rayleigh/mean]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/rayleigh/mean
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/rayleigh/median]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/rayleigh/median
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/rayleigh/mode]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/rayleigh/mode
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/rayleigh/skewness]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/rayleigh/skewness
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/rayleigh/variance]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/rayleigh/variance
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/rayleigh/cdf]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/rayleigh/cdf
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/rayleigh/logcdf]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/rayleigh/logcdf
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/rayleigh/logpdf]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/rayleigh/logpdf
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/rayleigh/mgf]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/rayleigh/mgf
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/rayleigh/pdf]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/rayleigh/pdf
|
||
|
|
|
||
|
|
[@stdlib/stats/base/dists/rayleigh/quantile]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/rayleigh/quantile
|
||
|
|
|
||
|
|
<!-- </toc-links> -->
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.links -->
|