time-to-botec

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

repl.txt (1389B)

      1 
      2 {{alias}}( x, μ, s )
      3     Evaluates the logarithm of the cumulative distribution function (CDF) for a
      4     logistic distribution with location parameter `μ` and scale parameter `s` at
      5     a value `x`.
      6 
      7     If provided `NaN` as any argument, the function returns `NaN`.
      8 
      9     If provided `s < 0`, the function returns `NaN`.
     10 
     11     Parameters
     12     ----------
     13     x: number
     14         Input value.
     15 
     16     μ: number
     17         Location parameter.
     18 
     19     s: number
     20         Scale parameter.
     21 
     22     Returns
     23     -------
     24     out: number
     25         Evaluated logCDF.
     26 
     27     Examples
     28     --------
     29     > var y = {{alias}}( 2.0, 0.0, 1.0 )
     30     ~-0.127
     31     > y = {{alias}}( 5.0, 10.0, 3.0 )
     32     ~-1.84
     33     > y = {{alias}}( 2.0, 0.0, NaN )
     34     NaN
     35     > y = {{alias}}( 2, NaN, 1.0 )
     36     NaN
     37     > y = {{alias}}( NaN, 0.0, 1.0 )
     38     NaN
     39 
     40 
     41 {{alias}}.factory( μ, s )
     42     Returns a function for evaluating the logarithm of the cumulative
     43     distribution function (CDF) of a Logistic distribution with location
     44     parameter `μ` and scale parameter `s`.
     45 
     46     Parameters
     47     ----------
     48     μ: number
     49         Location parameter.
     50 
     51     s: number
     52         Scale parameter.
     53 
     54     Returns
     55     -------
     56     logcdf: Function
     57         Logarithm of cumulative distribution function (CDF).
     58 
     59     Examples
     60     --------
     61     > var mylogcdf = {{alias}}.factory( 3.0, 1.5 );
     62     > var y = mylogcdf( 1.0 )
     63     ~-1.567
     64 
     65     See Also
     66     --------
     67