@stdlib/stats-base-dists-pareto-type1-variance
v0.3.1
Published
Pareto (Type I) distribution variance.
Downloads
159
Readme
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-varianceUsage
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.109If provided NaN as any argument, the function returns NaN.
var v = variance( NaN, 2.0 );
// returns NaN
v = variance( 2.0, NaN );
// returns NaNIf provided 0 < alpha <= 2, the function returns +Infinity.
var v = variance( 0.5, 2.0 );
// returns Infinity
v = variance( 1.5, 1.0 );
// returns InfinityIf provided alpha <= 0, the function returns NaN.
var v = variance( 0.0, 1.0 );
// returns NaN
v = variance( -1.0, 1.0 );
// returns NaNIf provided beta <= 0, the function returns NaN.
var v = variance( 1.0, 0.0 );
// returns NaN
v = variance( 1.0, -1.0 );
// returns NaNExamples
var uniform = require( '@stdlib/random-array-uniform' );
var logEachMap = require( '@stdlib/console-log-each-map' );
var EPS = require( '@stdlib/constants-float64-eps' );
var variance = require( '@stdlib/stats-base-dists-pareto-type1-variance' );
var opts = {
'dtype': 'float64'
};
var alpha = uniform( 10, EPS, 10.0, opts );
var beta = uniform( 10, EPS, 10.0, opts );
logEachMap( 'α: %0.4f, β: %0.4f, Var(X;α,β): %0.4f', alpha, beta, variance );C APIs
Usage
#include "stdlib/stats/base/dists/pareto-type1/variance.h"stdlib_base_dists_pareto_type1_variance( alpha, beta )
Returns the variance of a Pareto (Type I) distribution with parameters alpha (shape parameter) and beta (scale parameter).
double out = stdlib_base_dists_pareto_type1_variance( 4.0, 12.0 );
// returns 32.0The function accepts the following arguments:
- alpha:
[in] doubleshape parameter. - beta:
[in] doublescale parameter.
double stdlib_base_dists_pareto_type1_variance( const double alpha, const double beta );Examples
#include "stdlib/stats/base/dists/pareto-type1/variance.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 alpha;
double beta;
double y;
int i;
for ( i = 0; i < 25; i++ ) {
alpha = random_uniform( 0.0, 10.0 );
beta = random_uniform( 0.0, 10.0 );
y = stdlib_base_dists_pareto_type1_variance( alpha, beta );
printf( "α: %lf, β: %lf, Var(X;α,β): %lf\n", alpha, beta, 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.
