time-to-botec

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

repl.txt (1291B)

      1 
      2 {{alias}}( x, n )
      3     Evaluates the probability density function (PDF) for the distribution of
      4     the Wilcoxon signed rank test statistic with `n` observations.
      5 
      6     If provided `NaN` as any argument, the function returns `NaN`.
      7 
      8     If provided a negative value for `x`, the function returns `NaN`.
      9 
     10     If not provided a positive integer for `n`, the function returns `NaN`.
     11 
     12     Parameters
     13     ----------
     14     x: number
     15         Input value.
     16 
     17     n: integer
     18         Number of observations.
     19 
     20     Returns
     21     -------
     22     out: number
     23         Evaluated PDF.
     24 
     25     Examples
     26     --------
     27     > var y = {{alias}}( 3, 7 )
     28     ~0.0156
     29     > y = {{alias}}( 1.8, 3 )
     30     0.0
     31     > y = {{alias}}( -1.0, 40 )
     32     0.0
     33     > y = {{alias}}( NaN, 10 )
     34     NaN
     35     > y = {{alias}}( 0.0, NaN )
     36     NaN
     37 
     38 
     39 {{alias}}.factory( n )
     40     Returns a function for evaluating the probability density function (PDF)
     41     of the distribution of the Wilcoxon signed rank test statistic.
     42 
     43     Parameters
     44     ----------
     45     n: integer
     46         Number of observations.
     47 
     48     Returns
     49     -------
     50     pdf: Function
     51         Probability density function (PDF).
     52 
     53     Examples
     54     --------
     55     > var myPDF = {{alias}}.factory( 8 );
     56     > var y = myPDF( 6.0 )
     57     ~0.0156
     58     > y = myPDF( 2.0 )
     59     ~0.0039
     60 
     61     See Also
     62     --------
     63