time-to-botec/js/node_modules/@stdlib/stats/incr/mmean/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

46 lines
1.0 KiB
Plaintext

{{alias}}( W )
Returns an accumulator function which incrementally computes a moving
arithmetic mean.
The `W` parameter defines the number of values over which to compute the
moving mean.
If provided a value, the accumulator function returns an updated moving
mean. If not provided a value, the accumulator function returns the current
moving mean.
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.
Returns
-------
acc: Function
Accumulator function.
Examples
--------
> var accumulator = {{alias}}( 3 );
> var mu = accumulator()
null
> mu = accumulator( 2.0 )
2.0
> mu = accumulator( -5.0 )
-1.5
> mu = accumulator( 3.0 )
0.0
> mu = accumulator( 5.0 )
1.0
> mu = accumulator()
1.0
See Also
--------