README

Standard Deviation

Degenerate distribution standard deviation.

The variance for a degenerate random variable is

Standard deviation for a degenerate distribution.

where μ is the constant value of the distribution.

Installation

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

Usage

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

stdev( mu )

Returns the standard deviation of a degenerate distribution with constant value mu.

var v = stdev( 10.0 );
// returns 0.0

v = stdev( -0.5 );
// returns 0.0

v = stdev( NaN );
// returns NaN

Examples

var randu = require( '@stdlib/random-base-randu' );
var stdev = require( '@stdlib/stats-base-dists-degenerate-stdev' );

var mu;
var v;
var i;

for ( i = 0; i < 10; i++ ) {
    mu = randu();
    v = stdev( mu );
    console.log( 'µ: %d, SD(X;µ): %d', mu.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-degenerate-stdev

Usage no npm install needed!