time-to-botec

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

repl.txt (1497B)

      1 
      2 {{alias}}( x, μ, β )
      3     Evaluates the cumulative distribution function (CDF) for a Gumbel
      4     distribution with location parameter `μ` and scale parameter `β` at a value
      5     `x`.
      6 
      7     If provided `NaN` as any argument, the function returns `NaN`.
      8 
      9     If provided `β <= 0`, the function returns `NaN`.
     10 
     11     Parameters
     12     ----------
     13     x: number
     14         Input value.
     15 
     16     μ: number
     17         Location parameter.
     18 
     19     β: number
     20         Scale parameter.
     21 
     22     Returns
     23     -------
     24     out: number
     25         Evaluated CDF.
     26 
     27     Examples
     28     --------
     29     > var y = {{alias}}( 10.0, 0.0, 3.0 )
     30     ~0.965
     31     > y = {{alias}}( -2.0, 0.0, 3.0 )
     32     ~0.143
     33     > y = {{alias}}( 0.0, 0.0, 1.0 )
     34     ~0.368
     35     > y = {{alias}}( NaN, 0.0, 1.0 )
     36     NaN
     37     > y = {{alias}}( 0.0, NaN, 1.0 )
     38     NaN
     39     > y = {{alias}}( 0.0, 0.0, NaN )
     40     NaN
     41     // Negative scale parameter:
     42     > y = {{alias}}( 0.0, 0.0, -1.0 )
     43     NaN
     44 
     45 
     46 {{alias}}.factory( μ, β )
     47     Returns a function for evaluating the cumulative distribution function (CDF)
     48     of a Gumbel distribution with location parameter `μ` and scale parameter
     49     `β`.
     50 
     51     Parameters
     52     ----------
     53     μ: number
     54         Location parameter.
     55 
     56     β: number
     57         Scale parameter.
     58 
     59     Returns
     60     -------
     61     cdf: Function
     62         Cumulative distribution function (CDF).
     63 
     64     Examples
     65     --------
     66     > var myCDF = {{alias}}.factory( 2.0, 3.0 );
     67     > var y = myCDF( 10.0 )
     68     ~0.933
     69     > y = myCDF( 2.0 )
     70     ~0.368
     71 
     72     See Also
     73     --------
     74