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

27 lines
508 B
Plaintext

{{alias}}( iterator )
Computes the sum of all iterated values.
For iterators which can generate many values or which may output large
numbers, care should be taken to prevent overflow.
Parameters
----------
iterator: Object
Input iterator.
Returns
-------
out: number|null
Sum.
Examples
--------
> var arr = {{alias:@stdlib/array/to-iterator}}( [ 1.0, 2.0, 3.0, 4.0 ] );
> var s = {{alias}}( arr )
10.0
See Also
--------