time-to-botec

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

repl.txt (1668B)


      1 
      2 {{alias}}( p, μ, σ )
      3     Evaluates the quantile function for a normal distribution with mean `μ` and
      4     standard deviation `σ` 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         Standard deviation.
     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     ~0.842
     32     > y = {{alias}}( 0.5, 4.0, 2.0 )
     33     4
     34 
     35     > y = {{alias}}( 1.1, 0.0, 1.0 )
     36     NaN
     37     > y = {{alias}}( -0.2, 0.0, 1.0 )
     38     NaN
     39 
     40     > y = {{alias}}( NaN, 0.0, 1.0 )
     41     NaN
     42     > y = {{alias}}( 0.0, NaN, 1.0 )
     43     NaN
     44     > y = {{alias}}( 0.0, 0.0, NaN )
     45     NaN
     46 
     47     // Negative standard deviation:
     48     > y = {{alias}}( 0.5, 0.0, -1.0 )
     49     NaN
     50 
     51     // Degenerate distribution centered at `μ` when `σ = 0.0`:
     52     > y = {{alias}}( 0.3, 8.0, 0.0 )
     53     8.0
     54     > y = {{alias}}( 0.9, 8.0, 0.0 )
     55     8.0
     56 
     57 
     58 {{alias}}.factory( μ, σ )
     59     Returns a function for evaluating the quantile function
     60     of a normal distribution with mean `μ` and standard deviation `σ`.
     61 
     62     Parameters
     63     ----------
     64     μ: number
     65         Location parameter.
     66 
     67     σ: number
     68         Standard deviation.
     69 
     70     Returns
     71     -------
     72     quantile: Function
     73         Quantile function.
     74 
     75     Examples
     76     --------
     77     > var myQuantile = {{alias}}.factory( 10.0, 2.0 );
     78     > var y = myQuantile( 0.5 )
     79     10.0
     80 
     81     See Also
     82     --------
     83