Nitrogen Pumpkin Mulch

    @stdlib/simulate-iter-pulse
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.7 • Public • Published

    iterPulse

    NPM version Build Status Coverage Status

    Create an iterator which generates a pulse waveform.

    A pulse waveform is represented by the following equation

    Equation for a pulse wave.

    where T is the pulse period, τ is the pulse duration, a is the amplitude, and φ is the phase offset.

    Installation

    npm install @stdlib/simulate-iter-pulse

    Usage

    var iterPulse = require( '@stdlib/simulate-iter-pulse' );

    iterPulse( [options] )

    Returns an iterator which generates a pulse waveform.

    var it = iterPulse();
    // returns <Object>
    
    var v = it.next().value;
    // returns 1.0
    
    v = it.next().value;
    // returns 1.0
    
    v = it.next().value;
    // returns 1.0
    
    // ...

    The returned iterator protocol-compliant object has the following properties:

    • next: function which returns an iterator protocol-compliant object containing the next iterated value (if one exists) assigned to a value property and a done property having a boolean value indicating whether the iterator is finished.
    • return: function which closes an iterator and returns a single (optional) argument in an iterator protocol-compliant object.

    The function supports the following options:

    • period: pulse period (i.e., the number of iterations before a waveform repeats). Default: 10.
    • duration: pulse duration (i.e., the number of consecutive iterations of maximum amplitude during one period). Default: floor(options.period/2).
    • min: minimum amplitude. Default: 0.0.
    • max: maximum amplitude. Default: 1.0.
    • offset: phase offset (in units of iterations; zero-based). A negative offset translates a waveform to the left. A positive offset translates a waveform to the right. Default: 0.
    • iter: number of iterations. Default: 1e308.

    By default, the function returns an iterator which generates a waveform that repeats every 10 iterations. To specify an alternative period, set the period option.

    var opts = {
        'period': 4
    };
    
    var it = iterPulse( opts );
    // returns <Object>
    
    var v = it.next().value;
    // returns 1.0
    
    v = it.next().value;
    // returns 1.0
    
    v = it.next().value;
    // returns 0.0
    
    v = it.next().value;
    // returns 0.0
    
    v = it.next().value;
    // returns 1.0
    
    // ...

    By default, the function returns an iterator which generates a waveform that has a duty cycle of 50% (i.e., the waveform spends 50% of its time at maximum amplitude). To specify an alternative duty cycle, set the duration option. For example, to generate a pulse wave having a period of 4 iterations and a 25% duty cycle,

    var opts = {
        'period': 4,
        'duration': 1 // 1/4 = 0.25 => 25%
    };
    
    var it = iterPulse( opts );
    // returns <Object>
    
    var v = it.next().value;
    // returns 1.0
    
    v = it.next().value;
    // returns 0.0
    
    v = it.next().value;
    // returns 0.0
    
    v = it.next().value;
    // returns 0.0
    
    v = it.next().value;
    // returns 1.0
    
    // ...

    To adjust at what point the iterator begins in the waveform cycle, set the phase offset option. For example, to translate the waveform to the left,

    var opts = {
        'period': 6,
        'offset': -2
    };
    
    var it = iterPulse( opts );
    // returns <Object>
    
    var v = it.next().value;
    // returns 1.0
    
    v = it.next().value;
    // returns 0.0
    
    v = it.next().value;
    // returns 0.0
    
    v = it.next().value;
    // returns 0.0
    
    v = it.next().value;
    // returns 1.0
    
    // ...

    To translate the waveform to the right,

    var opts = {
        'period': 6,
        'offset': 2
    };
    
    var it = iterPulse( opts );
    // returns <Object>
    
    var v = it.next().value;
    // returns 0.0
    
    v = it.next().value;
    // returns 0.0
    
    v = it.next().value;
    // returns 1.0
    
    v = it.next().value;
    // returns 1.0
    
    v = it.next().value;
    // returns 1.0
    
    // ...

    By default, the function returns an infinite iterator (i.e., an iterator which never ends). To limit the number of iterations, set the iter option.

    var opts = {
        'iter': 2
    };
    var it = iterPulse( opts );
    // returns <Object>
    
    var v = it.next().value;
    // returns 1.0
    
    v = it.next().value;
    // returns 1.0
    
    var bool = it.next().done;
    // returns true

    Notes

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

    Examples

    var iterPulse = require( '@stdlib/simulate-iter-pulse' );
    
    // Create an iterator:
    var opts = {
        'period': 10,
        'duration': 2,
        'min': -10.0,
        'max': 10.0,
        'offset': -5,
        'iter': 100
    };
    var it = iterPulse( opts );
    
    // Perform manual iteration...
    var v;
    while ( true ) {
        v = it.next();
        if ( v.done ) {
            break;
        }
        console.log( v.value );
    }

    See Also


    Notice

    This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

    For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

    Community

    Chat


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2022. The Stdlib Authors.

    Install

    npm i @stdlib/simulate-iter-pulse

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    30

    Version

    0.0.7

    License

    Apache-2.0

    Unpacked Size

    73 kB

    Total Files

    11

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser