1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
|
{{alias}}( [options] )
Returns an iterator which generates a pulse waveform.
If an environment supports Symbol.iterator, the returned iterator is
iterable.
Parameters
----------
options: Object (optional)
Function options.
options.period: integer (optional)
Pulse period (i.e., the number of iterations until a waveform repeats).
Default: 10.
options.duration: integer (optional)
Pulse duration (i.e., the number of consecutive iterations of maximum
amplitude during one period). Default: floor(options.period/2).
options.min: number (optional)
Minimum amplitude. Default: 0.0.
options.max: number (optional)
Maximum 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}}();
> var v = it.next().value
1.0
> v = it.next().value
1.0
See Also
--------
|