time-to-botec

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

repl.txt (1214B)

      1 
      2 {{alias}}( t, λ )
      3     Evaluates the moment-generating function (MGF) for an exponential
      4     distribution with rate parameter `λ` at a value `t`.
      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     t: number
     13         Input value.
     14 
     15     λ: number
     16         Rate parameter.
     17 
     18     Returns
     19     -------
     20     out: number
     21         Evaluated MGF.
     22 
     23     Examples
     24     --------
     25     > var v = {{alias}}( 2.0, 3.0 )
     26     3.0
     27     > v = {{alias}}( 0.4, 1.2 )
     28     1.5
     29     > v = {{alias}}( 0.8, 1.6 )
     30     2.0
     31     > v = {{alias}}( 4.0, 3.0 )
     32     NaN
     33     > v = {{alias}}( NaN, 3.0 )
     34     NaN
     35     > v = {{alias}}( 2.0, NaN )
     36     NaN
     37 
     38 
     39 {{alias}}.factory( λ )
     40     Returns a function for evaluating the moment-generating function (MGF) for
     41     an exponential distribution with rate parameter `λ`.
     42 
     43     Parameters
     44     ----------
     45     λ: number
     46         Rate parameter.
     47 
     48     Returns
     49     -------
     50     mg: Function
     51         Moment-generating function (MGF).
     52 
     53     Examples
     54     --------
     55     > var myMGF = {{alias}}.factory( 4.0 );
     56     > var y = myMGF( 3.0 )
     57     4.0
     58     > y = myMGF( 0.5 )
     59     ~1.143
     60 
     61     See Also
     62     --------
     63