time-to-botec

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

repl.txt (1379B)

      1 
      2 {{alias}}( x, x0, Ɣ )
      3     Evaluates the cumulative distribution function (CDF) for a Cauchy
      4     distribution with location parameter `x0` and scale parameter `Ɣ` at a value
      5     `x`.
      6 
      7     If provided `NaN` as any argument, the function returns `NaN`.
      8 
      9     If provided `Ɣ <= 0`, the function returns `NaN`.
     10 
     11     Parameters
     12     ----------
     13     x: number
     14         Input value.
     15 
     16     x0: number
     17         Location parameter.
     18 
     19     Ɣ: number
     20         Scale parameter.
     21 
     22     Returns
     23     -------
     24     out: number
     25         Evaluated CDF.
     26 
     27     Examples
     28     --------
     29     > var y = {{alias}}( 4.0, 0.0, 2.0 )
     30     ~0.852
     31     > y = {{alias}}( 1.0, 0.0, 2.0 )
     32     ~0.648
     33     > y = {{alias}}( 1.0, 3.0, 2.0 )
     34     0.25
     35     > y = {{alias}}( NaN, 0.0, 2.0 )
     36     NaN
     37     > y = {{alias}}( 1.0, 2.0, NaN )
     38     NaN
     39     > y = {{alias}}( 1.0, NaN, 3.0 )
     40     NaN
     41 
     42 
     43 {{alias}}.factory( x0, Ɣ )
     44     Returns a function for evaluating the cumulative distribution function (CDF)
     45     of a Cauchy distribution with location parameter `x0` and scale parameter
     46     `Ɣ`.
     47 
     48     Parameters
     49     ----------
     50     x0: number
     51         Location parameter.
     52 
     53     Ɣ: number
     54         Scale parameter.
     55 
     56     Returns
     57     -------
     58     cdf: Function
     59         Cumulative distribution function (CDF).
     60 
     61     Examples
     62     --------
     63     > var myCDF = {{alias}}.factory( 1.5, 3.0 );
     64     > var y = myCDF( 1.0 )
     65     ~0.447
     66 
     67     See Also
     68     --------
     69