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

0.2.1 • Public • Published
About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

iterSquareWave

NPM version Build Status Coverage Status

Create an iterator which generates a square wave.

A square waveform is represented by the following equation

Equation for a square waveform.

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

Installation

npm install @stdlib/simulate-iter-square-wave

Usage

var iterSquareWave = require( '@stdlib/simulate-iter-square-wave' );

iterSquareWave( [options] )

Returns an iterator which generates a square wave.

var it = iterSquareWave();
// 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: period (i.e., the number of iterations before a square wave repeats). This must be an even integer in order to ensure a 50% duty cycle. Default: 10.
  • min: minimum amplitude. Default: -1.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 square wave that repeats every 10 iterations. To specify an alternative period, set the period option.

var opts = {
    'period': 4
};

var it = iterSquareWave( opts );
// returns <Object>

var v = it.next().value;
// returns 1.0

v = it.next().value;
// returns 1.0

v = it.next().value;
// returns -1.0

v = it.next().value;
// returns -1.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 = iterSquareWave( opts );
// returns <Object>

var v = it.next().value;
// returns 1.0

v = it.next().value;
// returns -1.0

v = it.next().value;
// returns -1.0

v = it.next().value;
// returns -1.0

v = it.next().value;
// returns 1.0

// ...

To translate the waveform to the right,

var opts = {
    'period': 6,
    'offset': 2
};

var it = iterSquareWave( opts );
// returns <Object>

var v = it.next().value;
// returns -1.0

v = it.next().value;
// returns -1.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 = iterSquareWave( 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 iterSquareWave = require( '@stdlib/simulate-iter-square-wave' );

// Create an iterator:
var opts = {
    'period': 10,
    'min': -10.0,
    'max': 10.0,
    'offset': -5,
    'iter': 100
};
var it = iterSquareWave( 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-2024. The Stdlib Authors.

Package Sidebar

Install

npm i @stdlib/simulate-iter-square-wave

Homepage

stdlib.io

Weekly Downloads

21

Version

0.2.1

License

Apache-2.0

Unpacked Size

66.4 kB

Total Files

13

Last publish

Collaborators

  • stdlib-bot
  • kgryte
  • planeshifter
  • rreusser