repl.txt

{{alias}}( arrays )
    Computes the standard deviation of a one-dimensional ndarray.

    Parameters
    ----------
    arrays: ArrayLikeObject<ndarray>
        Array-like object containing two elements: a one-dimensional input
        ndarray and a zero-dimensional ndarray (or ndarray-like object)
        specifying the degrees of freedom adjustment. Setting the correction
        value 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).

    Returns
    -------
    out: number
        The standard deviation.

    Examples
    --------
    // Create input ndarray:
    > var xbuf = [ 1.0, -2.0, 2.0 ];
    > var dt = 'generic';
    > var sh = [ xbuf.length ];
    > var st = [ 1 ];
    > var oo = 0;
    > var ord = 'row-major';
    > var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, st, oo, ord );

    // Create correction ndarray:
    > var opts = { 'dtype': 'float64' };
    > var correction = {{alias:@stdlib/ndarray/from-scalar}}( 1.0, opts );

    // Compute the standard deviation:
    > {{alias}}( [ x, correction ] )
    ~2.0817

    // Using Float64Array buffer:
    > xbuf = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );
    > dt = 'float64';
    > sh = [ xbuf.length ];
    > x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, st, oo, ord );
    > {{alias}}( [ x, correction ] )
    ~2.5820

    See Also
    --------