time-to-botec

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

repl.txt (1257B)

      1 
      2 {{alias}}( x, v )
      3     Evaluates the cumulative distribution function (CDF) for a Student's t
      4     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 CDF.
     22 
     23     Examples
     24     --------
     25     > var y = {{alias}}( 2.0, 0.1 )
     26     ~0.611
     27     > y = {{alias}}( 1.0, 2.0 )
     28     ~0.789
     29     > y = {{alias}}( -1.0, 4.0 )
     30     ~0.187
     31     > y = {{alias}}( NaN, 1.0 )
     32     NaN
     33     > y = {{alias}}( 0.0, NaN )
     34     NaN
     35     > y = {{alias}}( 2.0, -1.0 )
     36     NaN
     37 
     38 
     39 {{alias}}.factory( v )
     40     Returns a function for evaluating the cumulative distribution function (CDF)
     41     of a Student's t distribution with degrees of freedom `v`.
     42 
     43     Parameters
     44     ----------
     45     v: number
     46         Degrees of freedom.
     47 
     48     Returns
     49     -------
     50     cdf: Function
     51         Cumulative distribution function (CDF).
     52 
     53     Examples
     54     --------
     55     > var mycdf = {{alias}}.factory( 0.5 );
     56     > var y = mycdf( 3.0 )
     57     ~0.816
     58     > y = mycdf( 1.0 )
     59     ~0.699
     60 
     61     See Also
     62     --------
     63