time-to-botec

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

repl.txt (1334B)

      1 
      2 {{alias}}( x, λ )
      3     Evaluates the natural logarithm of the cumulative distribution function
      4     (CDF) for an exponential distribution with rate parameter `λ` at a value
      5     `x`.
      6 
      7     If provided `NaN` as any argument, the function returns `NaN`.
      8 
      9     If provided a negative value for `λ`, the function returns `NaN`.
     10 
     11     Parameters
     12     ----------
     13     x: number
     14         Input value.
     15 
     16     λ: number
     17         Rate parameter.
     18 
     19     Returns
     20     -------
     21     out: number
     22         Evaluated logCDF.
     23 
     24     Examples
     25     --------
     26     > var y = {{alias}}( 2.0, 0.1 )
     27     ~-1.708
     28     > y = {{alias}}( 1.0, 2.0 )
     29     ~-0.145
     30     > y = {{alias}}( -1.0, 4.0 )
     31     -Infinity
     32     > y = {{alias}}( NaN, 1.0 )
     33     NaN
     34     > y = {{alias}}( 0.0, NaN )
     35     NaN
     36 
     37     // Negative rate parameter:
     38     > y = {{alias}}( 2.0, -1.0 )
     39     NaN
     40 
     41 {{alias}}.factory( λ )
     42     Returns a function for evaluating the natural logarithm of the cumulative
     43     distribution function (CDF) for an exponential distribution with rate
     44     parameter `λ`.
     45 
     46     Parameters
     47     ----------
     48     λ: number
     49         Rate parameter.
     50 
     51     Returns
     52     -------
     53     logcdf: Function
     54         Logarithm of cumulative distribution function (CDF).
     55 
     56     Examples
     57     --------
     58     > var mylogCDF = {{alias}}.factory( 0.5 );
     59     > var y = mylogCDF( 3.0 )
     60     ~-0.252
     61 
     62     See Also
     63     --------
     64