@stdlib/stats-base-dists-pareto-type1-variance NPM

Variance

Pareto (Type I) distribution variance.

The variance for a Pareto (Type I) random variable is

where α > 0 is the shape parameter and β > 0 is the scale parameter.

Installation

npm install @stdlib/stats-base-dists-pareto-type1-variance

Usage

var variance = require( '@stdlib/stats-base-dists-pareto-type1-variance' );

variance( alpha, beta )

Returns the variance of a Pareto (Type I) distribution with parameters alpha (shape parameter) and beta (scale parameter).

var v = variance( 2.5, 1.0 );
// returns ~2.222

v = variance( 4.0, 12.0 );
// returns 32.0

v = variance( 8.0, 2.0 );
// returns ~0.109

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

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

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

If provided 0 < alpha <= 2, the function returns +Infinity.

var v = variance( 0.5, 2.0 );
// returns Infinity

v = variance( 1.5, 1.0 );
// returns Infinity

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

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

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

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

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

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

Examples

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

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 = variance( alpha, beta );
    console.log( 'α: %d, β: %d, Var(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.