Package Exports

@stdlib/stats-base-dists-beta-stdev
@stdlib/stats-base-dists-beta-stdev/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/stats-base-dists-beta-stdev) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Standard Deviation

Beta distribution standard deviation.

The standard deviation for a beta random variable is

Standard deviation for a beta distribution.

where α > 0 is the first shape parameter and β > 0 is the second shape parameter.

Installation

npm install @stdlib/stats-base-dists-beta-stdev

Usage

var stdev = require( '@stdlib/stats-base-dists-beta-stdev' );

stdev( alpha, beta )

Returns the standard deviation of a beta distribution with parameters alpha (first shape parameter) and beta (second shape parameter).

var v = stdev( 1.0, 1.0 );
// returns ~0.289

v = stdev( 4.0, 12.0 );
// returns ~0.105

v = stdev( 8.0, 2.0 );
// returns ~0.121

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

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

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

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

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

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

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

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

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

Examples

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

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

Community

License

See LICENSE.

@stdlib/stats-base-dists-beta-stdev