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

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

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

---

C APIs

Usage

#include "stdlib/math/base/assert/is_nonnegative_integer.h"

stdlib_base_is_nonnegative_integer( x )

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

bool out = stdlib_base_is_nonnegative_integer( 1.0 );
// returns true

out = stdlib_base_is_nonnegative_integer( -10.0 );
// returns false

The function accepts the following arguments:

• x: [in] double input value.

bool stdlib_base_is_nonnegative_integer( const double x );

Examples

#include "stdlib/math/base/assert/is_nonnegative_integer.h"
#include <stdio.h>
#include <stdlib.h>
#include <stdbool.h>

int main( void ) {
    double x;
    bool v;
    int i;
    
    for ( i = 0; i < 100; i++ ) {
        x = ( ( (double)rand() / (double)RAND_MAX ) * 100.0 ) - 50.0;
        v = stdlib_base_is_nonnegative_integer( x );
        printf( "x = %lf, is_nonnegative_integer(x) = %s\n", x, ( v ) ? "true" : "false" );
    }
}

---

See Also

• @stdlib/math-base/assert/is-integer: test if a finite double-precision floating-point number is an integer.
• @stdlib/math-base/assert/is-negative-integer: test if a finite double-precision floating-point number is a negative integer.
• @stdlib/math-base/assert/is-nonpositive-integer: test if a finite double-precision floating-point number is a nonpositive integer.
• @stdlib/math-base/assert/is-positive-integer: test if a finite double-precision floating-point number is a positive integer.

---

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.

Community

---

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.

Changelog

0.2.1 (2024-07-27)

<section class="features">

Features

• 054472b - add C implementation for math/base/assert/is-nonnegative-integer (#1746)

</section> <!-- /.features --> <section class="issues">

Closed Issues

This release closes the following issue:

#1723

</section> <!-- /.issues --> <section class="commits">

Commits

<details>

• d04dcbd - docs: remove private annotations in C comments (by Philipp Burckhardt)
• d40dbaf - chore: update package meta data (#1812) (by stdlib-bot)
• 054472b - feat: add C implementation for math/base/assert/is-nonnegative-integer (#1746) (by Gunj Joshi, Athan Reines)

</details> </section> <!-- /.commits --> <section class="contributors">

Contributors

A total of 3 people contributed to this release. Thank you to the following contributors:

• Athan Reines
• Gunj Joshi
• Philipp Burckhardt

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