time-to-botec

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

repl.txt (2196B)

      1 
      2 {{alias}}( [α, β] )
      3     Returns a beta prime 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     betaprime: Object
     16         Distribution instance.
     17 
     18     betaprime.alpha: number
     19         First shape parameter. If set, the value must be greater than `0`.
     20 
     21     betaprime.beta: number
     22         Second shape parameter. If set, the value must be greater than `0`.
     23 
     24     betaprime.kurtosis: number
     25         Read-only property which returns the excess kurtosis.
     26 
     27     betaprime.mean: number
     28         Read-only property which returns the expected value.
     29 
     30     betaprime.mode: number
     31         Read-only property which returns the mode.
     32 
     33     betaprime.skewness: number
     34         Read-only property which returns the skewness.
     35 
     36     betaprime.stdev: number
     37         Read-only property which returns the standard deviation.
     38 
     39     betaprime.variance: number
     40         Read-only property which returns the variance.
     41 
     42     betaprime.cdf: Function
     43         Evaluates the cumulative distribution function (CDF).
     44 
     45     betaprime.logcdf: Function
     46         Evaluates the natural logarithm of the cumulative distribution function
     47         (CDF).
     48 
     49     betaprime.logpdf: Function
     50         Evaluates the natural logarithm of the probability density function
     51         (PDF).
     52 
     53     betaprime.pdf: Function
     54         Evaluates the probability density function (PDF).
     55 
     56     betaprime.quantile: Function
     57         Evaluates the quantile function at probability `p`.
     58 
     59     Examples
     60     --------
     61     > var betaprime = {{alias}}( 6.0, 5.0 );
     62     > betaprime.alpha
     63     6.0
     64     > betaprime.beta
     65     5.0
     66     > betaprime.kurtosis
     67     44.4
     68     > betaprime.mean
     69     1.5
     70     > betaprime.mode
     71     ~0.833
     72     > betaprime.skewness
     73     ~3.578
     74     > betaprime.stdev
     75     ~1.118
     76     > betaprime.variance
     77     1.25
     78     > betaprime.cdf( 0.8 )
     79     ~0.25
     80     > betaprime.logcdf( 0.8 )
     81     ~-1.387
     82     > betaprime.logpdf( 1.0 )
     83     ~-0.486
     84     > betaprime.pdf( 1.0 )
     85     ~0.615
     86     > betaprime.quantile( 0.8 )
     87     ~2.06
     88 
     89     See Also
     90     --------
     91