time-to-botec

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

repl.txt (1814B)


      1 
      2 {{alias}}( x, d1, d2 )
      3     Evaluates the cumulative distribution function (CDF) for an F distribution
      4     with numerator degrees of freedom `d1` and denominator degrees of freedom
      5     `d2` at a value `x`.
      6 
      7     If provided `NaN` as any argument, the function returns `NaN`.
      8 
      9     If provided `d1 <= 0` or `d2 <= 0`, the function returns `NaN`.
     10 
     11     Parameters
     12     ----------
     13     x: number
     14         Input value.
     15 
     16     d1: number
     17         Numerator degrees of freedom.
     18 
     19     d2: number
     20         Denominator degrees of freedom.
     21 
     22     Returns
     23     -------
     24     out: number
     25         Evaluated CDF.
     26 
     27     Examples
     28     --------
     29     > var y = {{alias}}( 2.0, 1.0, 1.0 )
     30     ~0.608
     31     > var y = {{alias}}( 2.0, 8.0, 4.0 )
     32     ~0.737
     33     > var y = {{alias}}( -1.0, 2.0, 2.0 )
     34     0.0
     35     > var y = {{alias}}( {{alias:@stdlib/constants/float64/pinf}}, 4.0, 2.0 )
     36     1.0
     37     > var y = {{alias}}( {{alias:@stdlib/constants/float64/ninf}}, 4.0, 2.0 )
     38     0.0
     39 
     40     > var y = {{alias}}( NaN, 1.0, 1.0 )
     41     NaN
     42     > var y = {{alias}}( 0.0, NaN, 1.0 )
     43     NaN
     44     > var y = {{alias}}( 0.0, 1.0, NaN )
     45     NaN
     46 
     47     > var y = {{alias}}( 2.0, 1.0, -1.0 )
     48     NaN
     49     > var y = {{alias}}( 2.0, -1.0, 1.0 )
     50     NaN
     51 
     52 
     53 {{alias}}.factory( d1, d2 )
     54     Returns a function for evaluating the cumulative distribution function (CDF)
     55     of an F distribution with numerator degrees of freedom `d1` and denominator
     56     degrees of freedom `d2`.
     57 
     58     Parameters
     59     ----------
     60     d1: number
     61         Numerator degrees of freedom.
     62 
     63     d2: number
     64         Denominator degrees of freedom.
     65 
     66     Returns
     67     -------
     68     cdf: Function
     69         Cumulative distribution function (CDF).
     70 
     71     Examples
     72     --------
     73     > var myCDF = {{alias}}.factory( 10.0, 2.0 );
     74     > var y = myCDF( 10.0 )
     75     ~0.906
     76     > y = myCDF( 8.0 )
     77     ~0.884
     78 
     79     See Also
     80     --------
     81