time-to-botec

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

repl.txt (1677B)


      1 
      2 {{alias}}( x, α, s, m )
      3     Evaluates the logarithm of the probability density function (PDF) for a
      4     Fréchet distribution with shape parameter `α`, scale parameter `s`, and
      5     location `m`.
      6 
      7     If provided `NaN` as any argument, the function returns `NaN`.
      8 
      9     If provided `α <= 0` or `s <= 0`, the function returns `NaN`.
     10 
     11     Parameters
     12     ----------
     13     x: number
     14         Input value.
     15 
     16     α: number
     17         Shape parameter.
     18 
     19     s: number
     20         Scale parameter.
     21 
     22     m: number
     23         Location parameter.
     24 
     25     Returns
     26     -------
     27     out: number
     28         Evaluated logPDF.
     29 
     30     Examples
     31     --------
     32     > var y = {{alias}}( 10.0, 1.0, 3.0, 5.0 )
     33     ~-2.72
     34     > y = {{alias}}( -2.0, 1.0, 3.0, -3.0 )
     35     ~-1.901
     36     > y = {{alias}}( 0.0, 2.0, 1.0, -1.0 )
     37     ~-0.307
     38     > y = {{alias}}( NaN, 0.0, 1.0 )
     39     NaN
     40     > y = {{alias}}( 0.0, NaN, 1.0 )
     41     NaN
     42     > y = {{alias}}( 0.0, 0.0, NaN )
     43     NaN
     44     // Negative scale parameter:
     45     > y = {{alias}}( 0.0, 0.0, -1.0 )
     46     NaN
     47 
     48 
     49 {{alias}}.factory( α, s, m )
     50     Returns a function for evaluating the logarithm of the probability density
     51     function (PDF) of a Fréchet distribution with shape parameter `α`, scale
     52     parameter `s`, and location `m`.
     53 
     54     Parameters
     55     ----------
     56     α: number
     57         Shape parameter.
     58 
     59     s: number
     60         Scale parameter.
     61 
     62     m: number
     63         Location parameter.
     64 
     65     Returns
     66     -------
     67     logpdf: Function
     68         Logarithm of probability density function (PDF).
     69 
     70     Examples
     71     --------
     72     > var mylogPDF = {{alias}}.factory( 2.0, 3.0, 1.0 );
     73     > var y = mylogPDF( 10.0 )
     74     ~-3.812
     75     > y = mylogPDF( 2.0 )
     76     ~-6.11
     77 
     78     See Also
     79     --------
     80