repl.txt

{{alias}}( iterator )
    Returns an iterator which iteratively computes the hyperbolic arctangent.

    The domain of hyperbolic arctangent is restricted to [-1,1]. If an iterated
    value is outside of the domain, the returned iterator returns `NaN`.

    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 it = {{alias}}( {{alias:@stdlib/random/iter/uniform}}( -1.0, 1.0 ) );
    > var r = it.next().value
    <number>
    > r = it.next().value
    <number>

    See Also
    --------