time-to-botec

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

repl.txt (1586B)

      1 
      2 {{alias}}( x, α, s, m )
      3     Evaluates the probability density function (PDF) for a Fréchet distribution
      4     with shape parameter `α`, scale parameter `s`, and location `m`.
      5 
      6     If provided `NaN` as any argument, the function returns `NaN`.
      7 
      8     If provided `α <= 0` or `s <= 0`, the function returns `NaN`.
      9 
     10     Parameters
     11     ----------
     12     x: number
     13         Input value.
     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         Evaluated PDF.
     28 
     29     Examples
     30     --------
     31     > var y = {{alias}}( 10.0, 0.0, 3.0 )
     32     ~0.965
     33     > y = {{alias}}( -2.0, 0.0, 3.0 )
     34     ~0.143
     35     > y = {{alias}}( 0.0, 0.0, 1.0 )
     36     ~0.368
     37     > y = {{alias}}( NaN, 0.0, 1.0 )
     38     NaN
     39     > y = {{alias}}( 0.0, NaN, 1.0 )
     40     NaN
     41     > y = {{alias}}( 0.0, 0.0, NaN )
     42     NaN
     43     // Negative scale parameter:
     44     > y = {{alias}}( 0.0, 0.0, -1.0 )
     45     NaN
     46 
     47 
     48 {{alias}}.factory( α, s, m )
     49     Returns a function for evaluating the probability density function (PDF) of
     50     a Fréchet distribution with shape parameter `α`, scale parameter `s`, and
     51     location `m`.
     52 
     53     Parameters
     54     ----------
     55     α: number
     56         Shape parameter.
     57 
     58     s: number
     59         Scale parameter.
     60 
     61     m: number
     62         Location parameter.
     63 
     64     Returns
     65     -------
     66     pdf: Function
     67         Probability density function (PDF).
     68 
     69     Examples
     70     --------
     71     > var myPDF = {{alias}}.factory( 2.0, 3.0 );
     72     > var y = myPDF( 10.0 )
     73     ~0.933
     74     > y = myPDF( 2.0 )
     75     ~0.368
     76 
     77     See Also
     78     --------
     79