time-to-botec

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

repl.txt (2220B)

      1 
      2 {{alias}}( [μ] )
      3     Returns a degenerate distribution object.
      4 
      5     Parameters
      6     ----------
      7     μ: number (optional)
      8         Constant value of distribution.
      9 
     10     Returns
     11     -------
     12     degenerate: Object
     13         Distribution instance.
     14 
     15     degenerate.mu: number
     16         Constant value of distribution.
     17 
     18     degenerate.entropy: number
     19         Read-only property which returns the differential entropy.
     20 
     21     degenerate.mean: number
     22         Read-only property which returns the expected value.
     23 
     24     degenerate.median: number
     25         Read-only property which returns the median.
     26 
     27     degenerate.stdev: number
     28         Read-only property which returns the standard deviation.
     29 
     30     degenerate.variance: number
     31         Read-only property which returns the variance.
     32 
     33     degenerate.cdf: Function
     34         Evaluates the cumulative distribution function (CDF).
     35 
     36     degenerate.logcdf: Function
     37         Evaluates the natural logarithm of the cumulative distribution function
     38         (CDF).
     39 
     40     degenerate.logpdf: Function
     41         Evaluates the natural logarithm of the probability density function
     42         (PDF).
     43 
     44     degenerate.logpmf: Function
     45         Evaluates the natural logarithm of the probability mass function
     46         (PMF).
     47 
     48     degenerate.mgf: Function
     49         Evaluates the moment-generating function (MGF).
     50 
     51     degenerate.pmf: Function
     52         Evaluates the probability mass function (PMF).
     53 
     54     degenerate.pdf: Function
     55         Evaluates the probability density function (PDF).
     56 
     57     degenerate.quantile: Function
     58         Evaluates the quantile function at probability `p`.
     59 
     60     Examples
     61     --------
     62     > var degenerate = {{alias}}( 2.0 );
     63     > degenerate.mu
     64     2.0
     65     > degenerate.entropy
     66     0.0
     67     > degenerate.mean
     68     2.0
     69     > degenerate.mode
     70     2.0
     71     > degenerate.median
     72     2.0
     73     > degenerate.stdev
     74     0.0
     75     > degenerate.variance
     76     0.0
     77     > degenerate.cdf( 0.5 )
     78     0.0
     79     > degenerate.logcdf( 2.5 )
     80     0.0
     81     > degenerate.logpdf( 0.5 )
     82     -Infinity
     83     > degenerate.logpmf( 2.5 )
     84     -Infinity
     85     > degenerate.mgf( 0.2 )
     86     ~1.492
     87     > degenerate.pdf( 2.0 )
     88     +Infinity
     89     > degenerate.pmf( 2.0 )
     90     1.0
     91     > degenerate.quantile( 0.7 )
     92     2.0
     93 
     94     See Also
     95     --------
     96