time-to-botec

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

repl.txt (588B)

      1 
      2 {{alias}}( k, λ )
      3     Returns the mode of a Weibull distribution.
      4 
      5     If `0 < k <= 1`, the function returns `0.0`.
      6 
      7     If `k <= 0` or `λ <= 0`, the function returns `NaN`.
      8 
      9     If `k` or `λ` is `NaN`, the function returns `NaN`.
     10 
     11     Parameters
     12     ----------
     13     k: number
     14         Shape parameter.
     15 
     16     λ: number
     17         Scale parameter.
     18 
     19     Returns
     20     -------
     21     out: number
     22         Mode.
     23 
     24     Examples
     25     --------
     26     > var v = {{alias}}( 1.0, 1.0 )
     27     0.0
     28     > v = {{alias}}( 4.0, 12.0 )
     29     ~11.167
     30     > v = {{alias}}( 8.0, 2.0 )
     31     ~1.967
     32 
     33     See Also
     34     --------
     35