time-to-botec/js/node_modules/@stdlib/stats/iter/mean/docs/repl.txt

24 lines
401 B
Plaintext
Raw Normal View History

{{alias}}( iterator )
Computes an arithmetic mean over all iterated values.
Parameters
----------
iterator: Object
Input iterator.
Returns
-------
out: number|null
Arithmetic mean.
Examples
--------
> var arr = {{alias:@stdlib/array/to-iterator}}( [ 1.0, 2.0, 3.0, 4.0 ] );
> var m = {{alias}}( arr )
2.5
See Also
--------