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

33 lines
795 B
Plaintext

{{alias}}()
Returns an accumulator function which incrementally computes the residual
sum of squares (RSS).
If provided input values, the accumulator function returns an updated
residual sum of squares. If not provided input values, the accumulator
function returns the current residual sum of squares.
If provided `NaN` or a value which, when used in computations, results in
`NaN`, the accumulated value is `NaN` for all future invocations.
Returns
-------
acc: Function
Accumulator function.
Examples
--------
> var accumulator = {{alias}}();
> var r = accumulator()
null
> r = accumulator( 2.0, 3.0 )
1.0
> r = accumulator( -5.0, 2.0 )
50.0
> r = accumulator()
50.0
See Also
--------