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

C APIs

Usage

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

stdlib_base_is_positive_integer( x )

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

#include <stdbool.h>

bool out = stdlib_base_is_positive_integer( 3.0 );
// returns true

out = stdlib_base_is_positive_integer( -4.0 );
// returns false

The function accepts the following arguments:

x: [in] double input value.

bool stdlib_base_is_positive_integer( const double x );

Examples

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

int main( void ) {
    const double x[] = { 5.0, -5.0, 3.14, -3.14, 0.0, 0.0/0.0 };

    bool b;
    int i;
    for ( i = 0; i < 6; i++ ) {
        b = stdlib_base_is_positive_integer( x[ i ] );
        printf( "Value: %lf. Is positive integer? %s.\n", x[ i ], ( b ) ? "True" : "False" );
    }
}