@stdlib/math
Version:
Standard math.
38 lines (28 loc) • 914 B
Plain Text
{{alias}}( iterator )
Returns an iterator which iteratively evaluates the hyperbolic tangent.
If an environment supports Symbol.iterator and a provided iterator is
iterable, the returned iterator is iterable.
Parameters
----------
iterator: Object
Input iterator.
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 r = {{alias:/random/iter/uniform}}( -4.0, 4.0 );
> var it = {{alias}}( r );
> var v = it.next().value
<number>
> v = it.next().value
<number>
See Also
--------