time-to-botec

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

repl.txt (1503B)

      1 
      2 {{alias}}( p, λ )
      3     Evaluates the quantile function for a Poisson distribution with mean
      4     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 provided a negative value for `λ`, the function returns `NaN`.
     11 
     12     Parameters
     13     ----------
     14     p: number
     15         Input probability.
     16 
     17     λ: number
     18         Mean parameter.
     19 
     20     Returns
     21     -------
     22     out: number
     23         Evaluated quantile function.
     24 
     25     Examples
     26     --------
     27     > var y = {{alias}}( 0.5, 2.0 )
     28     2
     29     > y = {{alias}}( 0.9, 4.0 )
     30     7
     31     > y = {{alias}}( 0.1, 200.0 )
     32     182
     33 
     34     > y = {{alias}}( 1.1, 0.0 )
     35     NaN
     36     > y = {{alias}}( -0.2, 0.0 )
     37     NaN
     38 
     39     > y = {{alias}}( NaN, 0.5 )
     40     NaN
     41     > y = {{alias}}( 0.0, NaN )
     42     NaN
     43 
     44     // Negative mean parameter:
     45     > y = {{alias}}( 2.0, -1.0 )
     46     NaN
     47 
     48     // Degenerate distribution at `λ = 0`:
     49     > y = {{alias}}( 0.1, 0.0 )
     50     0.0
     51     > y = {{alias}}( 0.9, 0.0 )
     52     0.0
     53 
     54 
     55 {{alias}}.factory( λ )
     56     Returns a function for evaluating the quantile function of a Poisson
     57     distribution with mean parameter `λ`.
     58 
     59     Parameters
     60     ----------
     61     λ: number
     62         Mean parameter.
     63 
     64     Returns
     65     -------
     66     quantile: Function
     67         Quantile function.
     68 
     69     Examples
     70     --------
     71     > var myQuantile = {{alias}}.factory( 0.4 );
     72     > var y = myQuantile( 0.4 )
     73     0.0
     74     > y = myQuantile( 1.0 )
     75     Infinity
     76 
     77     See Also
     78     --------
     79