time-to-botec

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

repl.txt (1834B)


      1 
      2 {{alias}}( [d1, d2] )
      3     Returns an F distribution object.
      4 
      5     Parameters
      6     ----------
      7     d1: number (optional)
      8         Numerator degrees of freedom. Must be greater than `0`. Default: `1.0`.
      9 
     10     d2: number (optional)
     11         Denominator degrees of freedom. Must be greater than `0`.
     12         Default: `1.0`.
     13 
     14     Returns
     15     -------
     16     f: Object
     17         Distribution instance.
     18 
     19     f.d1: number
     20         Numerator degrees of freedom. If set, the value must be greater than
     21         `0`.
     22 
     23     f.d2: number
     24         Denominator degrees of freedom. If set, the value must be greater than
     25         `0`.
     26 
     27     f.entropy: number
     28         Read-only property which returns the differential entropy.
     29 
     30     f.kurtosis: number
     31         Read-only property which returns the excess kurtosis.
     32 
     33     f.mean: number
     34         Read-only property which returns the expected value.
     35 
     36     f.mode: number
     37         Read-only property which returns the mode.
     38 
     39     f.skewness: number
     40         Read-only property which returns the skewness.
     41 
     42     f.stdev: number
     43         Read-only property which returns the standard deviation.
     44 
     45     f.variance: number
     46         Read-only property which returns the variance.
     47 
     48     f.cdf: Function
     49         Evaluates the cumulative distribution function (CDF).
     50 
     51     f.pdf: Function
     52         Evaluates the probability density function (PDF).
     53 
     54     f.quantile: Function
     55         Evaluates the quantile function at probability `p`.
     56 
     57     Examples
     58     --------
     59     > var f = {{alias}}( 6.0, 9.0 );
     60     > f.d1
     61     6.0
     62     > f.d2
     63     9.0
     64     > f.entropy
     65     ~1.134
     66     > f.kurtosis
     67     ~104.564
     68     > f.mean
     69     ~1.286
     70     > f.mode
     71     ~0.545
     72     > f.skewness
     73     ~4.535
     74     > f.stdev
     75     ~1.197
     76     > f.variance
     77     ~1.433
     78     > f.cdf( 3.0 )
     79     ~0.932
     80     > f.pdf( 2.5 )
     81     ~0.095
     82     > f.quantile( 0.8 )
     83     ~1.826
     84 
     85     See Also
     86     --------
     87