time-to-botec

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

repl.txt (497B)

      1 
      2 {{alias}}( x )
      3     Tests if a numeric value is a probability.
      4 
      5     A probability is defined as a numeric value on the closed interval `[0,1]`.
      6 
      7     Parameters
      8     ----------
      9     x: number
     10         Value to test.
     11 
     12     Returns
     13     -------
     14     bool: boolean
     15         Boolean indicating whether the value is a probability.
     16 
     17     Examples
     18     --------
     19     > var bool = {{alias}}( 0.5 )
     20     true
     21     > bool = {{alias}}( 3.14 )
     22     false
     23     > bool = {{alias}}( NaN )
     24     false
     25 
     26     See Also
     27     --------
     28