time-to-botec

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

repl.txt (1377B)


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