time-to-botec

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

repl.txt (1348B)

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