time-to-botec/squiggle/node_modules/@stdlib/stats/iter/stdev/docs/repl.txt

27 lines
488 B
Plaintext
Raw Normal View History

{{alias}}( iterator[, mean] )
Computes a correct sample standard deviation over all iterated values.
Parameters
----------
iterator: Object
Input iterator.
mean: number (optional)
Known mean.
Returns
-------
out: number|null
Corrected sample standard deviation.
Examples
--------
> var arr = {{alias:@stdlib/array/to-iterator}}( [ 2.0, -5.0 ] );
> var m = {{alias}}( arr )
~4.95
See Also
--------