@stdlib/stats-base-stdevch
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.6 • Public • Published

    stdevch

    NPM version Build Status Coverage Status dependencies

    Calculate the standard deviation of a strided array using a one-pass trial mean algorithm.

    The population standard deviation of a finite size population of size N is given by

    Equation for the population standard deviation.

    where the population mean is given by

    Equation for the population mean.

    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,

    Equation for computing a corrected sample standard deviation.

    where the sample mean is given by

    Equation for the sample mean.

    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-base-stdevch

    Usage

    var stdevch = require( '@stdlib/stats-base-stdevch' );

    stdevch( N, correction, x, stride )

    Computes the standard deviation of a strided array x using a one-pass trial mean algorithm.

    var x = [ 1.0, -2.0, 2.0 ];
    
    var v = stdevch( x.length, 1, x, 1 );
    // returns ~2.0817

    The function has the following parameters:

    • N: number of indexed elements.
    • 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 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 corrected 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).
    • x: input Array or typed array.
    • stride: index increment for x.

    The N and stride parameters determine which elements in x are accessed at runtime. For example, to compute the standard deviation of every other element in x,

    var floor = require( '@stdlib/math-base-special-floor' );
    
    var x = [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ];
    var N = floor( x.length / 2 );
    
    var v = stdevch( N, 1, x, 2 );
    // returns 2.5

    Note that indexing is relative to the first index. To introduce an offset, use typed array views.

    var Float64Array = require( '@stdlib/array-float64' );
    var floor = require( '@stdlib/math-base-special-floor' );
    
    var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
    var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
    
    var N = floor( x0.length / 2 );
    
    var v = stdevch( N, 1, x1, 2 );
    // returns 2.5

    stdevch.ndarray( N, correction, x, stride, offset )

    Computes the standard deviation of a strided array using a one-pass trial mean algorithm and alternative indexing semantics.

    var x = [ 1.0, -2.0, 2.0 ];
    
    var v = stdevch.ndarray( x.length, 1, x, 1, 0 );
    // returns ~2.0817

    The function has the following additional parameters:

    • offset: starting index for x.

    While typed array views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to calculate the standard deviation for every other value in x starting from the second value

    var floor = require( '@stdlib/math-base-special-floor' );
    
    var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ];
    var N = floor( x.length / 2 );
    
    var v = stdevch.ndarray( N, 1, x, 2, 1 );
    // returns 2.5

    Notes

    • If N <= 0, both functions return NaN.
    • If N - c is less than or equal to 0 (where c corresponds to the provided degrees of freedom adjustment), both functions return NaN.
    • The underlying algorithm is a specialized case of Neely's two-pass algorithm. As the standard deviation is invariant with respect to changes in the location parameter, the underlying algorithm uses the first strided array element as a trial mean to shift subsequent data values and thus mitigate catastrophic cancellation. Accordingly, the algorithm's accuracy is best when data is unordered (i.e., the data is not sorted in either ascending or descending order such that the first value is an "extreme" value).
    • Depending on the environment, the typed versions (dstdevch, sstdevch, etc.) are likely to be significantly more performant.

    Examples

    var randu = require( '@stdlib/random-base-randu' );
    var round = require( '@stdlib/math-base-special-round' );
    var Float64Array = require( '@stdlib/array-float64' );
    var stdevch = require( '@stdlib/stats-base-stdevch' );
    
    var x;
    var i;
    
    x = new Float64Array( 10 );
    for ( i = 0; i < x.length; i++ ) {
        x[ i ] = round( (randu()*100.0) - 50.0 );
    }
    console.log( x );
    
    var v = stdevch( x.length, 1, x, 1 );
    console.log( v );

    References

    • Neely, Peter M. 1966. "Comparison of Several Algorithms for Computation of Means, Standard Deviations and Correlation Coefficients." Communications of the ACM 9 (7). Association for Computing Machinery: 496–99. doi:10.1145/365719.365958.
    • Ling, Robert F. 1974. "Comparison of Several Algorithms for Computing Sample Means and Variances." Journal of the American Statistical Association 69 (348). American Statistical Association, Taylor & Francis, Ltd.: 859–66. doi:10.2307/2286154.
    • Chan, Tony F., Gene H. Golub, and Randall J. LeVeque. 1983. "Algorithms for Computing the Sample Variance: Analysis and Recommendations." The American Statistician 37 (3). American Statistical Association, Taylor & Francis, Ltd.: 242–47. doi:10.1080/00031305.1983.10483115.
    • Schubert, Erich, and Michael Gertz. 2018. "Numerically Stable Parallel Computation of (Co-)Variance." In Proceedings of the 30th International Conference on Scientific and Statistical Database Management. New York, NY, USA: Association for Computing Machinery. doi:10.1145/3221269.3223036.

    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

    Chat


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2021. The Stdlib Authors.

    Install

    npm i @stdlib/stats-base-stdevch

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    6

    Version

    0.0.6

    License

    Apache-2.0

    Unpacked Size

    87.4 kB

    Total Files

    15

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser