isNonPositiveFinite

Test if a numeric value is a nonpositive finite number.

Usage

var isNonPositiveFinite = require( '@stdlib/math/base/assert/is-nonpositive-finite' );

isNonPositiveFinite( x )

Tests if a numeric value is a nonpositive finite number.

var bool = isNonPositiveFinite( -3.14 );
// returns true

bool = isNonPositiveFinite( 2.0 );
// returns false

Examples

var isNonPositiveFinite = require( '@stdlib/math/base/assert/is-nonpositive-finite' );

var bool = isNonPositiveFinite( -3.14 );
// returns true

bool = isNonPositiveFinite( 0.0 );
// returns true

bool = isNonPositiveFinite( 2.0 );
// returns false

bool = isNonPositiveFinite( Infinity );
// returns false

bool = isNonPositiveFinite( NaN );
// returns false

C APIs

Usage

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

stdlib_base_is_nonpositive_finite( x )

Tests if a numeric value is a nonpositive finite number.

#include <stdbool.h>

bool out = stdlib_base_is_nonpositive_finite( -3.14 );
// returns true

out = stdlib_base_is_nonpositive_finite( 2.0 );
// returns false

The function accepts the following arguments:

  • x: [in] double input value.
bool stdlib_base_is_nonpositive_finite( const double x );

Examples

#include "stdlib/math/base/assert/is_nonpositive_finite.h"
#include <stdbool.h>
#include <stdio.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_nonpositive_finite( x[ i ] );
        printf( "Value: %lf. Is NonPositive Finite? %s.\n", x[ i ], ( b ) ? "True" : "False" );
    }
}
Did you find this page helpful?