time-to-botec

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

repl.txt (1258B)

      1 
      2 {{alias}}( x, p )
      3     Evaluates the cumulative distribution function (CDF) for a geometric
      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}}( 2.0, 0.5 )
     26     0.875
     27     > y = {{alias}}( 2.0, 0.1 )
     28     ~0.271
     29     > y = {{alias}}( -1.0, 4.0 )
     30     0.0
     31     > y = {{alias}}( NaN, 0.5 )
     32     NaN
     33     > y = {{alias}}( 0.0, NaN )
     34     NaN
     35     // Invalid probability
     36     > y = {{alias}}( 2.0, 1.4 )
     37     NaN
     38 
     39 
     40 {{alias}}.factory( p )
     41     Returns a function for evaluating the cumulative distribution function (CDF)
     42     of a geometric distribution with success probability `p`.
     43 
     44     Parameters
     45     ----------
     46     p: number
     47         Success probability.
     48 
     49     Returns
     50     -------
     51     cdf: Function
     52         Cumulative distribution function (CDF).
     53 
     54     Examples
     55     --------
     56     > var mycdf = {{alias}}.factory( 0.5 );
     57     > var y = mycdf( 3.0 )
     58     0.9375
     59     > y = mycdf( 1.0 )
     60     0.75
     61 
     62     See Also
     63     --------
     64