time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

repl.txt (1070B)


      1 
      2 {{alias}}( N, K, n )
      3     Returns the variance of a hypergeometric distribution.
      4 
      5     If provided `NaN` as any argument, the function returns `NaN`.
      6 
      7     If provided a population size `N`, subpopulation size `K` or draws `n` which
      8     is not a nonnegative integer, the function returns `NaN`.
      9 
     10     If the number of draws `n` or the subpopulation size `K` exceed population
     11     size `N`, the function returns `NaN`.
     12 
     13     Parameters
     14     ----------
     15     N: integer
     16         Population size.
     17 
     18     K: integer
     19         Subpopulation size.
     20 
     21     n: integer
     22         Number of draws.
     23 
     24     Returns
     25     -------
     26     out: number
     27         Variance.
     28 
     29     Examples
     30     --------
     31     > var v = {{alias}}( 16, 11, 4 )
     32     ~0.688
     33     > v = {{alias}}( 2, 1, 1 )
     34     0.25
     35 
     36     > v = {{alias}}( 10, 5, 12 )
     37     NaN
     38     > v = {{alias}}( 10.3, 10, 4 )
     39     NaN
     40     > v = {{alias}}( 10, 5.5, 4 )
     41     NaN
     42     > v = {{alias}}( 10, 5, 4.5 )
     43     NaN
     44 
     45     > v = {{alias}}( NaN, 10, 4 )
     46     NaN
     47     > v = {{alias}}( 20, NaN, 4 )
     48     NaN
     49     > v = {{alias}}( 20, 10, NaN )
     50     NaN
     51 
     52     See Also
     53     --------
     54