time-to-botec

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

repl.txt (551B)

      1 
      2 {{alias}}( α, β )
      3     Returns the mode of a beta distribution.
      4 
      5     If `α <= 1` or `β <= 1`, the function returns `NaN`.
      6 
      7     If `α` or `β` is `NaN`, the function returns `NaN`.
      8 
      9     Parameters
     10     ----------
     11     α: number
     12         First shape parameter.
     13 
     14     β: number
     15         Second shape parameter.
     16 
     17     Returns
     18     -------
     19     out: number
     20         Mode.
     21 
     22     Examples
     23     --------
     24     > var v = {{alias}}( 4.0, 12.0 )
     25     ~0.214
     26     > v = {{alias}}( 8.0, 2.0 )
     27     ~0.875
     28     > v = {{alias}}( 1.0, 1.0 )
     29     NaN
     30 
     31     See Also
     32     --------
     33