time-to-botec

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

repl.txt (1434B)


      1 
      2 {{alias}}( x, λ )
      3     Evaluates the cumulative distribution function (CDF) 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 CDF.
     22 
     23     Examples
     24     --------
     25     > var y = {{alias}}( 2.0, 0.5 )
     26     ~0.986
     27     > y = {{alias}}( 2.0, 10.0 )
     28     ~0.003
     29     > y = {{alias}}( -1.0, 4.0 )
     30     0.0
     31     > y = {{alias}}( NaN, 1.0 )
     32     NaN
     33     > y = {{alias}}( 0.0, NaN )
     34     NaN
     35 
     36     // Negative mean parameter:
     37     > y = {{alias}}( 2.0, -1.0 )
     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     > y = {{alias}}( 10.0, 0.0 )
     46     1.0
     47 
     48 
     49 {{alias}}.factory( λ )
     50     Returns a function for evaluating the cumulative distribution function (CDF)
     51     of a Poisson distribution with mean parameter `λ`.
     52 
     53     Parameters
     54     ----------
     55     λ: number
     56         Mean parameter.
     57 
     58     Returns
     59     -------
     60     cdf: Function
     61         Cumulative distribution function (CDF).
     62 
     63     Examples
     64     --------
     65     > var mycdf = {{alias}}.factory( 5.0 );
     66     > var y = mycdf( 3.0 )
     67     ~0.265
     68     > y = mycdf( 8.0 )
     69     ~0.932
     70 
     71     See Also
     72     --------
     73