@stdlib/stats-base-dists-rayleigh-median
v0.3.1
Published
Rayleigh distribution median.
Readme
Median
The median for a Rayleigh random variable is
where σ > 0 is the scale parameter.
Installation
npm install @stdlib/stats-base-dists-rayleigh-medianUsage
var median = require( '@stdlib/stats-base-dists-rayleigh-median' );median( sigma )
Returns the median of a Rayleigh distribution with scale parameter sigma.
var y = median( 9.0 );
// returns ~10.597
y = median( 1.5 );
// returns ~1.766If provided sigma < 0, the function returns NaN.
var y = median( -1.0 );
// returns NaNExamples
var uniform = require( '@stdlib/random-array-uniform' );
var logEachMap = require( '@stdlib/console-log-each-map' );
var median = require( '@stdlib/stats-base-dists-rayleigh-median' );
var opts = {
'dtype': 'float64'
};
var sigma = uniform( 10, 0.0, 20.0, opts );
logEachMap( 'σ: %0.4f, Median(X;σ): %0.4f', sigma, median );C APIs
Usage
#include "stdlib/stats/base/dists/rayleigh/median.h"stdlib_base_dists_rayleigh_median( sigma )
Returns the median of a Rayleigh distribution with scale parameter sigma.
double out = stdlib_base_dists_rayleigh_median( 9.0 );
// returns ~10.595The function accepts the following arguments:
- sigma:
[in] doublescale parameter.
double stdlib_base_dists_rayleigh_median( const double sigma );Examples
#include "stdlib/stats/base/dists/rayleigh/median.h"
#include <stdlib.h>
#include <stdio.h>
static double random_uniform( const double min, const double max ) {
double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
return min + ( v*(max-min) );
}
int main( void ) {
double sigma;
double y;
int i;
for ( i = 0; i < 25; i++ ) {
sigma = random_uniform( 0.0, 20.0 );
y = stdlib_base_dists_rayleigh_median( sigma );
printf( "σ: %lf, Median(X;σ): %lf\n", sigma, y );
}
}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-2026. The Stdlib Authors.
