time-to-botec

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

repl.txt (2137B)

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