time-to-botec

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

repl.txt (1698B)


      1 
      2 {{alias}}( p, d1, d2 )
      3     Evaluates the quantile function for an F distribution with numerator degrees
      4     of freedom `d1` and denominator degrees of freedom `d2` at a probability
      5     `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 provided `d1 <= 0` or `d2 <= 0`, the function returns `NaN`.
     12 
     13     Parameters
     14     ----------
     15     p: number
     16         Input probability.
     17 
     18     d1: number
     19         Numerator degrees of freedom.
     20 
     21     d2: number
     22         Denominator degrees of freedom.
     23 
     24     Returns
     25     -------
     26     out: number
     27         Evaluated quantile function.
     28 
     29     Examples
     30     --------
     31     > var y = {{alias}}( 0.8, 1.0, 1.0 )
     32     ~9.472
     33     > y = {{alias}}( 0.5, 4.0, 2.0 )
     34     ~1.207
     35 
     36     > y = {{alias}}( 1.1, 1.0, 1.0 )
     37     NaN
     38     > y = {{alias}}( -0.2, 1.0, 1.0 )
     39     NaN
     40 
     41     > y = {{alias}}( NaN, 1.0, 1.0 )
     42     NaN
     43     > y = {{alias}}( 0.5, NaN, 1.0 )
     44     NaN
     45     > y = {{alias}}( 0.5, 1.0, NaN )
     46     NaN
     47 
     48     > y = {{alias}}( 0.5, -1.0, 1.0 )
     49     NaN
     50     > y = {{alias}}( 0.5, 1.0, -1.0 )
     51     NaN
     52 
     53 
     54 {{alias}}.factory( d1, d2 )
     55     Returns a function for evaluating the quantile function of an F distribution
     56     with numerator degrees of freedom `d1` and denominator degrees of freedom
     57     `d2`.
     58 
     59     Parameters
     60     ----------
     61     d1: number
     62         Numerator degrees of freedom.
     63 
     64     d2: number
     65         Denominator degrees of freedom.
     66 
     67     Returns
     68     -------
     69     quantile: Function
     70         Quantile function.
     71 
     72     Examples
     73     --------
     74     > var myQuantile = {{alias}}.factory( 10.0, 2.0 );
     75     > var y = myQuantile( 0.2 )
     76     ~0.527
     77     > y = myQuantile( 0.8 )
     78     ~4.382
     79 
     80     See Also
     81     --------
     82