time-to-botec

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

repl.txt (1757B)


      1 
      2 {{alias}}( p, a, b )
      3     Evaluates the quantile function for a Kumaraswamy's double bounded
      4     distribution with first shape parameter `a` and second shape parameter `b`
      5     at a probability `p`.
      6 
      7     If `p < 0` or `p > 1`, the function returns `NaN`.
      8 
      9     If provided `NaN` as any argument, the function returns `NaN`.
     10 
     11     If `a <= 0` or `b <= 0`, the function returns `NaN`.
     12 
     13     Parameters
     14     ----------
     15     p: number
     16         Input probability.
     17 
     18     a: number
     19         First shape parameter.
     20 
     21     b: number
     22         Second shape parameter.
     23 
     24     Returns
     25     -------
     26     out: number
     27         Evaluated quantile function.
     28 
     29     Examples
     30     --------
     31     > var y = {{alias}}( 0.5, 1.0, 1.0 )
     32     0.5
     33     > y = {{alias}}( 0.5, 2.0, 4.0 )
     34     ~0.399
     35     > y = {{alias}}( 0.2, 2.0, 2.0 )
     36     ~0.325
     37     > y = {{alias}}( 0.8, 4.0, 4.0 )
     38     ~0.759
     39 
     40     > y = {{alias}}( -0.5, 4.0, 2.0 )
     41     NaN
     42     > y = {{alias}}( 1.5, 4.0, 2.0 )
     43     NaN
     44 
     45     > y = {{alias}}( 2.0, -1.0, 0.5 )
     46     NaN
     47     > y = {{alias}}( 2.0, 0.5, -1.0 )
     48     NaN
     49 
     50     > y = {{alias}}( NaN, 1.0, 1.0 )
     51     NaN
     52     > y = {{alias}}( 0.0, NaN, 1.0 )
     53     NaN
     54     > y = {{alias}}( 0.0, 1.0, NaN )
     55     NaN
     56 
     57 
     58 {{alias}}.factory( a, b )
     59     Returns a function for evaluating the quantile function of a Kumaraswamy's
     60     double bounded distribution with first shape parameter `a` and second shape
     61     parameter `b`.
     62 
     63     Parameters
     64     ----------
     65     a: number
     66         First shape parameter.
     67 
     68     b: number
     69         Second shape parameter.
     70 
     71     Returns
     72     -------
     73     quantile: Function
     74         Quantile function.
     75 
     76     Examples
     77     --------
     78     > var myQuantile = {{alias}}.factory( 0.5, 1.0 );
     79     > var y = myQuantile( 0.8 )
     80     ~0.64
     81     > y = myQuantile( 0.3 )
     82     ~0.09
     83 
     84     See Also
     85     --------
     86