@stdlib/stats-base-dists-pareto-type1-stdev
v0.3.1
Published
Pareto (Type I) distribution standard deviation.
Downloads
289
Readme
Standard Deviation
Pareto (Type I) distribution standard deviation.
The standard deviation 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-stdevUsage
var stdev = require( '@stdlib/stats-base-dists-pareto-type1-stdev' );stdev( alpha, beta )
Returns the standard deviation of a Pareto (Type I) distribution with parameters alpha (shape parameter) and beta (scale parameter).
var v = stdev( 2.5, 1.0 );
// returns ~1.491
v = stdev( 4.0, 12.0 );
// returns ~5.657
v = stdev( 8.0, 2.0 );
// returns ~0.33If provided NaN as any argument, the function returns NaN.
var v = stdev( NaN, 2.0 );
// returns NaN
v = stdev( 2.0, NaN );
// returns NaNIf provided 0 < alpha <= 2, the function returns +Infinity.
var v = stdev( 0.5, 2.0 );
// returns Infinity
v = stdev( 1.5, 1.0 );
// returns InfinityIf provided alpha <= 0, the function returns NaN.
var v = stdev( 0.0, 1.0 );
// returns NaN
v = stdev( -1.0, 1.0 );
// returns NaNIf provided beta <= 0, the function returns NaN.
var v = stdev( 1.0, 0.0 );
// returns NaN
v = stdev( 1.0, -1.0 );
// returns NaNExamples
var uniform = require( '@stdlib/random-array-uniform' );
var EPS = require( '@stdlib/constants-float64-eps' );
var logEachMap = require( '@stdlib/console-log-each-map' );
var stdev = require( '@stdlib/stats-base-dists-pareto-type1-stdev' );
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, SD(X;α,β): %0.4f', alpha, beta, stdev );C APIs
Usage
#include "stdlib/stats/base/dists/pareto-type1/stdev.h"stdlib_base_dists_pareto_type1_stdev( alpha, beta )
Returns the standard deviation of a Pareto (Type I) distribution.
double out = stdlib_base_dists_pareto_type1_stdev( 2.5, 1.0 );
// returns ~1.491The function accepts the following arguments:
- alpha:
[in] doublefirst shape parameter. - beta:
[in] doublesecond shape parameter.
double stdlib_base_dists_pareto_type1_stdev( const double alpha, const double beta );Examples
#include "stdlib/stats/base/dists/pareto-type1/stdev.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_stdev( alpha, beta );
printf( "α: %lf, β: %lf, SD(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.
