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

52 lines
1.3 KiB
Plaintext

{{alias}}( iterator, W )
Returns an iterator which iteratively computes a moving sum.
The `W` parameter defines the number of iterated values over which to
compute the moving sum.
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 previously iterated values.
If an environment supports Symbol.iterator and the provided iterator is
iterable, the returned iterator is iterable.
Parameters
----------
iterator: Object
Input iterator.
W: integer
Window size.
Returns
-------
iterator: Object
Iterator.
iterator.next(): Function
Returns an iterator protocol-compliant object containing the next
iterated value (if one exists) and a boolean flag indicating whether the
iterator is finished.
iterator.return( [value] ): Function
Finishes an iterator and returns a provided value.
Examples
--------
> var arr = {{alias:@stdlib/array/to-iterator}}( [ 2.0, -5.0, 3.0, 5.0 ] );
> var it = {{alias}}( arr, 3 );
> var s = it.next().value
2.0
> s = it.next().value
-3.0
> s = it.next().value
0.0
> s = it.next().value
3.0
See Also
--------