time-to-botec/squiggle/node_modules/@stdlib/assert/is-nonnegative-number-array/README.md

isNonNegativeNumberArray

Test if a value is an array-like object containing only nonnegative numbers.

Usage

var isNonNegativeNumberArray = require( '@stdlib/assert/is-nonnegative-number-array' );

isNonNegativeNumberArray( value )

Tests if a value is an array-like object containing only nonnegative numbers.

var Number = require( '@stdlib/number/ctor' );

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

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

isNonNegativeNumberArray.primitives( value )

Tests if a value is an array-like object array containing only primitive nonnegative numbers.

var Number = require( '@stdlib/number/ctor' );

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

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

isNonNegativeNumberArray.objects( value )

Tests if a value is an array-like object array containing only object nonnegative numbers.

var Number = require( '@stdlib/number/ctor' );

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

bool = isNonNegativeNumberArray.objects( [ 1.0, 0.0, 10.0 ] );
// returns false

Examples

var Number = require( '@stdlib/number/ctor' );
var isNonNegativeNumberArray = require( '@stdlib/assert/is-nonnegative-number-array' );

var bool = isNonNegativeNumberArray( [ 5.0, 0.2, 3.9 ] );
// returns true

bool = isNonNegativeNumberArray( [ 1, 2, 3 ] );
// returns true

bool = isNonNegativeNumberArray( [ 1, new Number( 6 ), 3 ] );
// returns true

bool = isNonNegativeNumberArray( [ 1, 'abc', 3 ] );
// returns false

bool = isNonNegativeNumberArray( 78.0 );
// returns false