time-to-botec

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

repl.txt (2286B)

      1 
      2 {{alias}}( [σ] )
      3     Returns a Rayleigh distribution object.
      4 
      5     Parameters
      6     ----------
      7     σ: number (optional)
      8         Scale parameter. Must be greater than `0`. Default: `1.0`.
      9 
     10     Returns
     11     -------
     12     rayleigh: Object
     13         Distribution instance.
     14 
     15     rayleigh.sigma: number
     16         Scale parameter. If set, the value must be greater than `0`.
     17 
     18     rayleigh.entropy: number
     19         Read-only property which returns the differential entropy.
     20 
     21     rayleigh.kurtosis: number
     22         Read-only property which returns the excess kurtosis.
     23 
     24     rayleigh.mean: number
     25         Read-only property which returns the expected value.
     26 
     27     rayleigh.median: number
     28         Read-only property which returns the median.
     29 
     30     rayleigh.mode: number
     31         Read-only property which returns the mode.
     32 
     33     rayleigh.skewness: number
     34         Read-only property which returns the skewness.
     35 
     36     rayleigh.stdev: number
     37         Read-only property which returns the standard deviation.
     38 
     39     rayleigh.variance: number
     40         Read-only property which returns the variance.
     41 
     42     rayleigh.cdf: Function
     43         Evaluates the cumulative distribution function (CDF).
     44 
     45     rayleigh.logcdf: Function
     46         Evaluates the natural logarithm of the cumulative distribution function
     47         (CDF).
     48 
     49     rayleigh.logpdf: Function
     50         Evaluates the natural logarithm of the probability density function
     51         (PDF).
     52 
     53     rayleigh.mgf: Function
     54         Evaluates the moment-generating function (MGF).
     55 
     56     rayleigh.pdf: Function
     57         Evaluates the probability density function (PDF).
     58 
     59     rayleigh.quantile: Function
     60         Evaluates the quantile function at probability `p`.
     61 
     62     Examples
     63     --------
     64     > var rayleigh = {{alias}}( 6.0 );
     65     > rayleigh.sigma
     66     6.0
     67     > rayleigh.entropy
     68     ~2.734
     69     > rayleigh.kurtosis
     70     ~0.245
     71     > rayleigh.mean
     72     ~7.52
     73     > rayleigh.median
     74     ~7.064
     75     > rayleigh.mode
     76     6.0
     77     > rayleigh.skewness
     78     ~0.631
     79     > rayleigh.stdev
     80     ~3.931
     81     > rayleigh.variance
     82     ~15.451
     83     > rayleigh.cdf( 1.0 )
     84     ~0.014
     85     > rayleigh.logcdf( 1.0 )
     86     ~-4.284
     87     > rayleigh.logpdf( 1.5 )
     88     ~-3.209
     89     > rayleigh.mgf( -0.5 )
     90     ~-0.91
     91     > rayleigh.pdf( 1.5 )
     92     ~0.04
     93     > rayleigh.quantile( 0.5 )
     94     ~7.064
     95 
     96     See Also
     97     --------
     98