time-to-botec

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

repl.txt (1509B)

      1 
      2 {{alias}}( x, μ, σ )
      3     Evaluates the cumulative distribution function (CDF) for a lognormal
      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}}( 2.0, 0.0, 1.0 )
     30     ~0.756
     31     > y = {{alias}}( 5.0, 10.0, 3.0 )
     32     ~0.003
     33 
     34     > y = {{alias}}( 2.0, 0.0, NaN )
     35     NaN
     36     > y = {{alias}}( 2.0, NaN, 1.0 )
     37     NaN
     38     > y = {{alias}}( NaN, 0.0, 1.0 )
     39     NaN
     40 
     41     // Non-positive scale parameter `σ`:
     42     > y = {{alias}}( 2.0, 0.0, -1.0 )
     43     NaN
     44     > y = {{alias}}( 2.0, 0.0, 0.0 )
     45     NaN
     46 
     47 
     48 {{alias}}.factory( μ, σ )
     49     Returns a function for evaluating the cumulative distribution function (CDF)
     50     of a lognormal distribution with location parameter `μ` and scale parameter
     51     `σ`.
     52 
     53     Parameters
     54     ----------
     55     μ: number
     56         Location parameter.
     57 
     58     σ: number
     59         Scale parameter.
     60 
     61     Returns
     62     -------
     63     cdf: Function
     64         Cumulative distribution function (CDF).
     65 
     66     Examples
     67     --------
     68     > var myCDF = {{alias}}.factory( 3.0, 1.5 );
     69     > var y = myCDF( 1.0 )
     70     ~0.023
     71     > y = myCDF( 4.0 )
     72     ~0.141
     73 
     74     See Also
     75     --------
     76