time-to-botec

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

repl.txt (1654B)

      1 
      2 {{alias}}( x, α, β )
      3     Evaluates the cumulative distribution function (CDF) for a beta prime
      4     distribution with first shape parameter `α` and second shape parameter `β`
      5     at a value `x`.
      6 
      7     If provided `NaN` as any argument, the function returns `NaN`.
      8 
      9     If `α <= 0` or `β <= 0`, the function returns `NaN`.
     10 
     11     Parameters
     12     ----------
     13     x: number
     14         Input value.
     15 
     16     α: number
     17         First shape parameter.
     18 
     19     β: number
     20         Second shape parameter.
     21 
     22     Returns
     23     -------
     24     out: number
     25         Evaluated CDF.
     26 
     27     Examples
     28     --------
     29     > var y = {{alias}}( 0.5, 1.0, 1.0 )
     30     ~0.333
     31     > y = {{alias}}( 0.5, 2.0, 4.0 )
     32     ~0.539
     33     > y = {{alias}}( 0.2, 2.0, 2.0 )
     34     ~0.074
     35     > y = {{alias}}( 0.8, 4.0, 4.0 )
     36     ~0.38
     37     > y = {{alias}}( -0.5, 4.0, 2.0 )
     38     0.0
     39 
     40     > y = {{alias}}( 2.0, -1.0, 0.5 )
     41     NaN
     42     > y = {{alias}}( 2.0, 0.5, -1.0 )
     43     NaN
     44 
     45     > y = {{alias}}( NaN, 1.0, 1.0 )
     46     NaN
     47     > y = {{alias}}( 0.0, NaN, 1.0 )
     48     NaN
     49     > y = {{alias}}( 0.0, 1.0, NaN )
     50     NaN
     51 
     52 
     53 {{alias}}.factory( α, β )
     54     Returns a function for evaluating the cumulative distribution function (CDF)
     55     of a beta prime distribution with first shape parameter `α` and second shape
     56     parameter `β`.
     57 
     58     Parameters
     59     ----------
     60     α: number
     61         First shape parameter.
     62 
     63     β: number
     64         Second shape parameter.
     65 
     66     Returns
     67     -------
     68     cdf: Function
     69         Cumulative distribution function (CDF).
     70 
     71     Examples
     72     --------
     73     > var mycdf = {{alias}}.factory( 0.5, 0.5 );
     74     > var y = mycdf( 0.8 )
     75     ~0.465
     76     > y = mycdf( 0.3 )
     77     ~0.319
     78 
     79     See Also
     80     --------
     81