time-to-botec

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

repl.txt (1691B)


      1 
      2 {{alias}}( t, n, p )
      3     Evaluates the moment-generating function (MGF) for a binomial distribution
      4     with number of trials `n` and success probability `p` at a value `t`.
      5 
      6     If provided `NaN` as any argument, the function returns `NaN`.
      7 
      8     If provided a number of trials `n` which is not a nonnegative integer, the
      9     function returns `NaN`.
     10 
     11     If `p < 0` or `p > 1`, the function returns `NaN`.
     12 
     13     Parameters
     14     ----------
     15     t: number
     16         Input value.
     17 
     18     n: integer
     19         Number of trials.
     20 
     21     p: number
     22         Success probability.
     23 
     24     Returns
     25     -------
     26     out: number
     27         Evaluated MGF.
     28 
     29     Examples
     30     --------
     31     > var y = {{alias}}( 0.5, 20, 0.2 )
     32     ~11.471
     33     > y = {{alias}}( 5.0, 20, 0.2 )
     34     ~4.798e+29
     35     > y = {{alias}}( 0.9, 10, 0.4 )
     36     ~99.338
     37     > y = {{alias}}( 0.0, 10, 0.4 )
     38     1.0
     39 
     40     > y = {{alias}}( NaN, 20, 0.5 )
     41     NaN
     42     > y = {{alias}}( 0.0, NaN, 0.5 )
     43     NaN
     44     > y = {{alias}}( 0.0, 20, NaN )
     45     NaN
     46 
     47     > y = {{alias}}( 2.0, 1.5, 0.5 )
     48     NaN
     49     > y = {{alias}}( 2.0, -2.0, 0.5 )
     50     NaN
     51     > y = {{alias}}( 2.0, 20, -1.0 )
     52     NaN
     53     > y = {{alias}}( 2.0, 20, 1.5 )
     54     NaN
     55 
     56 
     57 {{alias}}.factory( n, p )
     58     Returns a function for evaluating the moment-generating function (MGF) of a
     59     binomial distribution with number of trials `n` and success probability `p`.
     60 
     61     Parameters
     62     ----------
     63     n: integer
     64         Number of trials.
     65 
     66     p: number
     67         Success probability.
     68 
     69     Returns
     70     -------
     71     mgf: Function
     72         Moment-generating function (MGF).
     73 
     74     Examples
     75     --------
     76     > var myMGF = {{alias}}.factory( 10, 0.5 );
     77     > var y = myMGF( 0.3 )
     78     ~5.013
     79 
     80     See Also
     81     --------
     82