time-to-botec

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

repl.txt (1257B)

      1 
      2 {{alias}}( x, μ )
      3     Evaluates the natural logarithm of the cumulative distribution function
      4     (logCDF) for a degenerate distribution with mean `μ`.
      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         Natural logarithm of the CDF.
     20 
     21     Examples
     22     --------
     23     > var y = {{alias}}( 2.0, 3.0 )
     24     -Infinity
     25     > y = {{alias}}( 4.0, 3.0 )
     26     0
     27     > y = {{alias}}( 3.0, 3.0 )
     28     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 natural logarithm of the cumulative
     37     distribution function (logCDF) of a degenerate distribution with mean `μ`.
     38 
     39     Parameters
     40     ----------
     41     μ: number
     42         Constant value of distribution.
     43 
     44     Returns
     45     -------
     46     logcdf: Function
     47         Function to evaluate the natural logarithm of cumulative distribution
     48         function (logCDF).
     49 
     50     Examples
     51     --------
     52     > var mylogcdf = {{alias}}.factory( 5.0 );
     53     > var y = mylogcdf( 3.0 )
     54     -Infinity
     55     > y = mylogcdf( 6.0 )
     56     0
     57 
     58     See Also
     59     --------
     60