time-to-botec

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

repl.txt (1258B)


      1 
      2 {{alias}}( p, a[, upper] )
      3     Computes the inverse of the lower incomplete gamma function.
      4 
      5     In contrast to a more commonly used definition, the first argument is the
      6     probability `p` and the second argument is the scale factor `a`.
      7 
      8     By default, the function inverts the lower regularized incomplete gamma
      9     function, `P(x,a)`. To invert the upper function `Q(x,a)`, set the `upper`
     10     argument to `true`.
     11 
     12     If provided `NaN` as any argument, the function returns `NaN`.
     13 
     14     If provided `p < 0` or `p > 1`, the function returns `NaN`.
     15 
     16     Parameters
     17     ----------
     18     p: number
     19         Probability.
     20 
     21     a: number
     22         Scale parameter.
     23 
     24     upper: boolean (optional)
     25         Boolean indicating if the function should invert the upper tail of the
     26         incomplete gamma function; i.e., compute `xr` such that `Q(a,xr) = p`.
     27         Default: `false`.
     28 
     29     Returns
     30     -------
     31     y: number
     32         Function value.
     33 
     34     Examples
     35     --------
     36     > var y = {{alias}}( 0.5, 2.0 )
     37     ~1.678
     38     > y = {{alias}}( 0.1, 10.0 )
     39     ~6.221
     40     > y = {{alias}}( 0.75, 3.0 )
     41     ~3.92
     42     > y = {{alias}}( 0.75, 3.0, true )
     43     ~1.727
     44     > y = {{alias}}( 0.75, NaN )
     45     NaN
     46     > y = {{alias}}( NaN, 3.0 )
     47     NaN
     48 
     49     See Also
     50     --------
     51