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

    0.0.5 • Public • Published

    iterBartlettPulse

    NPM version Build Status Coverage Status dependencies

    Create an iterator which generates a Bartlett pulse waveform.

    A Bartlett pulse waveform is represented by the following equation

    Equation for a Bartlett pulse waveform.

    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-bartlett-pulse

    Usage

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

    iterBartlettPulse( [options] )

    Returns an iterator which generates a Bartlett pulse waveform.

    var it = iterBartlettPulse();
    // returns <Object>
    
    var v = it.next().value;
    // returns <number>
    
    v = it.next().value;
    // returns <number>
    
    v = it.next().value;
    // returns <number>
    
    // ...

    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: 100.
    • duration: pulse duration. Must be greater than 2. Default: options.period.
    • amplitude: 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 100 iterations. To specify an alternative period, set the period option.

    var opts = {
        'period': 10
    };
    
    var it = iterBartlettPulse( opts );
    // returns <Object>
    
    var v = it.next().value;
    // returns <number>
    
    v = it.next().value;
    // returns <number>
    
    // ...

    By default, the function returns an iterator which generates a waveform that has a duty cycle of 100% (i.e., the waveform duration equals the waveform period). To specify an alternative duty cycle, set the duration option. For example, to generate a waveform having a period of 10 iterations and a 50% duty cycle,

    var opts = {
        'period': 10,
        'duration': 5 // 5/10 = 0.50 => 50%
    };
    
    var it = iterBartlettPulse( opts );
    // returns <Object>
    
    var v = it.next().value;
    // returns 0.0
    
    v = it.next().value;
    // returns 0.5
    
    v = it.next().value;
    // returns 1.0
    
    v = it.next().value;
    // returns 0.5
    
    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 0.0
    
    v = it.next().value;
    // returns 0.0
    
    v = it.next().value;
    // returns 0.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': 10,
        'duration': 5,
        'offset': -7
    };
    
    var it = iterBartlettPulse( opts );
    // returns <Object>
    
    var 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 0.0
    
    v = it.next().value;
    // returns 0.5
    
    v = it.next().value;
    // returns 1.0
    
    // ...

    To translate the waveform to the right,

    var opts = {
        'period': 10,
        'duration': 5,
        'offset': 2
    };
    
    var it = iterBartlettPulse( opts );
    // returns <Object>
    
    var 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 0.5
    
    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 = iterBartlettPulse( opts );
    // returns <Object>
    
    var v = it.next().value;
    // returns <number>
    
    v = it.next().value;
    // returns <number>
    
    var bool = it.next().done;
    // returns true

    Notes

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

    Examples

    var iterBartlettPulse = require( '@stdlib/simulate-iter-bartlett-pulse' );
    
    // Create an iterator:
    var opts = {
        'period': 50,
        'duration': 25,
        'amplitude': 10.0,
        'offset': -25,
        'iter': 100
    };
    var it = iterBartlettPulse( opts );
    
    // Perform manual iteration...
    var v;
    while ( true ) {
        v = it.next();
        if ( v.done ) {
            break;
        }
        console.log( v.value );
    }

    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-2021. The Stdlib Authors.

    Install

    npm i @stdlib/simulate-iter-bartlett-pulse

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    25

    Version

    0.0.5

    License

    Apache-2.0

    Unpacked Size

    71 kB

    Total Files

    11

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser