@stdlib/stats-base-dists-frechet-stdev
v0.3.1
Published
Fréchet distribution standard deviation.
Downloads
506
Readme
Standard Deviation
Fréchet distribution standard deviation.
The standard deviation for a Fréchet random variable shape α > 0, scale s > 0, and location parameter m is
where Γ is the gamma function.
Installation
npm install @stdlib/stats-base-dists-frechet-stdevUsage
var stdev = require( '@stdlib/stats-base-dists-frechet-stdev' );stdev( alpha, s, m )
Returns the standard deviation for a Fréchet distribution with shape alpha > 0, scale s > 0, and location parameter m.
var y = stdev( 3.0, 1.0, 1.0 );
// returns ~0.919
y = stdev( 3.0, 2.0, -3.0 );
// returns ~1.839
y = stdev( 5.0, 1.0, 2.0 );
// returns ~0.366If 0 < alpha <= 2.0, the function returns +Infinity.
var y = stdev( 1.0, 1.0, 1.0 );
// returns InfinityIf provided NaN as any argument, the function returns NaN.
var y = stdev( NaN, 1.0, -2.0 );
// returns NaN
y = stdev( 1.0, NaN, -2.0 );
// returns NaN
y = stdev( 1.0, 1.0, NaN );
// returns NaNIf provided alpha <= 0, the function returns NaN.
var y = stdev( 0.0, 3.0, 2.0 );
// returns NaN
y = stdev( 0.0, -1.0, 2.0 );
// returns NaNIf provided s <= 0, the function returns NaN.
var y = stdev( 1.0, 0.0, 2.0 );
// returns NaN
y = stdev( 1.0, -1.0, 2.0 );
// returns NaNExamples
var randu = require( '@stdlib/random-base-randu' );
var EPS = require( '@stdlib/constants-float64-eps' );
var stdev = require( '@stdlib/stats-base-dists-frechet-stdev' );
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()*40.0 ) - 20.0;
y = stdev( alpha, s, m );
console.log( 'α: %d, s: %d, m: %d, SD(X;α,s,m): %d', alpha.toFixed( 4 ), s.toFixed( 4 ), m.toFixed( 4 ), y.toFixed( 4 ) );
}C APIs
Usage
#include "stdlib/stats/base/dists/frechet/stdev.h"stdlib_base_dists_frechet_stdev( alpha, s, m )
Returns the standard deviation for a Fréchet distribution with shape alpha, scale s, and location m.
double y = stdlib_base_dists_frechet_stdev( 5.0, 2.0, 0.0 );
// returns ~0.731The function accepts the following arguments:
- alpha:
[in] doubleshape parameter. - s:
[in] doublescale parameter. - m:
[in] doublelocation parameter.
double stdlib_base_dists_frechet_stdev( const double alpha, const double s, const double m );Examples
#include "stdlib/stats/base/dists/frechet/stdev.h"
#include "stdlib/constants/float64/eps.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 s;
double m;
double y;
int i;
for ( i = 0; i < 10; i++ ) {
alpha = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 20.0 );
s = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 20.0 );
m = random_uniform( -20.0, 20.0 );
y = stdlib_base_dists_frechet_stdev( alpha, s, m );
printf( "α: %.4lf, s: %.4lf, m: %.4lf, SD(X;α,s,m): %.4lf\n", alpha, s, m, 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.
