time-to-botec

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

repl.txt (1665B)

      1 
      2 {{alias}}( p, α, β )
      3     Evaluates the quantile function for an inverse gamma distribution with shape
      4     parameter `α` and scale 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         Scale 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     ~1.213
     32     > y = {{alias}}( 0.5, 4.0, 2.0 )
     33     ~0.545
     34     > y = {{alias}}( 1.1, 1.0, 1.0 )
     35     NaN
     36     > y = {{alias}}( -0.2, 1.0, 1.0 )
     37     NaN
     38 
     39     > y = {{alias}}( NaN, 1.0, 1.0 )
     40     NaN
     41     > y = {{alias}}( 0.0, NaN, 1.0 )
     42     NaN
     43     > y = {{alias}}( 0.0, 1.0, NaN )
     44     NaN
     45 
     46     // Non-positive shape parameter:
     47     > y = {{alias}}( 0.5, -1.0, 1.0 )
     48     NaN
     49 
     50     // Non-positive rate parameter:
     51     > y = {{alias}}( 0.5, 1.0, -1.0 )
     52     NaN
     53 
     54 
     55 {{alias}}.factory( α, β )
     56     Returns a function for evaluating the quantile function of an inverse gamma
     57     distribution with shape parameter `α` and scale parameter `β`.
     58 
     59     Parameters
     60     ----------
     61     α: number
     62         Shape parameter.
     63 
     64     β: number
     65         Scale parameter.
     66 
     67     Returns
     68     -------
     69     quantile: Function
     70         Quantile function.
     71 
     72     Examples
     73     --------
     74     > var myQuantile = {{alias}}.factory( 2.0, 2.0 );
     75     > var y = myQuantile( 0.8 )
     76     ~2.426
     77     > y = myQuantile( 0.4 )
     78     ~0.989
     79 
     80     See Also
     81     --------
     82