time-to-botec/squiggle/node_modules/@stdlib/math/base/assert/is-integer/README.md

isInteger

Test if a finite double-precision floating-point number is an integer.

Usage

var isInteger = require( '@stdlib/math/base/assert/is-integer' );

isInteger( x )

Tests if a finite double-precision floating-point number is an integer.

var bool = isInteger( 1.0 );
// returns true

Notes

• The function assumes a finite number. If provided positive or negative infinity, the function will return true, when, in fact, the result is undefined. If x can be infinite, wrap the implementation as follows:

  function check( x ) {
      return (
          x < Infinity &&
          x > -Infinity &&
          isInteger( x )
      );
  }
  
  var bool = check( Infinity );
  // returns false
  
  bool = check( -Infinity );
  // returns false
  

Examples

var isInteger = require( '@stdlib/math/base/assert/is-integer' );

var bool = isInteger( -5.0 );
// returns true

bool = isInteger( 3.14 );
// returns false

bool = isInteger( NaN );
// returns false