time-to-botec

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

repl.txt (1624B)


      1 
      2 {{alias}}( x, k, λ )
      3     Evaluates the logarithm of the cumulative distribution function (CDF) for a
      4     Weibull distribution with shape parameter `k` and scale parameter `λ` at a
      5     value `x`.
      6 
      7     If provided `NaN` as any argument, the function returns `NaN`.
      8 
      9     If provided a nonpositive value for `λ` or `k`, the function returns `NaN`.
     10 
     11     Parameters
     12     ----------
     13     x: number
     14         Input value.
     15 
     16     k: number
     17         Shape parameter.
     18 
     19     λ: number
     20         Scale parameter.
     21 
     22     Returns
     23     -------
     24     out: number
     25         Evaluated logCDF.
     26 
     27     Examples
     28     --------
     29     > var y = {{alias}}( 2.0, 1.0, 1.0 )
     30     ~-0.145
     31     > y = {{alias}}( -1.0, 2.0, 2.0 )
     32     -Infinity
     33     > y = {{alias}}( {{alias:@stdlib/constants/float64/pinf}}, 4.0, 2.0 )
     34     0.0
     35     > y = {{alias}}( {{alias:@stdlib/constants/float64/ninf}}, 4.0, 2.0 )
     36     -Infinity
     37     > y = {{alias}}( NaN, 0.0, 1.0 )
     38     NaN
     39     > y = {{alias}}( 0.0, NaN, 1.0 )
     40     NaN
     41     > y = {{alias}}( 0.0, 0.0, NaN )
     42     NaN
     43     > y = {{alias}}( 2.0, 0.0, -1.0 )
     44     NaN
     45 
     46 
     47 {{alias}}.factory( k, λ)
     48     Returns a function for evaluating the logarithm of the cumulative
     49     distribution function (CDF) of a Weibull distribution with scale parameter
     50     `λ` and shape parameter `k`.
     51 
     52     Parameters
     53     ----------
     54     k: number
     55         Shape parameter.
     56 
     57     λ: number
     58         Scale parameter.
     59 
     60     Returns
     61     -------
     62     logcdf: Function
     63         Logarithm of cumulative distribution function (CDF).
     64 
     65     Examples
     66     --------
     67     > var mylogcdf = {{alias}}.factory( 2.0, 10.0 );
     68     > var y = mylogcdf( 12.0 )
     69     ~-0.27
     70 
     71     See Also
     72     --------
     73