time-to-botec

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

repl.txt (876B)

      1 
      2 {{alias}}( α, s, m )
      3     Returns the expected value of a Fréchet distribution with shape parameter
      4     `α`, scale parameter `s`, and location `m`.
      5 
      6     If provided `0 < α <= 1` and `s > 0`, the function returns positive
      7     infinity.
      8 
      9     If provided `NaN` as any argument, the function returns `NaN`.
     10 
     11     If provided `α <= 0` or `s <= 0`, the function returns `NaN`.
     12 
     13     Parameters
     14     ----------
     15     α: number
     16         Shape parameter.
     17 
     18     s: number
     19         Scale parameter.
     20 
     21     m: number
     22         Location parameter.
     23 
     24     Returns
     25     -------
     26     out: number
     27         Mean.
     28 
     29     Examples
     30     --------
     31     > var y = {{alias}}( 4.0, 2.0, 1.0 )
     32     ~3.451
     33     > y = {{alias}}( 0.5, 2.0, 1.0 )
     34     Infinity
     35     > y = {{alias}}( NaN, 1.0, 0.0 )
     36     NaN
     37     > y = {{alias}}( 1.0, NaN, 0.0 )
     38     NaN
     39     > y = {{alias}}( 1.0, 1.0, NaN )
     40     NaN
     41 
     42     See Also
     43     --------
     44