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!
Simulation iterators.
npm install @stdlib/simulate-iter
Alternatively,
- To load the package in a website via a
script
tag without installation and bundlers, use the ES Module available on theesm
branch (see README). - If you are using Deno, visit the
deno
branch (see README for usage intructions). - For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the
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 ns = require( '@stdlib/simulate-iter' );
Namespace containing 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.
var objectKeys = require( '@stdlib/utils-keys' );
var ns = require( '@stdlib/simulate-iter' );
console.log( objectKeys( ns ) );
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.