time-to-botec

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

repl.txt (1444B)


      1 
      2 {{alias}}( x, μ, b )
      3     Evaluates the probability density function (PDF) for a Laplace
      4     distribution with scale parameter `b` and location parameter `μ` at a
      5     value `x`.
      6 
      7     If provided `NaN` as any argument, the function returns `NaN`.
      8 
      9     If provided `b <= 0`, the function returns `NaN`.
     10 
     11     Parameters
     12     ----------
     13     x: number
     14         Input value.
     15 
     16     μ: number
     17         Location parameter.
     18 
     19     b: number
     20         Scale parameter.
     21 
     22     Returns
     23     -------
     24     out: number
     25         Evaluated PDF.
     26 
     27     Examples
     28     --------
     29     > var y = {{alias}}( 2.0, 0.0, 1.0 )
     30     ~0.068
     31     > y = {{alias}}( -1.0, 2.0, 3.0 )
     32     ~0.061
     33     > y = {{alias}}( 2.5, 2.0, 3.0 )
     34     ~0.141
     35     > y = {{alias}}( NaN, 0.0, 1.0 )
     36     NaN
     37     > y = {{alias}}( 0.0, NaN, 1.0 )
     38     NaN
     39     > y = {{alias}}( 0.0, 0.0, NaN )
     40     NaN
     41     // Negative scale parameter:
     42     > y = {{alias}}( 2.0, 0.0, -1.0 )
     43     NaN
     44 
     45 
     46 {{alias}}.factory( μ, b )
     47     Returns a function for evaluating the probability density function (PDF)
     48     of a Laplace distribution with scale parameter `b` and location parameter
     49     `μ`.
     50 
     51     Parameters
     52     ----------
     53     μ: number
     54         Location parameter.
     55 
     56     b: 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.25
     69 
     70     See Also
     71     --------
     72