time-to-botec/squiggle/node_modules/@stdlib/stats/base/dists/rayleigh/kurtosis
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00
..
docs feat: add the node modules 2022-12-03 12:44:49 +00:00
lib feat: add the node modules 2022-12-03 12:44:49 +00:00
package.json feat: add the node modules 2022-12-03 12:44:49 +00:00
README.md feat: add the node modules 2022-12-03 12:44:49 +00:00

Kurtosis

Rayleigh distribution excess kurtosis.

The excess kurtosis for a Rayleigh random variable is

Excess kurtosis for a Rayleigh distribution.

where σ > 0 is the scale parameter.

Usage

var kurtosis = require( '@stdlib/stats/base/dists/rayleigh/kurtosis' );

kurtosis( sigma )

Returns the excess kurtosis of a Rayleigh distribution with scale parameter sigma.

var y = kurtosis( 9.0 );
// returns ~0.245

y = kurtosis( 4.5 );
// returns ~0.245

If provided sigma < 0, the function returns NaN.

var y = kurtosis( -1.0 );
// returns NaN

Examples

var randu = require( '@stdlib/random/base/randu' );
var round = require( '@stdlib/math/base/special/round' );
var kurtosis = require( '@stdlib/stats/base/dists/rayleigh/kurtosis' );

var sigma;
var y;
var i;

for ( i = 0; i < 10; i++ ) {
    sigma = randu() * 20.0;
    y = kurtosis( sigma );
    console.log( 'σ: %d, Kurt(X,σ): %d', sigma.toFixed( 4 ), y.toFixed( 4 ) );
}