time-to-botec

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

repl.txt (545B)

      1 
      2 {{alias}}( x0, Ɣ )
      3     Returns the mode of a Cauchy distribution.
      4 
      5     If provided `NaN` as any argument, the function returns `NaN`.
      6 
      7     If provided `Ɣ <= 0`, the function returns `NaN`.
      8 
      9     Parameters
     10     ----------
     11     x0: number
     12         Location parameter.
     13 
     14     Ɣ: number
     15         Scale parameter.
     16 
     17     Returns
     18     -------
     19     out: number
     20         Mode.
     21 
     22     Examples
     23     --------
     24     > var v = {{alias}}( 10.0, 5.0 )
     25     10.0
     26     > v = {{alias}}( 7.0, 0.5 )
     27     7.0
     28     > v = {{alias}}( 10.3, -0.5 )
     29     NaN
     30 
     31     See Also
     32     --------
     33