time-to-botec

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

repl.txt (1618B)

      1 
      2 {{alias}}( p, μ, β )
      3     Evaluates the quantile function for a Gumbel 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     ~1.5
     32     > y = {{alias}}( 0.5, 4.0, 2.0 )
     33     ~4.733
     34     > y = {{alias}}( 0.5, 4.0, 4.0 )
     35     ~5.466
     36 
     37     > y = {{alias}}( 1.1, 0.0, 1.0 )
     38     NaN
     39     > y = {{alias}}( -0.2, 0.0, 1.0 )
     40     NaN
     41 
     42     > y = {{alias}}( NaN, 0.0, 1.0 )
     43     NaN
     44     > y = {{alias}}( 0.0, NaN, 1.0 )
     45     NaN
     46     > y = {{alias}}( 0.0, 0.0, NaN )
     47     NaN
     48 
     49     // Negative scale parameter:
     50     > y = {{alias}}( 0.5, 0.0, -1.0 )
     51     NaN
     52 
     53 
     54 {{alias}}.factory( μ, β )
     55     Returns a function for evaluating the quantile function of a Gumbel
     56     distribution with location parameter `μ` and scale parameter `β`.
     57 
     58     Parameters
     59     ----------
     60     μ: number
     61         Location parameter.
     62 
     63     β: number
     64         Scale parameter.
     65 
     66     Returns
     67     -------
     68     quantile: Function
     69         Quantile function.
     70 
     71     Examples
     72     --------
     73     > var myQuantile = {{alias}}.factory( 8.0, 2.0 );
     74     > var y = myQuantile( 0.5 )
     75     ~8.733
     76     > y = myQuantile( 0.7 )
     77     ~10.062
     78 
     79     See Also
     80     --------
     81