time-to-botec

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

repl.txt (1370B)

      1 
      2 {{alias}}( x, λ )
      3     Evaluates the probability mass function (PMF) for a Poisson
      4     distribution with mean parameter `λ` at a value `x`.
      5 
      6     If provided `NaN` as any argument, the function returns `NaN`.
      7 
      8     If provided a negative value for `λ`, the function returns `NaN`.
      9 
     10     Parameters
     11     ----------
     12     x: number
     13         Input value.
     14 
     15     λ: number
     16         Mean parameter.
     17 
     18     Returns
     19     -------
     20     out: number
     21         Evaluated PMF.
     22 
     23     Examples
     24     --------
     25     > var y = {{alias}}( 4.0, 3.0 )
     26     ~0.168
     27     > y = {{alias}}( 1.0, 3.0 )
     28     ~0.149
     29     > y = {{alias}}( -1.0, 2.0 )
     30     0.0
     31     > y = {{alias}}( 0.0, NaN )
     32     NaN
     33     > y = {{alias}}( NaN, 0.5 )
     34     NaN
     35 
     36     // Negative mean parameter:
     37     > y = {{alias}}( 2.0, -0.5 )
     38     NaN
     39 
     40     // Degenerate distribution at `λ = 0`:
     41     > y = {{alias}}( 2.0, 0.0 )
     42     0.0
     43     > y = {{alias}}( 0.0, 0.0 )
     44     1.0
     45 
     46 
     47 {{alias}}.factory( λ )
     48     Returns a function for evaluating the probability mass function (PMF)
     49     of a Poisson distribution with mean parameter `λ`.
     50 
     51     Parameters
     52     ----------
     53     λ: number
     54         Mean parameter.
     55 
     56     Returns
     57     -------
     58     pmf: Function
     59         Probability mass function (PMF).
     60 
     61     Examples
     62     --------
     63     > var mypmf = {{alias}}.factory( 1.0 );
     64     > var y = mypmf( 3.0 )
     65     ~0.061
     66     > y = mypmf( 1.0 )
     67     ~0.368
     68 
     69     See Also
     70     --------
     71