time-to-botec

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

repl.txt (1745B)


      1 
      2 {{alias}}( [k] )
      3     Returns a chi 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     chi: Object
     13         Distribution instance.
     14 
     15     chi.k: number
     16         Degrees of freedom. If set, the value must be greater than `0`.
     17 
     18     chi.entropy: number
     19         Read-only property which returns the differential entropy.
     20 
     21     chi.kurtosis: number
     22         Read-only property which returns the excess kurtosis.
     23 
     24     chi.mean: number
     25         Read-only property which returns the expected value.
     26 
     27     chi.mode: number
     28         Read-only property which returns the mode.
     29 
     30     chi.skewness: number
     31         Read-only property which returns the skewness.
     32 
     33     chi.stdev: number
     34         Read-only property which returns the standard deviation.
     35 
     36     chi.variance: number
     37         Read-only property which returns the variance.
     38 
     39     chi.cdf: Function
     40         Evaluates the cumulative distribution function (CDF).
     41 
     42     chi.logpdf: Function
     43         Evaluates the natural logarithm of the probability density function
     44         (PDF).
     45 
     46     chi.pdf: Function
     47         Evaluates the probability density function (PDF).
     48 
     49     chi.quantile: Function
     50         Evaluates the quantile function at probability `p`.
     51 
     52     Examples
     53     --------
     54     > var chi = {{alias}}( 6.0 );
     55     > chi.k
     56     6.0
     57     > chi.entropy
     58     ~1.04
     59     > chi.kurtosis
     60     ~0.025
     61     > chi.mean
     62     ~2.35
     63     > chi.mode
     64     ~2.236
     65     > chi.skewness
     66     ~0.318
     67     > chi.stdev
     68     ~0.691
     69     > chi.variance
     70     ~0.478
     71     > chi.cdf( 1.0 )
     72     ~0.014
     73     > chi.logpdf( 1.5 )
     74     ~-1.177
     75     > chi.pdf( 1.5 )
     76     ~0.308
     77     > chi.quantile( 0.5 )
     78     ~2.313
     79 
     80     See Also
     81     --------
     82