Home Original page

stdlib/lib/node_modules/@stdlib/assert/is-finite-array at develop · stdlib-js/stdlib

isFiniteArray

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

Usage

var isFiniteArray = require( '@stdlib/assert/is-finite-array' );

isFiniteArray( value )

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

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

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

bool = isFiniteArray( [ -3.0, 'abc' ] );
// returns false

bool = isFiniteArray( [ -3.0, 1.0/0.0 ] );
// returns false

isFiniteArray.primitives( value )

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

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

var bool = isFiniteArray.primitives( [ -1.0, 0.0, 4.5 ] );
// returns true

bool = isFiniteArray.primitives( [ -1.0, 1.0/0.0 ] );
// returns false

bool = isFiniteArray.primitives( [ -3.0, new Number(2.0) ] );
// returns false

isFiniteArray.objects( value )

Tests if a value is an array-like object containing only Number objects having finite values.

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

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

bool = isFiniteArray.objects( [ -1.0, 0.0, 1.0 ] );
// returns false

bool = isFiniteArray.objects( [ -3.0, new Number(1.0) ] );
// returns false

Examples

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

var bool = isFiniteArray( [ -5.0, 0.0, 2.0, 5.0 ] );
// returns true

bool = isFiniteArray( [ -4.0, -3.14, 1.0, 3.14 ] );
// returns true

bool = isFiniteArray( [ -1.0, new Number( -6.0 ), 2.0 ] );
// returns true

bool = isFiniteArray( [ -1.0, 'abc', 3.0 ] );
// returns false

bool = isFiniteArray( [ -2.3, 1.0/0.0, 3.0 ] );
// returns false

bool = isFiniteArray( [] );
// returns false

See Also