isNonNegativeNumber

Test if a value is a number having a nonnegative value.

Usage

var isNonNegativeNumber = require( '@stdlib/utils/is-nonnegative-number' );

isNonNegativeNumber( value )

Tests if a value is a number having a nonnegative value.

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

bool = isNonNegativeNumber( new Number( 5.0 ) );
// returns true

bool = isNonNegativeNumber( 3.14 );
// returns true

bool = isNonNegativeNumber( -5.0 );
// returns false

bool = isNonNegativeNumber( null );
// returns false

isNonNegativeNumber.isPrimitive( value )

Tests if a value is a primitive number having a nonnegative value.

var bool = isNonNegativeNumber.isPrimitive( 3.0 );
// returns true

bool = isNonNegativeNumber.isPrimitive( new Number( 3.0 ) );
// returns false

isNonNegativeNumber.isObject( value )

Tests if a value is a Number object having a nonnegative value.

var bool = isNonNegativeNumber.isObject( 3.0 );
// returns false

bool = isNonNegativeNumber.isObject( new Number( 3.0 ) );
// returns true

isNonNegativeNumber.isNonNegativeNumberArray( value )

Tests if a value is a number array having only nonnegative values.

var bool = isNonNegativeNumber.isNonNegativeNumberArray( [ 3.0, new Number(3.0) ] );
// returns true

bool = isNonNegativeNumber.isNonNegativeNumberArray( [ 3.0, '3.0' ] );
// returns false

isNonNegativeNumber.isNonNegativePrimitiveNumberArray( value )

Tests if a value is a primitive number array having only nonnegative values.

var bool = isNonNegativeNumber.isNonNegativePrimitiveNumberArray( [ 1.0, 0.0, 10.0 ] );
// returns true

bool = isNonNegativeNumber.isNonNegativePrimitiveNumberArray( [ 3.0, new Number(1.0) ] );
// returns false

Examples

var isNonNegativeNumber = require( '@stdlib/utils/is-nonnegative-number' );

console.log( isNonNegativeNumber( 5.0 ) );
// returns true

console.log( isNonNegativeNumber( new Number( 5.0 ) ) );
// returns true

console.log( isNonNegativeNumber( 0.0 ) );
// returns true

console.log( isNonNegativeNumber( 3.14 ) );
// returns true

console.log( isNonNegativeNumber( -5.0 ) );
// returns false

console.log( isNonNegativeNumber( '5' ) );
// returns false

console.log( isNonNegativeNumber( null ) );
// returns false