time-to-botec/js/node_modules/@stdlib/stats/incr/mmax/docs/repl.txt

46 lines
1.0 KiB
Plaintext
Raw Normal View History

{{alias}}( W )
Returns an accumulator function which incrementally computes a moving
maximum value.
The `W` parameter defines the number of values over which to compute the
moving maximum.
If provided a value, the accumulator function returns an updated moving
maximum. If not provided a value, the accumulator function returns the
current moving maximum.
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 m = accumulator()
null
> m = accumulator( 2.0 )
2.0
> m = accumulator( -5.0 )
2.0
> m = accumulator( 3.0 )
3.0
> m = accumulator( 5.0 )
5.0
> m = accumulator()
5.0
See Also
--------