time-to-botec

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

repl.txt (1485B)


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