time-to-botec/squiggle/node_modules/@stdlib/stats/iter/cusum/docs/repl.txt

42 lines
946 B
Plaintext
Raw Normal View History

{{alias}}( iterator )
Returns an iterator which iteratively computes a cumulative sum.
If an environment supports Symbol.iterator, the returned iterator is
iterable.
Parameters
----------
iterator: Object
Input iterator.
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 );
> var s = it.next().value
2.0
> s = it.next().value
-3.0
> s = it.next().value
0.0
> s = it.next().value
5.0
See Also
--------