time-to-botec/js/node_modules/@stdlib/stats/incr/mcv/docs/repl.txt
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

49 lines
1.2 KiB
Plaintext

{{alias}}( W[, mean] )
Returns an accumulator function which incrementally computes a moving
coefficient of variation (CV).
The `W` parameter defines the number of values over which to compute the
moving coefficient of variation.
If provided a value, the accumulator function returns an updated moving
coefficient of variation. If not provided a value, the accumulator function
returns the current moving coefficient of variation.
As `W` values are needed to fill the window buffer, the first `W-1` returned
values are calculated from smaller sample sizes. Until the window is full,
each returned value is calculated from all provided values.
Parameters
----------
W: integer
Window size.
mean: number (optional)
Known mean.
Returns
-------
acc: Function
Accumulator function.
Examples
--------
> var accumulator = {{alias}}( 3 );
> var cv = accumulator()
null
> cv = accumulator( 2.0 )
0.0
> cv = accumulator( 1.0 )
~0.47
> cv = accumulator( 3.0 )
0.5
> cv = accumulator( 7.0 )
~0.83
> cv = accumulator()
~0.83
See Also
--------