Calculate the standard deviation of a one-dimensional single-precision floating-point ndarray.
The population standard deviation of a finite size population of size N is given by
where the population mean is given by
Often in the analysis of data, the true population standard deviation is not known a priori and must be estimated from a sample drawn from the population distribution. If one attempts to use the formula for the population standard deviation, the result is biased and yields an uncorrected sample standard deviation. To compute a corrected sample standard deviation for a sample of size n,
where the sample mean is given by
The use of the term n-1 is commonly referred to as Bessel's correction. Note, however, that applying Bessel's correction can increase the mean squared error between the sample standard deviation and population standard deviation. Depending on the characteristics of the population distribution, other correction factors (e.g., n-1.5, n+1, etc) can yield better estimators.
var sstdev = require( '@stdlib/stats/base/ndarray/sstdev' );Computes the standard deviation of a one-dimensional single-precision floating-point ndarray.
var Float32Array = require( '@stdlib/array/float32' );
var ndarray = require( '@stdlib/ndarray/base/ctor' );
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
var opts = {
'dtype': 'float32'
};
var xbuf = new Float32Array( [ 1.0, -2.0, 2.0 ] );
var x = new ndarray( opts.dtype, xbuf, [ 3 ], [ 1 ], 0, 'row-major' );
var correction = scalar2ndarray( 1.0, opts );
var v = sstdev( [ x, correction ] );
// returns ~2.0817The function has the following parameters:
- arrays: array-like object containing two elements: a one-dimensional input ndarray and a zero-dimensional ndarray specifying the degrees of freedom adjustment. Providing a non-zero degrees of freedom adjustment has the effect of adjusting the divisor during the calculation of the standard deviation according to
N-cwhereNis the number of elements in the input ndarray andccorresponds to the provided degrees of freedom adjustment. When computing the standard deviation of a population, setting this parameter to0is the standard choice (i.e., the provided array contains data constituting an entire population). When computing the corrected sample standard deviation, setting this parameter to1is the standard choice (i.e., the provided array contains data sampled from a larger population; this is commonly referred to as Bessel's correction).
- If provided an empty one-dimensional ndarray, the function returns
NaN. - If
N - cis less than or equal to0(whereNcorresponds to the number of elements in the input ndarray andccorresponds to the provided degrees of freedom adjustment), the function returnsNaN.
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var Float32Array = require( '@stdlib/array/float32' );
var ndarray = require( '@stdlib/ndarray/base/ctor' );
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
var ndarray2array = require( '@stdlib/ndarray/to-array' );
var sstdev = require( '@stdlib/stats/base/ndarray/sstdev' );
var opts = {
'dtype': 'float32'
};
var xbuf = discreteUniform( 10, -50, 50, opts );
var x = new ndarray( opts.dtype, xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
console.log( ndarray2array( x ) );
var correction = scalar2ndarray( 1.0, opts );
var v = sstdev( [ x, correction ] );
console.log( v );