External module "simulate/iter/awln/docs/types/index.d"

Export assignment iterawln

• iterawln(iterator: Iterator, sigma: number, options?: Options): ExtendedIterator

• Returns an iterator which introduces additive white Laplacian (a.k.a. biexponential or double-exponential) noise with standard deviation sigma.

  throws

  sigma must be a positive number

  throws

  must provide a valid state

  Parameters

  • iterator: Iterator

    input iterator

  • sigma: number

    standard deviation of the noise

  • Optional options: Options

    function options

  Returns ExtendedIterator

  iterator

  Example

  var iterSineWave = require( `@stdlib/simulate/iter/sine-wave` );
  
  var sine = iterSineWave({
      'iter': 100
  });
  
  var it = iterawln( sine, 0.5 );
  
  var v = it.next().value;
  // returns <number>
  
  v = it.next().value;
  // returns <number>
  
  v = it.next().value;
  // returns <number>
  
  // ...