time-to-botec

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

repl.txt (1248B)

      1 
      2 {{alias}}( t, sigma )
      3     Evaluates the moment-generating function (MGF) for a Rayleigh distribution
      4     with scale parameter `sigma` at a value `t`.
      5 
      6     If provided `NaN` as any argument, the function returns `NaN`.
      7 
      8     If provided a negative value for `sigma`, the function returns `NaN`.
      9 
     10     Parameters
     11     ----------
     12     t: number
     13         Input value.
     14 
     15     sigma: number
     16         Scale parameter.
     17 
     18     Returns
     19     -------
     20     out: number
     21         Evaluated MGF.
     22 
     23     Examples
     24     --------
     25     > var y = {{alias}}( 1.0, 3.0 )
     26     ~678.508
     27     > y = {{alias}}( 1.0, 2.0 )
     28     ~38.65
     29     > y = {{alias}}( -1.0, 4.0 )
     30     ~-0.947
     31     > y = {{alias}}( NaN, 1.0 )
     32     NaN
     33     > y = {{alias}}( 0.0, NaN )
     34     NaN
     35     > y = {{alias}}( 0.5, -1.0 )
     36     NaN
     37 
     38 
     39 {{alias}}.factory( sigma )
     40     Returns a function for evaluating the moment-generating function (MGF) of a
     41     Rayleigh distribution with scale parameter `sigma`.
     42 
     43     Parameters
     44     ----------
     45     sigma: number
     46         Scale parameter.
     47 
     48     Returns
     49     -------
     50     mgf: Function
     51         Moment-generating function (MGF).
     52 
     53     Examples
     54     --------
     55     > var myMGF = {{alias}}.factory( 0.5 );
     56     > var y = myMGF( 1.0 )
     57     ~2.715
     58     > y = myMGF( 0.5 )
     59     ~1.888
     60 
     61     See Also
     62     --------
     63