time-to-botec

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

repl.txt (1711B)

      1 
      2 {{alias}}( x, α, s, m )
      3     Evaluates the cumulative distribution function (CDF) for a Fréchet
      4     distribution with shape parameter `α`, scale parameter `s`, and location
      5     `m`.
      6 
      7     If provided `NaN` as any argument, the function returns `NaN`.
      8 
      9     If provided `α <= 0` or `s <= 0`, the function returns `NaN`.
     10 
     11     Parameters
     12     ----------
     13     x: number
     14         Input value.
     15 
     16     α: number
     17         Shape parameter.
     18 
     19     s: number
     20         Scale parameter.
     21 
     22     m: number
     23         Location parameter.
     24 
     25     Returns
     26     -------
     27     out: number
     28         Evaluated CDF.
     29 
     30     Examples
     31     --------
     32     > var y = {{alias}}( 10.0, 2.0, 3.0, 0.0 )
     33     ~0.914
     34     > y = {{alias}}( -1.0, 2.0, 3.0, -3.0 )
     35     ~0.105
     36     > y = {{alias}}( 2.5, 2.0, 1.0, 2.0 )
     37     ~0.018
     38     > y = {{alias}}( NaN, 1.0, 1.0, 0.0 )
     39     NaN
     40     > y = {{alias}}( 0.0, NaN, 1.0, 0.0 )
     41     NaN
     42     > y = {{alias}}( 0.0, 1.0, NaN, 0.0 )
     43     NaN
     44     > y = {{alias}}( 0.0, 1.0, 1.0, NaN )
     45     NaN
     46     > y = {{alias}}( 0.0, -1.0, 1.0, 0.0 )
     47     NaN
     48     > y = {{alias}}( 0.0, 1.0, -1.0, 0.0 )
     49     NaN
     50 
     51 
     52 {{alias}}.factory( α, s, m )
     53     Returns a function for evaluating the cumulative distribution function (CDF)
     54     of a Fréchet distribution with shape parameter `α`, scale parameter `s`, and
     55     location `m`.
     56 
     57     Parameters
     58     ----------
     59     α: number
     60         Shape parameter.
     61 
     62     s: number
     63         Scale parameter.
     64 
     65     m: number
     66         Location parameter.
     67 
     68     Returns
     69     -------
     70     cdf: Function
     71         Cumulative distribution function (CDF).
     72 
     73     Examples
     74     --------
     75     > var myCDF = {{alias}}.factory( 3.0, 3.0, 5.0 );
     76     > var y = myCDF( 10.0 )
     77     ~0.806
     78     > y = myCDF( 7.0 )
     79     ~0.034
     80 
     81     See Also
     82     --------
     83