Median

Fréchet distribution median.

The median for a Fréchet random variable shape α > 0, scale s > 0, and location parameter m is

Installation

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

Usage

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

median( alpha, s, m )

Returns the median for a Fréchet distribution with shape alpha > 0, scale s > 0, and location parameter m.

var y = median( 2.0, 1.0, 1.0 );
// returns ~2.201

y = median( 1.0, 2.0, -3.0 );
// returns ~-0.115

y = median( 1.0, 1.0, 2.0 );
// returns ~3.443

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

var y = median( NaN, 1.0, -2.0 );
// returns NaN

y = median( 1.0, NaN, -2.0 );
// returns NaN

y = median( 1.0, 1.0, NaN );
// returns NaN

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

var y = median( 0.0, 3.0, 2.0 );
// returns NaN

y = median( 0.0, -1.0, 2.0 );
// returns NaN

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

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

y = median( 1.0, -1.0, 2.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-frechet-median' );

var alpha;
var m;
var s;
var y;
var i;

for ( i = 0; i < 10; i++ ) {
    alpha = ( randu()*20.0 ) + EPS;
    s = ( randu()*20.0 ) + EPS;
    m = ( randu()*20.0 ) - 40.0;
    y = median( alpha, s, m );
    console.log( 'α: %d, s: %d, m: %d, Median(X;α,s,m): %d', alpha.toFixed( 4 ), s.toFixed( 4 ), m.toFixed( 4 ), y.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.