time-to-botec

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

repl.txt (1338B)

      1 
      2 {{alias}}( p, v )
      3     Evaluates the quantile function for a Student's t distribution with degrees
      4     of freedom `v` at a probability `p`.
      5 
      6     If `p < 0` or `p > 1`, the function returns `NaN`.
      7 
      8     If provided `NaN` as any argument, the function returns `NaN`.
      9 
     10     If provided a non-positive value for `v`, the function returns `NaN`.
     11 
     12     Parameters
     13     ----------
     14     p: number
     15         Input probability.
     16 
     17     v: number
     18         Degrees of freedom.
     19 
     20     Returns
     21     -------
     22     out: number
     23         Evaluated quantile function.
     24 
     25     Examples
     26     --------
     27     > var y = {{alias}}( 0.8, 1.0 )
     28     ~1.376
     29     > y = {{alias}}( 0.1, 1.0 )
     30     ~-3.078
     31     > y = {{alias}}( 0.5, 0.1 )
     32     0.0
     33 
     34     > y = {{alias}}( -0.2, 0.1 )
     35     NaN
     36 
     37     > y = {{alias}}( NaN, 1.0 )
     38     NaN
     39     > y = {{alias}}( 0.0, NaN )
     40     NaN
     41 
     42     > y = {{alias}}( 0.5, -1.0 )
     43     NaN
     44 
     45 
     46 {{alias}}.factory( v )
     47     Returns a function for evaluating the quantile function of a Student's t
     48     distribution with degrees of freedom `v`.
     49 
     50     Parameters
     51     ----------
     52     v: number
     53         Degrees of freedom.
     54 
     55     Returns
     56     -------
     57     quantile: Function
     58         Quantile function.
     59 
     60     Examples
     61     --------
     62     > var myQuantile = {{alias}}.factory( 4.0 );
     63     > var y = myQuantile( 0.2 )
     64     ~-0.941
     65     > y = myQuantile( 0.9 )
     66     ~1.533
     67 
     68     See Also
     69     --------
     70