time-to-botec

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

repl.txt (1793B)

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