time-to-botec

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

repl.txt (1290B)

      1 
      2 {{alias}}( x, p )
      3     Evaluates the cumulative distribution function (CDF) for a Bernoulli
      4     distribution with success probability `p` at a value `x`.
      5 
      6     If provided `NaN` as any argument, the function returns `NaN`.
      7 
      8     If `p < 0` or `p > 1`, the function returns `NaN`.
      9 
     10     Parameters
     11     ----------
     12     x: number
     13         Input value.
     14 
     15     p: number
     16         Success probability.
     17 
     18     Returns
     19     -------
     20     out: number
     21         Evaluated CDF.
     22 
     23     Examples
     24     --------
     25     > var y = {{alias}}( 0.5, 0.5 )
     26     0.5
     27     > y = {{alias}}( 0.8, 0.1 )
     28     0.9
     29     > y = {{alias}}( -1.0, 0.4 )
     30     0.0
     31     > y = {{alias}}( 1.5, 0.4 )
     32     1.0
     33     > y = {{alias}}( NaN, 0.5 )
     34     NaN
     35     > y = {{alias}}( 0.0, NaN )
     36     NaN
     37     // Invalid probability:
     38     > y = {{alias}}( 2.0, 1.4 )
     39     NaN
     40 
     41 
     42 {{alias}}.factory( p )
     43     Returns a function for evaluating the cumulative distribution function (CDF)
     44     of a Bernoulli distribution with success probability `p`.
     45 
     46     Parameters
     47     ----------
     48     p: number
     49         Success probability.
     50 
     51     Returns
     52     -------
     53     cdf: Function
     54         Cumulative distribution function (CDF).
     55 
     56     Examples
     57     --------
     58     > var mycdf = {{alias}}.factory( 0.5 );
     59     > var y = mycdf( 3.0 )
     60     1.0
     61     > y = mycdf( 0.7 )
     62     0.5
     63 
     64     See Also
     65     --------
     66