time-to-botec

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

repl.txt (1799B)

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