isNonNegativeInteger

Test if a finite double-precision floating-point number is a 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.

#include <stdbool.h>

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" );
    }
}