time-to-botec

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

repl.txt (1509B)

      1 
      2 {{alias}}( p, k, λ )
      3     Evaluates the quantile function for a Weibull distribution with scale
      4     parameter `k` and shape 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 a nonpositive value for `λ` or `k`, the function returns `NaN`.
     11 
     12     Parameters
     13     ----------
     14     p: number
     15         Input probability.
     16 
     17     k: number
     18         Shape 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, 1.0, 1.0 )
     31     ~1.609
     32     > y = {{alias}}( 0.5, 2.0, 4.0 )
     33     ~3.33
     34 
     35     > y = {{alias}}( 1.1, 1.0, 1.0 )
     36     NaN
     37     > y = {{alias}}( -0.2, 1.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     > y = {{alias}}( 0.5, 1.0, -1.0 )
     48     NaN
     49 
     50 
     51 {{alias}}.factory( k, λ )
     52     Returns a function for evaluating the quantile function of a Weibull
     53     distribution with scale parameter `k` and shape parameter `λ`.
     54 
     55     Parameters
     56     ----------
     57     k: number
     58         Shape parameter.
     59 
     60     λ: number
     61         Scale parameter.
     62 
     63     Returns
     64     -------
     65     quantile: Function
     66         Quantile function.
     67 
     68     Examples
     69     --------
     70     > var myQuantile = {{alias}}.factory( 2.0, 10.0 );
     71     > var y = myQuantile( 0.4 )
     72     ~7.147
     73 
     74     See Also
     75     --------
     76