time-to-botec

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

repl.txt (1763B)

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