@stdlib/stats-iter-stdev
v0.2.2
Published
Compute the corrected sample standard deviation over all iterated values.
Downloads
29
Readme
iterstdev
Compute the corrected sample standard deviation over all iterated values.
The corrected sample standard deviation is defined as
Installation
npm install @stdlib/stats-iter-stdev
Usage
var iterstdev = require( '@stdlib/stats-iter-stdev' );
iterstdev( iterator[, mean] )
Computes the corrected sample standard deviation over all iterated values.
var array2iterator = require( '@stdlib/array-to-iterator' );
var arr = array2iterator( [ 2.0, 1.0, 3.0 ] );
var s = iterstdev( arr );
// returns 1.0
If the mean is already known, provide a mean
argument.
var array2iterator = require( '@stdlib/array-to-iterator' );
var arr = array2iterator( [ 2.0, 1.0, 3.0 ] );
var s = iterstdev( arr, 2.0 );
// returns ~0.82
Notes
- If an iterated value is non-numeric (including
NaN
), the returnediterator
returnsNaN
. If non-numeric iterated values are possible, you are advised to provide aniterator
which type checks and handles non-numeric values accordingly.
Examples
var runif = require( '@stdlib/random-iter-uniform' );
var iterstdev = require( '@stdlib/stats-iter-stdev' );
// Create an iterator for generating uniformly distributed pseudorandom numbers:
var rand = runif( -10.0, 10.0, {
'seed': 1234,
'iter': 100
});
// Compute the corrected sample standard deviation:
var s = iterstdev( rand );
// returns <number>
console.log( 'stdev: %d.', s );
See Also
@stdlib/stats-iter/mean
: compute the arithmetic mean over all iterated values.@stdlib/stats-iter/variance
: compute the unbiased sample variance over all iterated values.
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-2024. The Stdlib Authors.