time-to-botec

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

repl.txt (1321B)

      1 
      2 {{alias}}( x, p )
      3     Evaluates the logarithm of the probability mass function (PMF) for a
      4     geometric distribution with success probability `p` at a value `x`.
      5 
      6     If provided `NaN` as any argument, the function returns `NaN`.
      7 
      8     If `p < 0` or `p > 1`, the function returns `NaN`.
      9 
     10     Parameters
     11     ----------
     12     x: number
     13         Input value.
     14 
     15     p: number
     16         Success probability.
     17 
     18     Returns
     19     -------
     20     out: number
     21         Evaluated logPMF.
     22 
     23     Examples
     24     --------
     25     > var y = {{alias}}( 4.0, 0.3 )
     26     ~-2.631
     27     > y = {{alias}}( 2.0, 0.7 )
     28     ~-2.765
     29     > y = {{alias}}( -1.0, 0.5 )
     30     -Infinity
     31     > y = {{alias}}( 0.0, NaN )
     32     NaN
     33     > y = {{alias}}( NaN, 0.5 )
     34     NaN
     35     // Invalid success probability:
     36     > y = {{alias}}( 2.0, 1.5 )
     37     NaN
     38 
     39 
     40 {{alias}}.factory( p )
     41     Returns a function for evaluating the logarithm of the probability mass
     42     function (PMF) of a geometric distribution with success probability `p`.
     43 
     44     Parameters
     45     ----------
     46     p: number
     47         Success probability.
     48 
     49     Returns
     50     -------
     51     logpmf: Function
     52         Logarithm of probability mass function (PMF).
     53 
     54     Examples
     55     --------
     56     > var mylogpmf = {{alias}}.factory( 0.5 );
     57     > var y = mylogpmf( 3.0 )
     58     ~-2.773
     59     > y = mylogpmf( 1.0 )
     60     ~-1.386
     61 
     62     See Also
     63     --------
     64