time-to-botec

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

repl.txt (1522B)

      1 
      2 {{alias}}( p, μ, s )
      3     Evaluates the quantile function for a logistic distribution with location
      4     parameter `μ` and scale parameter `s` 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 `s < 0`, the function returns `NaN`.
     11 
     12     Parameters
     13     ----------
     14     p: number
     15         Input probability.
     16 
     17     μ: number
     18         Location parameter.
     19 
     20     s: 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.386
     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 scale parameter:
     48     > y = {{alias}}( 0.5, 0.0, -1.0 )
     49     NaN
     50 
     51 
     52 {{alias}}.factory( μ, s )
     53     Returns a function for evaluating the quantile function of a logistic
     54     distribution with location parameter `μ` and scale parameter `s`.
     55 
     56     Parameters
     57     ----------
     58     μ: number
     59         Location parameter.
     60 
     61     s: number
     62         Scale parameter.
     63 
     64     Returns
     65     -------
     66     quantile: Function
     67         Quantile function.
     68 
     69     Examples
     70     --------
     71     > var myQuantile = {{alias}}.factory( 10.0, 2.0 );
     72     > var y = myQuantile( 0.5 )
     73     10.0
     74 
     75     See Also
     76     --------
     77