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

iterator

• iterator(N: number, K: number, n: number, options?: Options): RandIter

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

  throws

  first argument must be a nonnegative integer

  throws

  second argument must be a nonnegative integer

  throws

  third argument must be a nonnegative integer

  throws

  n must be less than or equal to N

  throws

  K must be less than or equal to N

  throws

  must provide valid options

  Parameters

  • N: number

    population size

  • K: number

    subpopulation size

  • n: number

    number of draws

  • Optional options: Options

    function options

  Returns RandIter

  iterator

  Example

  var iter = iterator( 10, 5, 3 );
  
  var r = iter.next().value;
  // returns <number>
  
  r = iter.next().value;
  // returns <number>
  
  r = iter.next().value;
  // returns <number>
  
  // ...