time-to-botec

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

repl.txt (1404B)


      1 
      2 {{alias}}( x, a, b )
      3     Evaluates the probability density function (PDF) for a uniform distribution
      4     with minimum support `a` and maximum support `b` at a value `x`.
      5 
      6     If provided `NaN` as any argument, the function returns `NaN`.
      7 
      8     If provided `a >= b`, the function returns `NaN`.
      9 
     10     Parameters
     11     ----------
     12     x: number
     13         Input value.
     14 
     15     a: number
     16         Minimum support.
     17 
     18     b: number
     19         Maximum support.
     20 
     21     Returns
     22     -------
     23     out: number
     24         Evaluated PDF.
     25 
     26     Examples
     27     --------
     28     > var y = {{alias}}( 2.0, 0.0, 4.0 )
     29     0.25
     30     > y = {{alias}}( 5.0, 0.0, 4.0 )
     31     0.0
     32     > y = {{alias}}( 0.25, 0.0, 1.0 )
     33     1.0
     34     > y = {{alias}}( NaN, 0.0, 1.0 )
     35     NaN
     36     > y = {{alias}}( 0.0, NaN, 1.0 )
     37     NaN
     38     > y = {{alias}}( 0.0, 0.0, NaN )
     39     NaN
     40     > y = {{alias}}( 2.0, 3.0, 1.0 )
     41     NaN
     42 
     43 
     44 {{alias}}.factory( a, b )
     45     Returns a function for evaluating the probability density function (PDF) of
     46     a uniform distribution with minimum support `a` and maximum support `b`.
     47 
     48     Parameters
     49     ----------
     50     a: number
     51         Minimum support.
     52 
     53     b: number
     54         Maximum support.
     55 
     56     Returns
     57     -------
     58     pdf: Function
     59         Probability density function (PDF).
     60 
     61     Examples
     62     --------
     63     > var myPDF = {{alias}}.factory( 6.0, 7.0 );
     64     > var y = myPDF( 7.0 )
     65     1.0
     66     > y = myPDF( 5.0 )
     67     0.0
     68 
     69     See Also
     70     --------
     71