time-to-botec

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

repl.txt (1794B)


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