time-to-botec

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

repl.txt (1152B)

      1 
      2 {{alias}}( p, μ )
      3     Evaluates the quantile function for a degenerate distribution with mean `μ`.
      4 
      5     If `p < 0` or `p > 1`, the function returns `NaN`.
      6 
      7     If provided `NaN` for any argument, the function returns `NaN`.
      8 
      9     Parameters
     10     ----------
     11     p: number
     12         Input probability.
     13 
     14     μ: number
     15         Constant value of distribution.
     16 
     17     Returns
     18     -------
     19     out: number
     20         Evaluated quantile function.
     21 
     22     Examples
     23     --------
     24     > var y = {{alias}}( 0.5, 2.0 )
     25     2.0
     26     > y = {{alias}}( 0.9, 4.0 )
     27     4.0
     28     > y = {{alias}}( 1.1, 0.0 )
     29     NaN
     30     > y = {{alias}}( -0.2, 0.0 )
     31     NaN
     32     > y = {{alias}}( NaN, 0.0 )
     33     NaN
     34     > y = {{alias}}( 0.0, NaN )
     35     NaN
     36 
     37 
     38 {{alias}}.factory( μ )
     39     Returns a function for evaluating the quantile function of a degenerate
     40     distribution with mean `μ`.
     41 
     42     Parameters
     43     ----------
     44     μ: number
     45         Constant value of distribution.
     46 
     47     Returns
     48     -------
     49     quantile: Function
     50         Quantile function.
     51 
     52     Examples
     53     --------
     54     > var myQuantile = {{alias}}.factory( 10.0, 2.0 );
     55     > var y = myQuantile( 0.5 )
     56     10.0
     57 
     58     See Also
     59     --------
     60