time-to-botec

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

repl.txt (2375B)

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