repl.txt

{{alias}}( n[, options] )
    Returns an iterator which generates a periodic sinc waveform.

    If an environment supports Symbol.iterator, the returned iterator is
    iterable.

    Parameters
    ----------
    n: integer
        Order.

    options: Object (optional)
        Function options.

    options.period: integer (optional)
        Period (i.e., the number of iterations before a waveform repeats).
        Default: 100.

    options.amplitude: number (optional)
        Peak amplitude. Default: 1.0.

    options.offset: integer (optional)
        Phase offset (in units of iterations; zero-based). A negative offset
        translates the waveform to the left. A positive offset translates a
        waveform to the right. Default: 0.

    options.iter: integer (optional)
        Number of iterations. Default: 1e308.

    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}}( 7 );
    > var v = it.next().value
    <number>
    > v = it.next().value
    <number>

    See Also
    --------