repl.txt (1554B)
1 2 {{alias}}( x, μ, β ) 3 Evaluates the logarithm of the cumulative distribution function (CDF) for a 4 Gumbel distribution with location parameter `μ` and scale parameter `β` at a 5 value `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 logCDF. 26 27 Examples 28 -------- 29 > var y = {{alias}}( 10.0, 0.0, 3.0 ) 30 ~-0.036 31 > y = {{alias}}( -2.0, 0.0, 3.0 ) 32 ~-1.948 33 > y = {{alias}}( 0.0, 0.0, 1.0 ) 34 ~-1.0 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 logarithm of the cumulative 48 distribution function (CDF) of a Gumbel distribution with location parameter 49 `μ` and scale parameter `β`. 50 51 Parameters 52 ---------- 53 μ: number 54 Location parameter. 55 56 β: number 57 Scale parameter. 58 59 Returns 60 ------- 61 logcdf: Function 62 Logarithm of cumulative distribution function (CDF). 63 64 Examples 65 -------- 66 > var myLCDF = {{alias}}.factory( 2.0, 3.0 ); 67 > var y = myLCDF( 10.0 ) 68 ~-0.069 69 > y = myLCDF( 2.0 ) 70 ~-1.0 71 72 See Also 73 -------- 74