time-to-botec

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

repl.txt (1640B)


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