time-to-botec

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

repl.txt (1021B)

      1 
      2 {{alias}}( x, μ )
      3     Evaluates the probability mass function (PMF) for a degenerate distribution
      4     with mean `μ`.
      5 
      6     If provided `NaN` for any argument, the function returns `NaN`.
      7 
      8     Parameters
      9     ----------
     10     x: number
     11         Input value.
     12 
     13     μ: number
     14         Constant value of distribution.
     15 
     16     Returns
     17     -------
     18     out: number
     19         Evaluated PMF.
     20 
     21     Examples
     22     --------
     23     > var y = {{alias}}( 2.0, 3.0 )
     24     0.0
     25     > y = {{alias}}( 3.0, 3.0 )
     26     1.0
     27     > y = {{alias}}( NaN, 0.0 )
     28     NaN
     29     > y = {{alias}}( 0.0, NaN )
     30     NaN
     31 
     32 
     33 {{alias}}.factory( μ )
     34     Returns a function for evaluating the probability mass function (PMF) of a
     35     degenerate distribution with mean `μ`.
     36 
     37     Parameters
     38     ----------
     39     μ: number
     40         Constant value of distribution.
     41 
     42     Returns
     43     -------
     44     pmf: Function
     45         Probability mass function (PMF).
     46 
     47     Examples
     48     --------
     49     > var myPMF = {{alias}}.factory( 10.0 );
     50     > var y = myPMF( 10.0 )
     51     1.0
     52 
     53     See Also
     54     --------
     55