time-to-botec

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

repl.txt (1291B)

      1 
      2 {{alias}}( p, n )
      3     Evaluates the quantile function for the Wilcoxon signed rank test statistic
      4     with `n` observations 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 not provided a positive integer for `n`, the function returns `NaN`.
     11 
     12     Parameters
     13     ----------
     14     p: number
     15         Input probability.
     16 
     17     n: integer
     18         Number of observations.
     19 
     20     Returns
     21     -------
     22     out: number
     23         Evaluated quantile function.
     24 
     25     Examples
     26     --------
     27     > var y = {{alias}}( 0.8, 5 )
     28     11
     29     > y = {{alias}}( 0.5, 4 )
     30     5
     31 
     32     > y = {{alias}}( 1.1, 5 )
     33     NaN
     34     > y = {{alias}}( -0.2, 5 )
     35     NaN
     36 
     37     > y = {{alias}}( NaN, 5 )
     38     NaN
     39     > y = {{alias}}( 0.0, NaN )
     40     NaN
     41 
     42 
     43 {{alias}}.factory( n )
     44     Returns a function for evaluating the quantile function of the Wilcoxon
     45     signed rank test statistic with `n` observations.
     46 
     47     Parameters
     48     ----------
     49     n: integer
     50         Number of observations.
     51 
     52     Returns
     53     -------
     54     quantile: Function
     55         Quantile function.
     56 
     57     Examples
     58     --------
     59     > var myQuantile = {{alias}}.factory( 8 );
     60     > var y = myQuantile( 0.4 )
     61     16
     62     > y = myQuantile( 1.0 )
     63     36
     64 
     65     See Also
     66     --------
     67