time-to-botec

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

repl.txt (1600B)


      1 
      2 {{alias}}( x, d1, d2 )
      3     Evaluates the probability density function (PDF) for an F distribution with
      4     numerator degrees of freedom `d1` and denominator degrees of freedom `d2` at
      5     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 PDF.
     26 
     27     Examples
     28     --------
     29     > var y = {{alias}}( 2.0, 0.5, 1.0 )
     30     ~0.057
     31     > y = {{alias}}( 0.1, 1.0, 1.0 )
     32     ~0.915
     33     > y = {{alias}}( -1.0, 4.0, 2.0 )
     34     0.0
     35 
     36     > y = {{alias}}( NaN, 1.0, 1.0 )
     37     NaN
     38     > y = {{alias}}( 0.0, NaN, 1.0 )
     39     NaN
     40     > y = {{alias}}( 0.0, 1.0, NaN )
     41     NaN
     42 
     43     > y = {{alias}}( 2.0, 1.0, -1.0 )
     44     NaN
     45     > y = {{alias}}( 2.0, -1.0, 1.0 )
     46     NaN
     47 
     48 
     49 {{alias}}.factory( d1, d2 )
     50     Returns a function for evaluating the probability density function (PDF) of
     51     an F distribution with numerator degrees of freedom `d1` and denominator
     52     degrees of freedom `d2`.
     53 
     54     Parameters
     55     ----------
     56     d1: number
     57         Numerator degrees of freedom.
     58 
     59     d2: number
     60         Denominator degrees of freedom.
     61 
     62     Returns
     63     -------
     64     pdf: Function
     65         Probability density function (PDF).
     66 
     67     Examples
     68     --------
     69     > var myPDF = {{alias}}.factory( 6.0, 7.0 );
     70     > var y = myPDF( 7.0 )
     71     ~0.004
     72     > y = myPDF( 2.0 )
     73     ~0.166
     74 
     75     See Also
     76     --------
     77