time-to-botec/squiggle/node_modules/@stdlib/math/base/assert/is-positive-integer

isPositiveInteger

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

Usage

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

isPositiveInteger( x )

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

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

bool = isPositiveInteger( 0.0 );
// returns false

bool = isPositiveInteger( -10.0 );
// returns false

Notes

• The function assumes a finite number. If provided positive 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 &&
          isPositiveInteger( x )
      );
  }
  
  var bool = check( Infinity );
  // returns false
  

Examples

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

var bool = isPositiveInteger( 5.0 );
// returns true

bool = isPositiveInteger( 0.0 );
// returns false

bool = isPositiveInteger( -1.0 );
// returns false

bool = isPositiveInteger( 3.14 );
// returns false

bool = isPositiveInteger( NaN );
// returns false