time-to-botec

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

repl.txt (1543B)


      1 
      2 {{alias}}( x, μ, σ )
      3     Evaluates the probability density function (PDF) for a normal distribution
      4     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 PDF.
     25 
     26     Examples
     27     --------
     28     > var y = {{alias}}( 2.0, 0.0, 1.0 )
     29     ~0.054
     30     > y = {{alias}}( -1.0, 4.0, 2.0 )
     31     ~0.009
     32     > y = {{alias}}( NaN, 0.0, 1.0 )
     33     NaN
     34     > y = {{alias}}( 0.0, NaN, 1.0 )
     35     NaN
     36     > y = {{alias}}( 0.0, 0.0, NaN )
     37     NaN
     38 
     39     // Negative standard deviation:
     40     > y = {{alias}}( 2.0, 0.0, -1.0 )
     41     NaN
     42 
     43     // Degenerate distribution centered at `μ` when `σ = 0.0`:
     44     > y = {{alias}}( 2.0, 8.0, 0.0 )
     45     0.0
     46     > y = {{alias}}( 8.0, 8.0, 0.0 )
     47     infinity
     48 
     49 
     50 {{alias}}.factory( μ, σ )
     51     Returns a function for evaluating the probability density function (PDF) of
     52     a normal distribution with mean `μ` and standard deviation `σ`.
     53 
     54     Parameters
     55     ----------
     56     μ: number
     57         Location parameter.
     58 
     59     σ: number
     60         Standard deviation.
     61 
     62     Returns
     63     -------
     64     pdf: Function
     65         Probability density function (PDF).
     66 
     67     Examples
     68     --------
     69     > var myPDF = {{alias}}.factory( 10.0, 2.0 );
     70     > var y = myPDF( 10.0 )
     71     ~0.199
     72 
     73     See Also
     74     --------
     75