stdevyc

Calculate the standard deviation of an array using a one-pass algorithm proposed by Youngs and Cramer.

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.

Installation

npm install @stdlib/stats-array-stdevyc

Usage

var stdevyc = require( '@stdlib/stats-array-stdevyc' );

stdevyc( x[, correction] )

Computes the standard deviation of an array using a one-pass algorithm proposed by Youngs and Cramer.

var x = [ 1.0, -2.0, 2.0 ];

var v = stdevyc( x );
// returns ~2.0817

The function has the following parameters:

• x: input array.
• correction: degrees of freedom adjustment. Setting this parameter to a value other than 0 has the effect of adjusting the divisor during the calculation of the standard deviation according to N-c where N corresponds to the number of array elements and c corresponds to the provided degrees of freedom adjustment. When computing the standard deviation of a population, setting this parameter to 0 is the standard choice (i.e., the provided array contains data constituting an entire population). When computing the unbiased sample standard deviation, setting this parameter to 1 is the standard choice (i.e., the provided array contains data sampled from a larger population; this is commonly referred to as Bessel's correction). Default: 1.0.

By default, the function computes the sample standard deviation. To adjust the degrees of freedom when computing the standard deviation, provide a correction argument.

var x = [ 1.0, -2.0, 2.0 ];

var v = stdevyc( x, 0.0 );
// returns ~1.6997

Notes

• If provided an empty array, the function returns NaN.
• If N - c is less than or equal to 0 (where c corresponds to the provided degrees of freedom adjustment), the function returns NaN.
• The function supports array-like objects having getter and setter accessors for array element access (e.g., @stdlib/array-base/accessor).

Examples

var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
var stdevyc = require( '@stdlib/stats-array-stdevyc' );

var x = discreteUniform( 10, -50, 50, {
    'dtype': 'float64'
});
console.log( x );

var v = stdevyc( x );
console.log( v );

References

• Youngs, Edward A., and Elliot M. Cramer. 1971. "Some Results Relevant to Choice of Sum and Sum-of-Product Algorithms." Technometrics 13 (3): 657–65. doi:10.1080/00401706.1971.10488826.

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.