@stdlib/math
Version:
Standard math.
52 lines (37 loc) • 1.33 kB
Plain Text
{{alias}}( iterator, fcn[, options] )
Returns an iterator which invokes a unary function accepting a single
numeric argument for each iterated value.
When invoked, the input function is provided one argument:
- value: iterated value.
If an environment supports Symbol.iterator and a provided iterator is
iterable, the returned iterator is iterable.
Parameters
----------
iterator: Object
Input iterator.
fcn: Function
Function to invoke for each iterated value.
options: Object (optional)
Options.
options.invalid: any (optional)
Return value when an input iterator yields a non-numeric value. Default:
NaN.
Returns
-------
iterator: Object
Iterator.
iterator.next(): Function
Returns an iterator protocol-compliant object containing the next
iterated value (if one exists) and a boolean flag indicating whether the
iterator is finished.
iterator.return( [value] ): Function
Finishes an iterator and returns a provided value.
Examples
--------
> var it = {{alias}}( {{alias:/random/iter/randu}}(), {{alias:/math/base/special/sin}} );
> var r = it.next().value
<number>
> r = it.next().value
<number>
See Also
--------