# iterSawtoothWave > Create an iterator which generates a sawtooth wave.
A sawtooth waveform is represented by the following equation
Equation for a sawtooth waveform.
where `τ` is the period, `a` is the peak amplitude, and `φ` is the phase offset.
## Usage ```javascript var iterSawtoothWave = require( '@stdlib/simulate/iter/sawtooth-wave' ); ``` #### iterSawtoothWave( \[options] ) Returns an iterator which generates a sawtooth wave. ```javascript var it = iterSawtoothWave(); // returns var v = it.next().value; // returns v = it.next().value; // returns v = it.next().value; // returns // ... ``` 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 waveform repeats). Default: `10`. - **amplitude**: peak 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 sawtooth wave that repeats every `10` iterations. To specify an alternative period, set the `period` option. ```javascript var opts = { 'period': 4 }; var it = iterSawtoothWave( opts ); // returns 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 // ... ``` 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, ```javascript var opts = { 'period': 4, 'offset': -1 }; var it = iterSawtoothWave( opts ); // returns var 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.5 // ... ``` To translate the waveform to the right, ```javascript var opts = { 'period': 4, 'offset': 1 }; var it = iterSawtoothWave( opts ); // returns var v = it.next().value; // returns ~-0.5 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 // ... ``` 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. ```javascript var opts = { 'iter': 2 }; var it = iterSawtoothWave( opts ); // returns var v = it.next().value; // returns v = it.next().value; // returns var bool = it.next().done; // returns true ```
## Notes - If an environment supports `Symbol.iterator`, the returned iterator is iterable.
## Examples ```javascript var iterSawtoothWave = require( '@stdlib/simulate/iter/sawtooth-wave' ); // Create an iterator: var opts = { 'period': 10, 'amplitude': 10.0, 'offset': -5, 'iter': 100 }; var it = iterSawtoothWave( opts ); // Perform manual iteration... var v; while ( true ) { v = it.next(); if ( v.done ) { break; } console.log( v.value ); } ```
* * * ## See Also - [`@stdlib/simulate/iter/pulse`][@stdlib/simulate/iter/pulse]: create an iterator which generates a pulse waveform. - [`@stdlib/simulate/iter/sine-wave`][@stdlib/simulate/iter/sine-wave]: create an iterator which generates a sine wave. - [`@stdlib/simulate/iter/square-wave`][@stdlib/simulate/iter/square-wave]: create an iterator which generates a square wave. - [`@stdlib/simulate/iter/triangle-wave`][@stdlib/simulate/iter/triangle-wave]: create an iterator which generates a triangle wave.
[@stdlib/simulate/iter/pulse]: https://github.com/stdlib-js/simulate/tree/main/iter/pulse [@stdlib/simulate/iter/sine-wave]: https://github.com/stdlib-js/simulate/tree/main/iter/sine-wave [@stdlib/simulate/iter/square-wave]: https://github.com/stdlib-js/simulate/tree/main/iter/square-wave [@stdlib/simulate/iter/triangle-wave]: https://github.com/stdlib-js/simulate/tree/main/iter/triangle-wave