time-to-botec

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

repl.txt (1955B)


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