time-to-botec

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

repl.txt (1136B)

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