README
Simulation Iterators
Standard library simulation iterators.
Installation
npm install @stdlib/simulate-iter
Usage
var ns = require( '@stdlib/simulate-iter' );
ns
Standard library simulation iterators.
var iterators = ns;
// returns {...}
The namespace contains the following functions for creating iterator protocol-compliant iterators:
iterawgn( iterator, sigma[, options] ): create an iterator which introduces additive white Gaussian noise (AWGN).iterawln( iterator, sigma[, options] ): create an iterator which introduces additive white Laplacian noise (AWLN).iterawun( iterator, sigma[, options] ): create an iterator which introduces additive white uniform noise (AWUN).iterBartlettHannPulse( [options] ): create an iterator which generates a Bartlett-Hann pulse waveform.iterBartlettPulse( [options] ): create an iterator which generates a Bartlett pulse waveform.iterCosineWave( [options] ): create an iterator which generates a cosine wave.iterDiracComb( [options] ): create an iterator which generates a Dirac comb.iterFlatTopPulse( [options] ): create an iterator which generates a flat top pulse waveform.iterHannPulse( [options] ): create an iterator which generates a Hann pulse waveform.iterLanczosPulse( [options] ): create an iterator which generates a Lanczos pulse waveform.iterPeriodicSinc( n[, options] ): create an iterator which generates a periodic sinc waveform.iterPulse( [options] ): create an iterator which generates a pulse waveform.iterSawtoothWave( [options] ): create an iterator which generates a sawtooth wave.iterSineWave( [options] ): create an iterator which generates a sine wave.iterSquareWave( [options] ): create an iterator which generates a square wave.iterTriangleWave( [options] ): create an iterator which generates a triangle wave.
Examples
var objectKeys = require( '@stdlib/utils-keys' );
var ns = require( '@stdlib/simulate-iter' );
console.log( objectKeys( ns ) );
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
License
See LICENSE.
Copyright
Copyright © 2016-2021. The Stdlib Authors.