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

28 lines
563 B
Plaintext

{{alias}}( iterator )
Computes the mid-range of all iterated values.
The mid-range is the arithmetic mean of maximum and minimum values.
Accordingly, the mid-range is the midpoint of the range and a measure of
central tendency.
Parameters
----------
iterator: Object
Input iterator.
Returns
-------
out: number|null
Mid-range.
Examples
--------
> var arr = {{alias:@stdlib/array/to-iterator}}( [ 1.0, -2.0, 3.0, -4.0 ] );
> var v = {{alias}}( arr )
-0.5
See Also
--------