time-to-botec

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

repl.txt (1420B)


      1 
      2 {{alias}}( x, μ, σ )
      3     Evaluates the moment-generating function (MGF) for a normal distribution
      4     with mean `μ` and standard deviation `σ` at a value `t`.
      5 
      6     If provided `NaN` as any argument, the function returns `NaN`.
      7 
      8     If provided `σ <= 0`, the function returns `NaN`.
      9 
     10     Parameters
     11     ----------
     12     x: number
     13         Input value.
     14 
     15     μ: number
     16         Location parameter.
     17 
     18     σ: number
     19         Standard deviation.
     20 
     21     Returns
     22     -------
     23     out: number
     24         Evaluated MGF.
     25 
     26     Examples
     27     --------
     28     > var y = {{alias}}( 2.0, 0.0, 1.0 )
     29     ~7.389
     30     > y = {{alias}}( 0.0, 0.0, 1.0 )
     31     1.0
     32     > y = {{alias}}( -1.0, 4.0, 2.0 )
     33     ~0.1353
     34     > y = {{alias}}( NaN, 0.0, 1.0 )
     35     NaN
     36     > y = {{alias}}( 0.0, NaN, 1.0 )
     37     NaN
     38     > y = {{alias}}( 0.0, 0.0, NaN )
     39     NaN
     40     > y = {{alias}}( 2.0, 0.0, 0.0 )
     41     NaN
     42 
     43 
     44 {{alias}}.factory( μ, σ )
     45     Returns a function for evaluating the moment-generating function (MGF) of a
     46     normal distribution with mean `μ` and standard deviation `σ`.
     47 
     48     Parameters
     49     ----------
     50     μ: number
     51         Location parameter.
     52 
     53     σ: number
     54         Standard deviation.
     55 
     56     Returns
     57     -------
     58     mgf: Function
     59         Moment-generating function (MGF).
     60 
     61     Examples
     62     --------
     63     > var myMGF = {{alias}}.factory( 4.0, 2.0 );
     64     > var y = myMGF( 1.0 )
     65     ~403.429
     66     > y = myMGF( 0.5 )
     67     ~12.182
     68 
     69     See Also
     70     --------
     71