time-to-botec/squiggle/node_modules/@stdlib/stats/incr/rmse/docs/repl.txt

33 lines
794 B
Plaintext
Raw Normal View History

{{alias}}()
Returns an accumulator function which incrementally computes the root mean
squared error (RMSE).
If provided input values, the accumulator function returns an updated root
mean squared error. If not provided input values, the accumulator function
returns the current root mean squared error.
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 )
5.0
> r = accumulator()
5.0
See Also
--------