External module "random/iter/rayleigh/docs/types/index.d"

iterator

• iterator(sigma: number, options?: Options): RandIter

• Returns an iterator for generating pseudorandom numbers drawn from a Rayleigh distribution.

  throws

  sigma must be a positive number

  throws

  must provide valid options

  throws

  must provide a valid state

  Parameters

  • sigma: number

    scale parameter

  • Optional options: Options

    function options

  Returns RandIter

  iterator

  Example

  var iter = iterator( 3.0 );
  
  var r = iter.next().value;
  // returns <number>
  
  r = iter.next().value;
  // returns <number>
  
  r = iter.next().value;
  // returns <number>
  
  // ...