0.2.1 • Published 2 months ago
@stdlib/stats-base-dists-rayleigh v0.2.1
Rayleigh
Rayleigh distribution.
Installation
npm install @stdlib/stats-base-dists-rayleigh
Usage
var rayleigh = require( '@stdlib/stats-base-dists-rayleigh' );
rayleigh
Rayleigh distribution.
var dist = rayleigh;
// returns {...}
The namespace contains the following distribution functions:
cdf( x, sigma )
: Rayleigh distribution cumulative distribution function.logcdf( x, sigma )
: Rayleigh distribution logarithm of cumulative distribution function.logpdf( x, sigma )
: Rayleigh distribution logarithm of probability density function (PDF).mgf( t, sigma )
: Rayleigh distribution moment-generating function (MGF).pdf( x, sigma )
: Rayleigh distribution probability density function (PDF).quantile( p, sigma )
: Rayleigh distribution quantile function.
The namespace contains the following functions for calculating distribution properties:
entropy( sigma )
: Rayleigh distribution differential entropy.kurtosis( sigma )
: Rayleigh distribution excess kurtosis.mean( sigma )
: Rayleigh distribution expected value.median( sigma )
: Rayleigh distribution median.mode( sigma )
: Rayleigh distribution mode.skewness( sigma )
: Rayleigh distribution skewness.stdev( sigma )
: Rayleigh distribution standard deviation.variance( sigma )
: Rayleigh distribution variance.
The namespace contains a constructor function for creating a Rayleigh distribution object.
Rayleigh( [sigma] )
: Rayleigh distribution constructor.
var Rayleigh = require( '@stdlib/stats-base-dists-rayleigh' ).Rayleigh;
var dist = new Rayleigh( 2.0 );
var y = dist.pdf( 0.8 );
// returns ~0.185
Examples
var objectKeys = require( '@stdlib/utils-keys' );
var rayleigh = require( '@stdlib/stats-base-dists-rayleigh' );
console.log( objectKeys( rayleigh ) );
Notice
This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2024. The Stdlib Authors.