repl.txt (1633B)
1 2 {{alias}}( p, μ, σ ) 3 Evaluates the quantile function for a lognormal distribution with location 4 parameter `μ` and scale parameter `σ` at a probability `p`. 5 6 If `p < 0` or `p > 1`, the function returns `NaN`. 7 8 If provided `NaN` as any argument, the function returns `NaN`. 9 10 If provided `σ <= 0`, the function returns `NaN`. 11 12 Parameters 13 ---------- 14 p: number 15 Input probability. 16 17 μ: number 18 Location parameter. 19 20 σ: number 21 Scale parameter. 22 23 Returns 24 ------- 25 out: number 26 Evaluated quantile function. 27 28 Examples 29 -------- 30 > var y = {{alias}}( 0.8, 0.0, 1.0 ) 31 ~2.32 32 > y = {{alias}}( 0.5, 4.0, 2.0 ) 33 ~54.598 34 > y = {{alias}}( 1.1, 0.0, 1.0 ) 35 NaN 36 > y = {{alias}}( -0.2, 0.0, 1.0 ) 37 NaN 38 39 > y = {{alias}}( NaN, 0.0, 1.0 ) 40 NaN 41 > y = {{alias}}( 0.0, NaN, 1.0 ) 42 NaN 43 > y = {{alias}}( 0.0, 0.0, NaN ) 44 NaN 45 46 // Non-positive scale parameter `σ`: 47 > y = {{alias}}( 0.5, 0.0, -1.0 ) 48 NaN 49 > y = {{alias}}( 0.5, 0.0, 0.0 ) 50 NaN 51 52 53 {{alias}}.factory( μ, σ ) 54 Returns a function for evaluating the quantile function of a lognormal 55 distribution with location parameter `μ` and scale parameter `σ`. 56 57 Parameters 58 ---------- 59 μ: number 60 Location parameter. 61 62 σ: number 63 Scale parameter. 64 65 Returns 66 ------- 67 quantile: Function 68 Quantile function. 69 70 Examples 71 -------- 72 > var myQuantile = {{alias}}.factory( 4.0, 2.0 ); 73 > var y = myQuantile( 0.2 ) 74 ~10.143 75 > y = myQuantile( 0.8 ) 76 ~293.901 77 78 See Also 79 -------- 80