time-to-botec

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

repl.txt (1975B)


      1 
      2 {{alias}}( [k] )
      3     Returns a  chi-squared distribution object.
      4 
      5     Parameters
      6     ----------
      7     k: number (optional)
      8         Degrees of freedom. Must be greater than `0`. Default: `1.0`.
      9 
     10     Returns
     11     -------
     12     chisquare: Object
     13         Distribution instance.
     14 
     15     chisquare.k: number
     16         Degrees of freedom. If set, the value must be greater than `0`.
     17 
     18     chisquare.entropy: number
     19         Read-only property which returns the differential entropy.
     20 
     21     chisquare.kurtosis: number
     22         Read-only property which returns the excess kurtosis.
     23 
     24     chisquare.mean: number
     25         Read-only property which returns the expected value.
     26 
     27     chisquare.median: number
     28         Read-only property which returns the median.
     29 
     30     chisquare.mgf: Function
     31         Evaluates the moment-generating function (MGF).
     32 
     33     chisquare.mode: number
     34         Read-only property which returns the mode.
     35 
     36     chisquare.skewness: number
     37         Read-only property which returns the skewness.
     38 
     39     chisquare.stdev: number
     40         Read-only property which returns the standard deviation.
     41 
     42     chisquare.variance: number
     43         Read-only property which returns the variance.
     44 
     45     chisquare.cdf: Function
     46         Evaluates the cumulative distribution function (CDF).
     47 
     48     chisquare.pdf: Function
     49         Evaluates the probability density function (PDF).
     50 
     51     chisquare.quantile: Function
     52         Evaluates the quantile function at probability `p`.
     53 
     54     Examples
     55     --------
     56     > var chisquare = {{alias}}( 6.0 );
     57     > chisquare.k
     58     6.0
     59     > chisquare.entropy
     60     ~2.541
     61     > chisquare.kurtosis
     62     2.0
     63     > chisquare.mean
     64     6.0
     65     > chisquare.median
     66     ~5.348
     67     > chisquare.mode
     68     4.0
     69     > chisquare.skewness
     70     ~1.155
     71     > chisquare.stdev
     72     ~3.464
     73     > chisquare.variance
     74     12.0
     75     > chisquare.cdf( 3.0 )
     76     ~0.191
     77     > chisquare.mgf( 0.2 )
     78     ~4.63
     79     > chisquare.pdf( 1.5 )
     80     ~0.066
     81     > chisquare.quantile( 0.5 )
     82     ~5.348
     83 
     84     See Also
     85     --------
     86