time-to-botec

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

repl.txt (2391B)

      1 
      2 {{alias}}( [μ, b] )
      3     Returns a Laplace distribution object.
      4 
      5     Parameters
      6     ----------
      7     μ: number (optional)
      8         Location parameter. Default: `0.0`.
      9 
     10     b: number (optional)
     11         Scale parameter. Must be greater than `0`. Default: `1.0`.
     12 
     13     Returns
     14     -------
     15     laplace: Object
     16         Distribution instance.
     17 
     18     laplace.mu: number
     19         Location parameter.
     20 
     21     laplace.b: number
     22         Scale parameter. If set, the value must be greater than `0`.
     23 
     24     laplace.entropy: number
     25         Read-only property which returns the differential entropy.
     26 
     27     laplace.kurtosis: number
     28         Read-only property which returns the excess kurtosis.
     29 
     30     laplace.mean: number
     31         Read-only property which returns the expected value.
     32 
     33     laplace.median: number
     34         Read-only property which returns the median.
     35 
     36     laplace.mode: number
     37         Read-only property which returns the mode.
     38 
     39     laplace.skewness: number
     40         Read-only property which returns the skewness.
     41 
     42     laplace.stdev: number
     43         Read-only property which returns the standard deviation.
     44 
     45     laplace.variance: number
     46         Read-only property which returns the variance.
     47 
     48     laplace.cdf: Function
     49         Evaluates the cumulative distribution function (CDF).
     50 
     51     laplace.logcdf: Function
     52         Evaluates the natural logarithm of the cumulative distribution function
     53         (CDF).
     54 
     55     laplace.logpdf: Function
     56         Evaluates the natural logarithm of the probability density function
     57         (PDF).
     58 
     59     laplace.mgf: Function
     60         Evaluates the moment-generating function (MGF).
     61 
     62     laplace.pdf: Function
     63         Evaluates the probability density function (PDF).
     64 
     65     laplace.quantile: Function
     66         Evaluates the quantile function at probability `p`.
     67 
     68     Examples
     69     --------
     70     > var laplace = {{alias}}( -2.0, 3.0 );
     71     > laplace.mu
     72     -2.0
     73     > laplace.b
     74     3.0
     75     > laplace.entropy
     76     ~2.792
     77     > laplace.kurtosis
     78     3.0
     79     > laplace.mean
     80     -2.0
     81     > laplace.median
     82     -2.0
     83     > laplace.mode
     84     -2.0
     85     > laplace.skewness
     86     0.0
     87     > laplace.stdev
     88     ~4.243
     89     > laplace.variance
     90     18.0
     91     > laplace.cdf( 0.8 )
     92     ~0.803
     93     > laplace.logcdf( 0.8 )
     94     ~-0.219
     95     > laplace.logpdf( 1.0 )
     96     ~-2.792
     97     > laplace.mgf( 0.2 )
     98     ~1.047
     99     > laplace.pdf( 2.0 )
    100     ~0.044
    101     > laplace.quantile( 0.9 )
    102     ~2.828
    103 
    104     See Also
    105     --------
    106