time-to-botec

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

repl.txt (1294B)

      1 
      2 {{alias}}( x, v )
      3     Evaluates the natural logarithm of the probability density function (PDF)
      4     for a Student's t distribution with degrees of freedom `v` at a value `x`.
      5 
      6     If provided `NaN` as any argument, the function returns `NaN`.
      7 
      8     If provided a non-positive value for `v`, the function returns `NaN`.
      9 
     10     Parameters
     11     ----------
     12     x: number
     13         Input value.
     14 
     15     v: number
     16         Degrees of freedom.
     17 
     18     Returns
     19     -------
     20     out: number
     21         Evaluated logPDF.
     22 
     23     Examples
     24     --------
     25     > var y = {{alias}}( 0.3, 4.0 )
     26     ~-1.036
     27     > y = {{alias}}( 2.0, 0.7 )
     28     ~-2.841
     29     > y = {{alias}}( -1.0, 0.5 )
     30     ~-2.134
     31     > y = {{alias}}( 0.0, NaN )
     32     NaN
     33     > y = {{alias}}( NaN, 2.0 )
     34     NaN
     35     > y = {{alias}}( 2.0, -1.0 )
     36     NaN
     37 
     38 
     39 {{alias}}.factory( v )
     40     Returns a function for evaluating the natural logarithm of the probability
     41     density function (PDF) of a Student's t distribution with degrees of
     42     freedom `v`.
     43 
     44     Parameters
     45     ----------
     46     v: number
     47         Degrees of freedom.
     48 
     49     Returns
     50     -------
     51     logpdf: Function
     52         Logarithm of probability density function (PDF).
     53 
     54     Examples
     55     --------
     56     > var mylogPDF = {{alias}}.factory( 3.0 );
     57     > var y = mylogPDF( 1.0 )
     58     ~-1.576
     59 
     60     See Also
     61     --------
     62