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

34 lines
746 B
Plaintext

{{alias}}()
Returns an accumulator function which incrementally computes a sum of
absolute values, ignoring NaN values.
If provided a value, the accumulator function returns an updated sum. If not
provided a value, the accumulator function returns the current sum.
For long running accumulations or accumulations of large numbers, care
should be taken to prevent overflow.
Returns
-------
acc: Function
Accumulator function.
Examples
--------
> var accumulator = {{alias}}();
> var s = accumulator()
null
> s = accumulator( 2.0 )
2.0
> s = accumulator( NaN )
2.0
> s = accumulator( -5.0 )
7.0
> s = accumulator()
7.0
See Also
--------