time-to-botec

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

repl.txt (694B)


      1 
      2 {{alias}}( x )
      3     Tests if a finite double-precision floating-point number is a nonpositive
      4     integer.
      5 
      6     The function assumes a finite number. If provided negative infinity, the
      7     function will return `true`, when, in fact, the result is undefined.
      8 
      9     The function does not distinguish between positive and negative zero.
     10 
     11     Parameters
     12     ----------
     13     x: number
     14         Value to test.
     15 
     16     Returns
     17     -------
     18     bool: boolean
     19         Boolean indicating whether the value is a nonpositive integer.
     20 
     21     Examples
     22     --------
     23     > var bool = {{alias}}( -1.0 )
     24     true
     25     > bool = {{alias}}( 0.0 )
     26     true
     27     > bool = {{alias}}( 10.0 )
     28     false
     29 
     30     See Also
     31     --------
     32