time-to-botec

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

repl.txt (2371B)

      1 
      2 {{alias}}( [μ, β] )
      3     Returns a Gumbel distribution object.
      4 
      5     Parameters
      6     ----------
      7     μ: number (optional)
      8         Location parameter. Default: `0.0`.
      9 
     10     β: number (optional)
     11         Scale parameter. Must be greater than `0`. Default: `1.0`.
     12 
     13     Returns
     14     -------
     15     gumbel: Object
     16         Distribution instance.
     17 
     18     gumbel.mu: number
     19         Location parameter.
     20 
     21     gumbel.beta: number
     22         Scale parameter. If set, the value must be greater than `0`.
     23 
     24     gumbel.entropy: number
     25         Read-only property which returns the differential entropy.
     26 
     27     gumbel.kurtosis: number
     28         Read-only property which returns the excess kurtosis.
     29 
     30     gumbel.mean: number
     31         Read-only property which returns the expected value.
     32 
     33     gumbel.median: number
     34         Read-only property which returns the median.
     35 
     36     gumbel.mode: number
     37         Read-only property which returns the mode.
     38 
     39     gumbel.skewness: number
     40         Read-only property which returns the skewness.
     41 
     42     gumbel.stdev: number
     43         Read-only property which returns the standard deviation.
     44 
     45     gumbel.variance: number
     46         Read-only property which returns the variance.
     47 
     48     gumbel.cdf: Function
     49         Evaluates the cumulative distribution function (CDF).
     50 
     51     gumbel.logcdf: Function
     52         Evaluates the natural logarithm of the cumulative distribution function
     53         (CDF).
     54 
     55     gumbel.logpdf: Function
     56         Evaluates the natural logarithm of the probability density function
     57         (PDF).
     58 
     59     gumbel.mgf: Function
     60         Evaluates the moment-generating function (MGF).
     61 
     62     gumbel.pdf: Function
     63         Evaluates the probability density function (PDF).
     64 
     65     gumbel.quantile: Function
     66         Evaluates the quantile function at probability `p`.
     67 
     68     Examples
     69     --------
     70     > var gumbel = {{alias}}( -2.0, 3.0 );
     71     > gumbel.mu
     72     -2.0
     73     > gumbel.beta
     74     3.0
     75     > gumbel.entropy
     76     ~2.676
     77     > gumbel.kurtosis
     78     2.4
     79     > gumbel.mean
     80     ~-0.268
     81     > gumbel.median
     82     ~-0.9
     83     > gumbel.mode
     84     -2.0
     85     > gumbel.skewness
     86     ~1.14
     87     > gumbel.stdev
     88     ~3.848
     89     > gumbel.variance
     90     ~14.804
     91     > gumbel.cdf( 0.8 )
     92     ~0.675
     93     > gumbel.logcdf( 0.8 )
     94     ~-0.393
     95     > gumbel.logpdf( 1.0 )
     96     ~-2.466
     97     > gumbel.mgf( 0.2 )
     98     ~1.487
     99     > gumbel.pdf( 1.0 )
    100     ~0.085
    101     > gumbel.quantile( 0.8 )
    102     ~2.5
    103 
    104     See Also
    105     --------
    106