isNonNegativeFinite

Test if a numeric value is a nonnegative finite number.

Installation

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

Usage

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

isNonNegativeFinite( x )

Tests if a numeric value is a nonnegative finite number.

var bool = isNonNegativeFinite( 3.14 );
// returns true

bool = isNonNegativeFinite( -2.0 );
// returns false

Examples

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

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

bool = isNonNegativeFinite( 3.14 );
// returns true

bool = isNonNegativeFinite( 0.0 );
// returns true

bool = isNonNegativeFinite( -2.0 );
// returns false

bool = isNonNegativeFinite( Infinity );
// returns false

bool = isNonNegativeFinite( NaN );
// returns false

C APIs

Usage

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

stdlib_base_is_nonnegative_finite( x )

Tests if a numeric value is a nonnegative finite number.

#include <stdbool.h>

bool out = stdlib_base_is_nonnegative_finite( 3.14 );
// returns true

out = stdlib_base_is_nonnegative_finite( -2.0 );
// returns false

The function accepts the following arguments:

• x: [in] double input value.

bool stdlib_base_is_nonnegative_finite( const double x );

Examples

#include "stdlib/math/base/assert/is_nonnegative_finite.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_nonnegative_finite( x[ i ] );
        printf( "Value: %lf. Is nonnegative finite? %s.\n", x[ i ], ( b ) ? "True" : "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.

Community

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.