time-to-botec/squiggle/node_modules/@stdlib/stats/iter/max/docs/repl.txt

24 lines
398 B
Plaintext
Raw Normal View History

{{alias}}( iterator )
Computes the maximum value of all iterated values.
Parameters
----------
iterator: Object
Input iterator.
Returns
-------
out: number|null
Maximum value.
Examples
--------
> var arr = {{alias:@stdlib/array/to-iterator}}( [ 1.0, -2.0, 3.0, -4.0 ] );
> var m = {{alias}}( arr )
3.0
See Also
--------