time-to-botec

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

repl.txt (1939B)


      1 
      2 {{alias}}( [v] )
      3     Returns a Student's t distribution object.
      4 
      5     Parameters
      6     ----------
      7     v: number (optional)
      8         Degrees of freedom. Must be greater than `0`. Default: `1.0`.
      9 
     10     Returns
     11     -------
     12     t: Object
     13         Distribution instance.
     14 
     15     t.v: number
     16         Degrees of freedom. If set, the value must be greater than `0`.
     17 
     18     t.entropy: number
     19         Read-only property which returns the differential entropy.
     20 
     21     t.kurtosis: number
     22         Read-only property which returns the excess kurtosis.
     23 
     24     t.mean: number
     25         Read-only property which returns the expected value.
     26 
     27     t.median: number
     28         Read-only property which returns the median.
     29 
     30     t.mode: number
     31         Read-only property which returns the mode.
     32 
     33     t.skewness: number
     34         Read-only property which returns the skewness.
     35 
     36     t.stdev: number
     37         Read-only property which returns the standard deviation.
     38 
     39     t.variance: number
     40         Read-only property which returns the variance.
     41 
     42     t.cdf: Function
     43         Evaluates the cumulative distribution function (CDF).
     44 
     45     t.logcdf: Function
     46         Evaluates the natural logarithm of the cumulative distribution function
     47         (CDF).
     48 
     49     t.logpdf: Function
     50         Evaluates the natural logarithm of the probability density function
     51         (PDF).
     52 
     53     t.pdf: Function
     54         Evaluates the probability density function (PDF).
     55 
     56     t.quantile: Function
     57         Evaluates the quantile function at probability `p`.
     58 
     59     Examples
     60     --------
     61     > var t = {{alias}}( 6.0 );
     62     > t.v
     63     6.0
     64     > t.entropy
     65     ~1.592
     66     > t.kurtosis
     67     3.0
     68     > t.mean
     69     0.0
     70     > t.median
     71     0.0
     72     > t.mode
     73     0.0
     74     > t.skewness
     75     0.0
     76     > t.stdev
     77     ~1.225
     78     > t.variance
     79     1.5
     80     > t.cdf( 1.0 )
     81     ~0.822
     82     > t.logcdf( 1.0 )
     83     ~-0.196
     84     > t.logpdf( 1.5 )
     85     ~-2.075
     86     > t.pdf( 1.5 )
     87     ~0.126
     88     > t.quantile( 0.8 )
     89     ~0.906
     90 
     91     See Also
     92     --------
     93