Create an iterator which generates a triangle wave.
APACHE-2.0 License
Create an iterator which generates a triangle wave.
A triangle waveform is represented by the following equation
f(t; \tau, a, \varphi) = \frac{2a}{\pi} \mathop{\mathrm{arcsin}} \sin \frac{2\pi(t-\varphi)}{\tau}
where τ
is the period, a
is the peak amplitude, and φ
is the phase offset.
npm install @stdlib/simulate-iter-triangle-wave
Alternatively,
script
tag without installation and bundlers, use the ES Module available on the esm
branch (see README).deno
branch (see README for usage intructions).umd
branch (see README).The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
var iterTriangleWave = require( '@stdlib/simulate-iter-triangle-wave' );
Returns an iterator which generates a triangle wave.
var it = iterTriangleWave();
// 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:
value
property and a done
property having a boolean
value indicating whether the iterator is finished.The function supports the following options
:
10
.1.0
.0
.1e308
.By default, the function returns an iterator which generates a triangle wave that repeats every 10
iterations. To specify an alternative period, set the period
option.
var opts = {
'period': 4
};
var it = iterTriangleWave( opts );
// returns <Object>
var v = it.next().value;
// returns 0.0
v = it.next().value;
// returns 1.0
v = it.next().value;
// returns 0.0
v = it.next().value;
// returns -1.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': 4,
'offset': -1
};
var it = iterTriangleWave( opts );
// returns <Object>
var v = it.next().value;
// returns 1.0
v = it.next().value;
// returns 0.0
v = it.next().value;
// returns -1.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': 4,
'offset': 1
};
var it = iterTriangleWave( opts );
// returns <Object>
var v = it.next().value;
// returns -1.0
v = it.next().value;
// returns 0.0
v = it.next().value;
// returns 1.0
v = it.next().value;
// returns 0.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 = iterTriangleWave( opts );
// returns <Object>
var v = it.next().value;
// returns <number>
v = it.next().value;
// returns <number>
var bool = it.next().done;
// returns true
Symbol.iterator
, the returned iterator is iterable.var iterTriangleWave = require( '@stdlib/simulate-iter-triangle-wave' );
// Create an iterator:
var opts = {
'period': 10,
'amplitude': 10.0,
'offset': -5,
'iter': 100
};
var it = iterTriangleWave( opts );
// Perform manual iteration...
var v;
while ( true ) {
v = it.next();
if ( v.done ) {
break;
}
console.log( v.value );
}
@stdlib/simulate-iter/pulse
: create an iterator which generates a pulse waveform.
@stdlib/simulate-iter/sawtooth-wave
: create an iterator which generates a sawtooth wave.
@stdlib/simulate-iter/sine-wave
: create an iterator which generates a sine wave.
@stdlib/simulate-iter/square-wave
: create an iterator which generates a square wave.
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.
See LICENSE.
Copyright © 2016-2024. The Stdlib Authors.