time-to-botec

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

repl.txt (630B)

      1 
      2 {{alias}}( k, λ )
      3     Returns the mode of an Erlang distribution.
      4 
      5     If provided `NaN` as any argument, the function returns `NaN`.
      6 
      7     If not provided a positive integer for `k`, the function returns `NaN`.
      8 
      9     If provided a non-positive value for `λ`, the function returns `NaN`.
     10 
     11     Parameters
     12     ----------
     13     k: integer
     14         Shape parameter.
     15 
     16     λ: number
     17         Rate parameter.
     18 
     19     Returns
     20     -------
     21     out: number
     22         Mode.
     23 
     24     Examples
     25     --------
     26     > var v = {{alias}}( 1, 1.0 )
     27     0.0
     28     > v = {{alias}}( 4, 12.0 )
     29     0.25
     30     > v = {{alias}}( 8, 2.0 )
     31     3.5
     32 
     33     See Also
     34     --------
     35