time-to-botec/squiggle/node_modules/@stdlib/stats/base/dists/t/stdev

Standard Deviation

Student's t distribution variance.

The standard deviation for a Student's t random variable with degrees of freedom ν is

For ν smaller than one, the standard deviation is not defined.

Usage

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

stdev( v )

Returns the standard deviation of a Student's t distribution with degrees of freedom v.

var y = stdev( 9.0 );
// returns ~1.134

y = stdev( 3.5 );
// returns ~1.528

If provided 1 < v <= 2, the function returns infinity.

var y = stdev( 1.5 );
// returns Infinity

y = stdev( 2.0 );
// returns Infinity

If provided v <= 1, the function returns NaN.

var y = stdev( -1.0 );
// returns NaN

y = stdev( 0.8 );
// returns NaN

Examples

var randu = require( '@stdlib/random/base/randu' );
var round = require( '@stdlib/math/base/special/round' );
var stdev = require( '@stdlib/stats/base/dists/t/stdev' );

var v;
var y;
var i;

for ( i = 0; i < 10; i++ ) {
    v = randu() * 20.0;
    y = stdev( v );
    console.log( 'v: %d, SD(X,v): %d', v.toFixed( 4 ), y.toFixed( 4 ) );
}