time-to-botec

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

repl.txt (2245B)

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