Interface Random

factory

• factory(sigma: number, options?: Options): NullaryFunction
• factory(options?: Options): BinaryFunction

• Returns a pseudorandom number generator for generating Rayleigh distributed random numbers.

  Notes

  • When provided sigma, the returned PRNG returns random variates drawn from the specified distribution.

  throws

  must provide a valid state

  Parameters

  • sigma: number

    scale parameter

  • Optional options: Options

    function options

  Returns NullaryFunction

  pseudorandom number generator

  Example

  var myrayleigh = rayleigh.factory( 1.5 );
  
  var v = myrayleigh();
  // returns <number>

  Example

  var myrayleigh = rayleigh.factory( 2.3, {
      'seed': 297
  });
  var v = myrayleigh();
  // returns <number>

• Returns a pseudorandom number generator for generating Rayleigh distributed random numbers.

  Notes

  • When not provided sigma, the returned PRNG requires that sigma be provided at each invocation.

  throws

  must provide a valid state

  Parameters

  • Optional options: Options

    function options

  Returns BinaryFunction

  pseudorandom number generator

  Example

  var myrayleigh = rayleigh.factory();
  
  var v = myrayleigh( 1.5 );
  // returns <number>

  Example

  var myrayleigh = rayleigh.factory({
      'seed': 297
  });
  var v = myrayleigh( 2.3 );
  // returns <number>