time-to-botec

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

repl.txt (1627B)


      1 
      2 {{alias}}( x, a, b[, regularized[, upper]] )
      3     Computes the regularized incomplete beta function.
      4 
      5     The `regularized` and `upper` parameters specify whether to evaluate the
      6     non-regularized and/or upper incomplete beta functions, respectively.
      7 
      8     If provided `x < 0` or `x > 1`, the function returns `NaN`.
      9 
     10     If provided `a < 0` or `b < 0`, the function returns `NaN`.
     11 
     12     If provided `NaN` as any argument, the function returns `NaN`.
     13 
     14     Parameters
     15     ----------
     16     x: number
     17         First function parameter.
     18 
     19     a: number
     20         Second function parameter.
     21 
     22     b: number
     23         Third function parameter.
     24 
     25     regularized: boolean (optional)
     26         Boolean indicating whether the function should evaluate the regularized
     27         or non-regularized incomplete beta function. Default: `true`.
     28 
     29     upper: boolean (optional)
     30         Boolean indicating whether the function should return the upper tail of
     31         the incomplete beta function. Default: `false`.
     32 
     33     Returns
     34     -------
     35     y: number
     36         Function value.
     37 
     38     Examples
     39     --------
     40     > var y = {{alias}}( 0.5, 2.0, 2.0 )
     41     0.5
     42     > y = {{alias}}( 0.5, 2.0, 2.0, false )
     43     ~0.083
     44     > y = {{alias}}( 0.2, 1.0, 2.0 )
     45     0.36
     46     > y = {{alias}}( 0.2, 1.0, 2.0, true, true )
     47     0.64
     48     > y = {{alias}}( NaN, 1.0, 1.0 )
     49     NaN
     50     > y = {{alias}}( 0.8, NaN, 1.0 )
     51     NaN
     52     > y = {{alias}}( 0.8, 1.0, NaN )
     53     NaN
     54     > y = {{alias}}( 1.5, 1.0, 1.0 )
     55     NaN
     56     > y = {{alias}}( -0.5, 1.0, 1.0 )
     57     NaN
     58     > y = {{alias}}( 0.5, -2.0, 2.0 )
     59     NaN
     60     > y = {{alias}}( 0.5, 2.0, -2.0 )
     61     NaN
     62 
     63     See Also
     64     --------
     65