@stdlib/math-base-assert-is-nonnegative-integer

isNonNegativeInteger

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

Installation

npm install @stdlib/math-base-assert-is-nonnegative-integer

Usage

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

isNonNegativeInteger( x )

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

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

bool = isNonNegativeInteger( 0.0 );
// returns true

bool = isNonNegativeInteger( -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 &&
          isNonNegativeInteger( x )
      );
  }
  
  var bool = check( Infinity );
  // returns false
  

• The function does not distinguish between positive and negative zero.

  var bool = isNonNegativeInteger( 0.0 );
  // returns true
  
  bool = isNonNegativeInteger( -0.0 );
  // returns true
  

Examples

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

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

bool = isNonNegativeInteger( 0.0 );
// returns true

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

bool = isNonNegativeInteger( 3.14 );
// returns false

bool = isNonNegativeInteger( NaN );
// returns false

---

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

---

License

See LICENSE.

Copyright

Copyright © 2016-2021. The Stdlib Authors.

Changelog

0.0.2 (2021-06-15)

No changes reported for this release.

</section> <!-- /.release --> <section class="release" id="v0.0.1">