time-to-botec

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

repl.txt (2513B)

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