time-to-botec

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

repl.txt (2109B)


      1 
      2 {{alias}}( [α, β] )
      3     Returns an inverse gamma distribution object.
      4 
      5     Parameters
      6     ----------
      7     α: number (optional)
      8         Shape parameter. Must be greater than `0`. Default: `1.0`.
      9 
     10     β: number (optional)
     11         Scale parameter. Must be greater than `0`. Default: `1.0`.
     12 
     13     Returns
     14     -------
     15     invgamma: Object
     16         Distribution instance.
     17 
     18     invgamma.alpha: number
     19         Shape parameter. If set, the value must be greater than `0`.
     20 
     21     invgamma.beta: number
     22         Scale parameter. If set, the value must be greater than `0`.
     23 
     24     invgamma.entropy: number
     25         Read-only property which returns the differential entropy.
     26 
     27     invgamma.kurtosis: number
     28         Read-only property which returns the excess kurtosis.
     29 
     30     invgamma.mean: number
     31         Read-only property which returns the expected value.
     32 
     33     invgamma.mode: number
     34         Read-only property which returns the mode.
     35 
     36     invgamma.skewness: number
     37         Read-only property which returns the skewness.
     38 
     39     invgamma.stdev: number
     40         Read-only property which returns the standard deviation.
     41 
     42     invgamma.variance: number
     43         Read-only property which returns the variance.
     44 
     45     invgamma.cdf: Function
     46         Evaluates the cumulative distribution function (CDF).
     47 
     48     invgamma.logpdf: Function
     49         Evaluates the natural logarithm of the probability density function
     50         (PDF).
     51 
     52     invgamma.pdf: Function
     53         Evaluates the probability density function (PDF).
     54 
     55     invgamma.quantile: Function
     56         Evaluates the quantile function at probability `p`.
     57 
     58     Examples
     59     --------
     60     > var invgamma = {{alias}}( 6.0, 5.0 );
     61     > invgamma.alpha
     62     6.0
     63     > invgamma.beta
     64     5.0
     65     > invgamma.entropy
     66     ~0.454
     67     > invgamma.kurtosis
     68     19.0
     69     > invgamma.mean
     70     1.0
     71     > invgamma.mode
     72     ~0.714
     73     > invgamma.skewness
     74     ~2.667
     75     > invgamma.stdev
     76     0.5
     77     > invgamma.variance
     78     0.25
     79     > invgamma.cdf( 0.8 )
     80     ~0.406
     81     > invgamma.pdf( 1.0 )
     82     ~0.877
     83     > invgamma.logpdf( 1.0 )
     84     ~-0.131
     85     > invgamma.quantile( 0.8 )
     86     ~1.281
     87 
     88     See Also
     89     --------
     90