@stdlib/simulate-iter-awln

Create an iterator which introduces additive white Laplacian noise.

https://github.com/stdlib-js/simulate-iter-awln

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (15.2%) to scientific vocabulary

Keywords

additive bi-exponential biexponential double-exponential exponential information-theory iterable iterator javascript laplace laplacian node node-js nodejs noise random simulate simulation stdlib white

Last synced: 4 months ago · JSON representation ·

Repository

Create an iterator which introduces additive white Laplacian noise.

Basic Info

Host: GitHub
Owner: stdlib-js
License: apache-2.0
Language: JavaScript
Default Branch: main
Homepage: https://github.com/stdlib-js/stdlib
Size: 2.39 MB

Statistics

Stars: 2
Watchers: 3
Forks: 0
Open Issues: 0
Releases: 0

Topics

Created over 4 years ago · Last pushed 5 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation Security

README.md

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!

iterawln

Create an iterator which introduces additive white Laplacian noise (AWLN).

## Installation ```bash npm install @stdlib/simulate-iter-awln ``` Alternatively, - To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]). - If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions). - For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]). The [branches.md][branches-url] 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.

## Usage ```javascript var iterawln = require( '@stdlib/simulate-iter-awln' ); ``` #### iterawln( iterator, sigma\[, options] ) Returns an [iterator][mdn-iterator-protocol] which introduces additive white Laplacian (a.k.a. biexponential or double-exponential) noise (AWLN) with standard deviation `sigma`. ```javascript var array2iterator = require( '@stdlib/array-to-iterator' ); var arr = array2iterator( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); var it = iterawln( arr, 0.2 ); var 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. - **PRNG**: underlying pseudorandom number generator (PRNG). - **seed**: pseudorandom number generator seed. If provided a PRNG, the property value is `null`. - **seedLength**: length of generator seed. If provided a PRNG, the property value is `null`. - **state**: pseudorandom number generator state. If provided a PRNG, the property value is `null`. - **stateLength**: length of generator state. If provided a PRNG, the property value is `null`. - **byteLength**: size (in bytes) of generator state. If provided a PRNG, the property value is `null`. The function accepts the following `options`: - **prng**: pseudorandom number generator for generating uniformly distributed pseudorandom numbers on the interval `[0,1)`. If provided, the function **ignores** both the `state` and `seed` options. In order to seed the returned iterator, one must seed the provided `prng` (assuming the provided `prng` is seedable). - **seed**: pseudorandom number generator seed. - **state**: a [`Uint32Array`][@stdlib/array/uint32] containing pseudorandom number generator state. If provided, the function ignores the `seed` option. - **copy**: `boolean` indicating whether to copy a provided pseudorandom number generator state. Setting this option to `false` allows sharing state between two or more pseudorandom number generators. Setting this option to `true` ensures that a returned iterator has exclusive control over its internal state. Default: `true`. By default, an iterator uses the [MT19937][@stdlib/random/base/mt19937] algorithm to generate uniformly distributed pseudorandom numbers on the interval `[0,1)`. To use a different PRNG, set the `prng` option. ```javascript var array2iterator = require( '@stdlib/array-to-iterator' ); var minstd = require( '@stdlib/random-base-minstd-shuffle' ); var arr = array2iterator( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); var it = iterawln( arr, 0.2, { 'prng': minstd.normalized }); var v = it.next().value; // returns ``` To seed an iterator, set the `seed` option. ```javascript var array2iterator = require( '@stdlib/array-to-iterator' ); var arr = array2iterator( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); var it1 = iterawln( arr, 0.2, { 'seed': 12345 }); var v1 = it1.next().value; // returns var it2 = iterawln( arr, 0.2, { 'seed': 12345 }); var v2 = it2.next().value; // returns var bool = ( v1 === v2 ); // returns true ``` To return an iterator having a specific initial state, set the iterator `state` option. ```javascript var array2iterator = require( '@stdlib/array-to-iterator' ); var arr = array2iterator( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); var it1 = iterawln( arr, 0.2 ); // Progress the underlying generator state: var i; for ( i = 0; i < 3; i++ ) { it1.next(); } // Create a new iterator initialized to the current state of `it1`: var it2 = iterawln( arr, 0.2, { 'state': it1.state }); // Test that the iterator values are the same: var bool = ( it1.next().value === it2.next().value ); // returns true ```

## Notes - If PRNG state is "shared" (meaning a state array was provided during iterator creation and **not** copied) and one sets the iterator state to a state array having a different length, the iterator does **not** update the existing shared state and, instead, points to the newly provided state array. In order to synchronize generated output according to the new shared state array, the state array for **each** relevant PRNG/iterator must be **explicitly** set. - If PRNG state is "shared" and one sets the iterator state to a state array of the same length, the PRNG state is updated (along with the state of all other PRNGs/iterators sharing the state array). - If an iterated value is non-numeric (including `NaN`), the returned [`iterator`][mdn-iterator-protocol] returns `NaN`. If non-numeric iterated values are possible, you are advised to provide an [`iterator`][mdn-iterator-protocol] which type checks and handles non-numeric values accordingly.

