Skip to content

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

License

Notifications You must be signed in to change notification settings

stdlib-js/assert-is-finite-array

isFiniteArray

NPM version Build Status Coverage Status

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

Installation

npm install @stdlib/assert-is-finite-array

Alternatively,

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

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


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

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2022. The Stdlib Authors.