time-to-botec

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

repl.txt (1541B)


      1 
      2 {{alias}}( x, a, b )
      3     Evaluates the cumulative distribution function (CDF) for a uniform
      4     distribution with minimum support `a` and maximum support `b` at a value
      5     `x`.
      6 
      7     If provided `NaN` as any argument, the function returns `NaN`.
      8 
      9     If provided `a >= b`, the function returns `NaN`.
     10 
     11     Parameters
     12     ----------
     13     x: number
     14         Input value.
     15 
     16     a: number
     17         Minimum support.
     18 
     19     b: number
     20         Maximum support.
     21 
     22     Returns
     23     -------
     24     out: number
     25         Evaluated CDF.
     26 
     27     Examples
     28     --------
     29     > var y = {{alias}}( 9.0, 0.0, 10.0 )
     30     0.9
     31     > y = {{alias}}( 0.5, 0.0, 2.0 )
     32     0.25
     33     > y = {{alias}}( {{alias:@stdlib/constants/float64/pinf}}, 2.0, 4.0 )
     34     1.0
     35     > y = {{alias}}( {{alias:@stdlib/constants/float64/ninf}}, 2.0, 4.0 )
     36     0.0
     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, 1.0, 0.0 )
     44     NaN
     45 
     46 
     47 {{alias}}.factory( a, b )
     48     Returns a function for evaluating the cumulative distribution function (CDF)
     49     of a uniform distribution with minimum support `a` and maximum support `b`.
     50 
     51     Parameters
     52     ----------
     53     a: number
     54         Minimum support.
     55 
     56     b: number
     57         Maximum support.
     58 
     59     Returns
     60     -------
     61     cdf: Function
     62         Cumulative distribution function (CDF).
     63 
     64     Examples
     65     --------
     66     > var mycdf = {{alias}}.factory( 0.0, 10.0 );
     67     > var y = mycdf( 0.5 )
     68     0.05
     69     > y = mycdf( 8.0 )
     70     0.8
     71 
     72     See Also
     73     --------
     74