## Examples ```javascript var iterSineWave = require( '@stdlib/simulate-iter-sine-wave' ); var iterawln = require( '@stdlib/simulate-iter-awln' ); // Create an iterator for generating a sine wave: var sine = iterSineWave({ 'iter': 100, 'amplitude': 10.0 }); // Create an iterator for introducing additive white Laplacian noise: var it = iterawln( sine, 3.0 ); // Perform manual iteration... var v; while ( true ) { v = it.next(); if ( v.done ) { break; } console.log( v.value ); } ```

* * * ## Notice This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib]. #### Community [![Chat][chat-image]][chat-url] --- ## License See [LICENSE][stdlib-license]. ## Copyright Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].

Owner

Name: stdlib
Login: stdlib-js
Kind: organization

Website: https://stdlib.io
Twitter: stdlibjs
Repositories: 3,692
Profile: https://github.com/stdlib-js

Standard library for JavaScript.

Citation (CITATION.cff)

cff-version: 1.2.0
title: stdlib
message: >-
  If you use this software, please cite it using the
  metadata from this file.

type: software

authors:
  - name: The Stdlib Authors
    url: https://github.com/stdlib-js/stdlib/graphs/contributors

repository-code: https://github.com/stdlib-js/stdlib
url: https://stdlib.io

abstract: |
  Standard library for JavaScript and Node.js.

keywords:
  - JavaScript
  - Node.js
  - TypeScript
  - standard library
  - scientific computing
  - numerical computing
  - statistical computing

license: Apache-2.0 AND BSL-1.0

date-released: 2016

GitHub Events

Total

Push event: 18

Last Year

Push event: 18

Committers

Last synced: almost 2 years ago

All Time

Total Commits: 36
Total Committers: 1
Avg Commits per committer: 36.0
Development Distribution Score (DDS): 0.0

Past Year

Commits: 8
Committers: 1
Avg Commits per committer: 8.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
stdlib-bot	n**y@s**o	36

Committer Domains (Top 20 + Academic)

stdlib.io: 1

Issues and Pull Requests

Last synced: 5 months ago

All Time

Total issues: 0
Total pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Total issue authors: 0
Total pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 0
Pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- npm 25 last-month

Total dependent packages: 3
Total dependent repositories: 1
Total versions: 9
Total maintainers: 4

npmjs.org: @stdlib/simulate-iter-awln

Create an iterator which introduces additive white Laplacian noise.

Homepage: https://stdlib.io
License: Apache-2.0
Latest release: 0.2.1
published almost 2 years ago

Versions: 9
Dependent Packages: 3
Dependent Repositories: 1
Downloads: 25 Last month

Rankings

Dependent packages count: 5.8%

Downloads: 6.8%

Dependent repos count: 10.7%

Average: 10.8%

Stargazers count: 15.0%

Forks count: 15.9%

Maintainers (4)

planeshifter rreusser stdlib-bot kgryte

Funding

type: opencollective
url: https://opencollective.com/stdlib

Last synced: 5 months ago

Dependencies

package.json npm

@stdlib/array-float64 ^0.0.x development
@stdlib/array-to-iterator ^0.0.x development
@stdlib/array-uint32 ^0.0.x development
@stdlib/bench ^0.0.x development
@stdlib/constants-uint32-max ^0.0.x development
@stdlib/math-base-assert-is-nan ^0.0.x development
@stdlib/random-base-minstd-shuffle ^0.0.x development
@stdlib/random-iter-randu ^0.0.x development
@stdlib/simulate-iter-sine-wave ^0.0.x development
istanbul ^0.4.1 development
proxyquire ^2.0.0 development
tap-spec 5.x.x development
tape git+https://github.com/kgryte/tape.git#fix/globby development
@stdlib/assert-has-own-property ^0.0.x
@stdlib/assert-is-boolean ^0.0.x
@stdlib/assert-is-function ^0.0.x
@stdlib/assert-is-iterator-like ^0.0.x
@stdlib/assert-is-plain-object ^0.0.x
@stdlib/assert-is-positive-number ^0.0.x
@stdlib/assert-is-uint32array ^0.0.x
@stdlib/constants-float64-sqrt-two ^0.0.x
@stdlib/random-base-laplace ^0.0.x
@stdlib/string-format ^0.0.x
@stdlib/symbol-iterator ^0.0.x
@stdlib/types ^0.0.x
@stdlib/utils-constant-function ^0.0.x
@stdlib/utils-copy ^0.0.x
@stdlib/utils-define-nonenumerable-read-only-accessor ^0.0.x
@stdlib/utils-define-nonenumerable-read-only-property ^0.0.x
@stdlib/utils-define-nonenumerable-read-write-accessor ^0.0.x
@stdlib/utils-noop ^0.0.x

.github/workflows/benchmark.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/cancel.yml actions

styfle/cancel-workflow-action 0.11.0 composite

.github/workflows/close_pull_requests.yml actions

superbrothers/close-pull-request v3 composite

.github/workflows/examples.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/npm_downloads.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite
actions/upload-artifact v3 composite
distributhor/workflow-webhook v3 composite

.github/workflows/productionize.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
stdlib-js/bundle-action main composite
stdlib-js/transform-errors-action main composite

.github/workflows/publish.yml actions

JS-DevTools/npm-publish v1 composite
act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
styfle/cancel-workflow-action 0.11.0 composite

.github/workflows/test.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/test_bundles.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
denoland/setup-deno v1 composite

.github/workflows/test_coverage.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
codecov/codecov-action v3 composite
distributhor/workflow-webhook v3 composite

.github/workflows/test_install.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite