Median

Beta distribution median.

The median for a beta random variable is the value for which the regularized incomplete beta function I(α,β) is equal to 0.5, i.e.

\mathop{\mathrm{Median}}\left[ X \right] = I_{\frac{1}{2}}^{[-1]}(\alpha,\beta)

where α > 0 is the first shape parameter and β > 0 is the second shape parameter.

Installation

npm install @stdlib/stats-base-dists-beta-median

Alternatively,

• To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
• If you are using Deno, visit the deno branch (see README for usage intructions).
• For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

Usage

var median = require( '@stdlib/stats-base-dists-beta-median' );

median( alpha, beta )

Returns the median of a beta distribution with parameters alpha (first shape parameter) and beta (second shape parameter).

var v = median( 1.0, 1.0 );
// returns 0.5

v = median( 4.0, 12.0 );
// returns ~0.239

v = median( 8.0, 2.0 );
// returns ~0.820

If provided NaN as any argument, the function returns NaN.

var v = median( NaN, 2.0 );
// returns NaN

v = median( 2.0, NaN );
// returns NaN

If provided alpha <= 0, the function returns NaN.

var v = median( 0.0, 1.0 );
// returns NaN

v = median( -1.0, 1.0 );
// returns NaN

If provided beta <= 0, the function returns NaN.

var v = median( 1.0, 0.0 );
// returns NaN

v = median( 1.0, -1.0 );
// returns NaN

Examples

var randu = require( '@stdlib/random-base-randu' );
var EPS = require( '@stdlib/constants-float64-eps' );
var median = require( '@stdlib/stats-base-dists-beta-median' );

var alpha;
var beta;
var v;
var i;

for ( i = 0; i < 10; i++ ) {
    alpha = ( randu()*10.0 ) + EPS;
    beta = ( randu()*10.0 ) + EPS;
    v = median( alpha, beta );
    console.log( 'α: %d, β: %d, Median(X;α,β): %d', alpha.toFixed( 4 ), beta.toFixed( 4 ), v.toFixed( 4 ) );
}

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.