time-to-botec

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

repl.txt (1701B)

      1 
      2 {{alias}}( x, k, λ )
      3     Evaluates the probability density function (PDF) for an Erlang distribution
      4     with shape parameter `k` and rate parameter `λ` at a value `x`.
      5 
      6     If provided `NaN` as any argument, the function returns `NaN`.
      7 
      8     If not provided a nonnegative integer for `k`, the function returns `NaN`.
      9 
     10     If provided a non-positive value for `λ`, the function returns `NaN`.
     11 
     12     Parameters
     13     ----------
     14     x: number
     15         Input value.
     16 
     17     k: number
     18         Shape parameter.
     19 
     20     λ: number
     21         Rate parameter.
     22 
     23     Returns
     24     -------
     25     out: number
     26         Evaluated PDF.
     27 
     28     Examples
     29     --------
     30     > var y = {{alias}}( 0.1, 1, 1.0 )
     31     ~0.905
     32     > y = {{alias}}( 0.5, 2, 2.5 )
     33     ~0.895
     34     > y = {{alias}}( -1.0, 4, 2.0 )
     35     0.0
     36     > y = {{alias}}( NaN, 1, 1.0 )
     37     NaN
     38     > y = {{alias}}( 0.0, NaN, 1.0 )
     39     NaN
     40     > y = {{alias}}( 0.0, 1, NaN )
     41     NaN
     42     > y = {{alias}}( 2.0, -2, 0.5 )
     43     NaN
     44     > y = {{alias}}( 2.0, 0.5, 0.5 )
     45     NaN
     46     > y = {{alias}}( 2.0, 0.0, 2.0 )
     47     0.0
     48     > y = {{alias}}( 0.0, 0.0, 2.0 )
     49     Infinity
     50     > y = {{alias}}( 2.0, 1, 0.0 )
     51     NaN
     52     > y = {{alias}}( 2.0, 1, -1.0 )
     53     NaN
     54 
     55 
     56 {{alias}}.factory( k, λ )
     57     Returns a function for evaluating the probability density function (PDF)
     58     of an Erlang distribution with shape parameter `k` and rate parameter `λ`.
     59 
     60     Parameters
     61     ----------
     62     k: number
     63         Shape parameter.
     64 
     65     λ: number
     66         Rate parameter.
     67 
     68     Returns
     69     -------
     70     pdf: Function
     71         Probability density function (PDF).
     72 
     73     Examples
     74     --------
     75     > var myPDF = {{alias}}.factory( 6.0, 7.0 );
     76     > y = myPDF( 7.0 )
     77     ~8.639e-15
     78 
     79 
     80     See Also
     81     --------
     82