time-to-botec/squiggle/node_modules/@stdlib/stats/incr/ewstdev/docs/repl.txt

39 lines
931 B
Plaintext
Raw Normal View History

{{alias}}( α )
Returns an accumulator function which incrementally computes an
exponentially weighted standard deviation, where α is a smoothing factor
between 0 and 1.
If provided a value, the accumulator function returns an updated standard
deviation. If not provided a value, the accumulator function returns the
current standard deviation.
If provided `NaN` or a value which, when used in computations, results in
`NaN`, the accumulated value is `NaN` for all future invocations.
Parameters
----------
α: number
Smoothing factor (value between 0 and 1).
Returns
-------
acc: Function
Accumulator function.
Examples
--------
> var accumulator = {{alias}}( 0.5 );
> var s = accumulator()
null
> s = accumulator( 2.0 )
0.0
> s = accumulator( -5.0 )
3.5
> s = accumulator()
3.5
See Also
--------