time-to-botec

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

repl.txt (1918B)


      1 
      2 {{alias}}( [a, b] )
      3     Returns a Kumaraswamy's double bounded distribution object.
      4 
      5     Parameters
      6     ----------
      7     a: number (optional)
      8         First shape parameter. Must be greater than `0`. Default: `1.0`.
      9 
     10     b: number (optional)
     11         Second shape parameter. Must be greater than `0`. Default: `1.0`.
     12 
     13     Returns
     14     -------
     15     kumaraswamy: Object
     16         Distribution instance.
     17 
     18     kumaraswamy.a: number
     19         First shape parameter. If set, the value must be greater than `0`.
     20 
     21     kumaraswamy.b: number
     22         Second shape parameter. If set, the value must be greater than `0`.
     23 
     24     kumaraswamy.kurtosis: number
     25         Read-only property which returns the excess kurtosis.
     26 
     27     kumaraswamy.mean: number
     28         Read-only property which returns the expected value.
     29 
     30     kumaraswamy.mode: number
     31         Read-only property which returns the mode.
     32 
     33     kumaraswamy.skewness: number
     34         Read-only property which returns the skewness.
     35 
     36     kumaraswamy.stdev: number
     37         Read-only property which returns the standard deviation.
     38 
     39     kumaraswamy.variance: number
     40         Read-only property which returns the variance.
     41 
     42     kumaraswamy.cdf: Function
     43         Evaluates the cumulative distribution function (CDF).
     44 
     45     kumaraswamy.pdf: Function
     46         Evaluates the probability density function (PDF).
     47 
     48     kumaraswamy.quantile: Function
     49         Evaluates the quantile function at probability `p`.
     50 
     51     Examples
     52     --------
     53     > var kumaraswamy = {{alias}}( 6.0, 5.0 );
     54     > kumaraswamy.a
     55     6.0
     56     > kumaraswamy.b
     57     5.0
     58     > kumaraswamy.kurtosis
     59     ~3.194
     60     > kumaraswamy.mean
     61     ~0.696
     62     > kumaraswamy.mode
     63     ~0.746
     64     > kumaraswamy.skewness
     65     ~-0.605
     66     > kumaraswamy.stdev
     67     ~0.126
     68     > kumaraswamy.variance
     69     ~0.016
     70     > kumaraswamy.cdf( 0.8 )
     71     ~0.781
     72     > kumaraswamy.pdf( 1.0 )
     73     ~0.0
     74     > kumaraswamy.quantile( 0.8 )
     75     ~0.807
     76 
     77     See Also
     78     --------
     79