time-to-botec

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

repl.txt (2564B)

      1 
      2 {{alias}}( [N, K, n] )
      3     Returns a hypergeometric distribution object.
      4 
      5     Parameters
      6     ----------
      7     N: integer (optional)
      8         Population size. Must be a nonnegative integer larger than or equal to
      9         `K` and `n`.
     10 
     11     K: integer (optional)
     12         Subpopulation size. Must be a nonnegative integer smaller than or equal
     13         to `N`.
     14 
     15     n: integer (optional)
     16         Number of draws. Must be a nonnegative integer smaller than or equal to
     17         `N`.
     18 
     19     Returns
     20     -------
     21     hypergeometric: Object
     22         Distribution instance.
     23 
     24     hypergeometric.N: number
     25         Population size. If set, the value must be a nonnegative integer larger
     26         than or equal to `K` and `n`.
     27 
     28     hypergeometric.K: number
     29         Subpopulation size. If set, the value must be a nonnegative integer
     30         smaller than or equal to `N`.
     31 
     32     hypergeometric.n: number
     33         Number of draws. If set, the value must be a nonnegative integer
     34         smaller than or equal to `N`.
     35 
     36     hypergeometric.kurtosis: number
     37         Read-only property which returns the excess kurtosis.
     38 
     39     hypergeometric.mean: number
     40         Read-only property which returns the expected value.
     41 
     42     hypergeometric.mode: number
     43         Read-only property which returns the mode.
     44 
     45     hypergeometric.skewness: number
     46         Read-only property which returns the skewness.
     47 
     48     hypergeometric.stdev: number
     49         Read-only property which returns the standard deviation.
     50 
     51     hypergeometric.variance: number
     52         Read-only property which returns the variance.
     53 
     54     hypergeometric.cdf: Function
     55         Evaluates the cumulative distribution function (CDF).
     56 
     57     hypergeometric.logpmf: Function
     58         Evaluates the natural logarithm of the probability mass function (PMF).
     59 
     60     hypergeometric.pmf: Function
     61         Evaluates the probability mass function (PMF).
     62 
     63     hypergeometric.quantile: Function
     64         Evaluates the quantile function at probability `p`.
     65 
     66     Examples
     67     --------
     68     > var hypergeometric = {{alias}}( 100, 70, 20 );
     69     > hypergeometric.N
     70     100.0
     71     > hypergeometric.K
     72     70.0
     73     > hypergeometric.n
     74     20.0
     75     > hypergeometric.kurtosis
     76     ~-0.063
     77     > hypergeometric.mean
     78     14.0
     79     > hypergeometric.mode
     80     14.0
     81     > hypergeometric.skewness
     82     ~-0.133
     83     > hypergeometric.stdev
     84     ~1.842
     85     > hypergeometric.variance
     86     ~3.394
     87     > hypergeometric.cdf( 2.9 )
     88     ~0.0
     89     > hypergeometric.logpmf( 10 )
     90     ~-3.806
     91     > hypergeometric.pmf( 10 )
     92     ~0.022
     93     > hypergeometric.quantile( 0.8 )
     94     16.0
     95 
     96     See Also
     97     --------
     98