Test if a value is an array-like object where every element is between two values.
var isBetweenArray = require( '@stdlib/assert/is-between-array' );
Tests if a value
is an array-like object
where every element is between two values a
(left comparison value) and b
(right comparison value).
var arr = [ 3, 4, 5 ];
var bool = isBetweenArray( arr, 3, 5 );
// returns true
bool = isBetweenArray( arr, 4, 5 );
// returns false
bool = isBetweenArray( arr, 3, 4 );
// returns false
By default, the function assumes that a
and b
are inclusive.
var arr = [ 3, 4, 5 ];
var bool = isBetweenArray( arr, 3, 5 );
// returns true
bool = isBetweenArray( arr, 3, 5, 'closed', 'closed' );
// returns true
To make a
and/or b
exclusive, set the respective arguments to 'open'
.
var arr = [ 3, 4, 5 ];
var bool = isBetweenArray( arr, 3, 5, 'open', 'closed' );
// returns false
bool = isBetweenArray( arr, 3, 5, 'closed', 'open' );
// returns false
-
If
a
andb
are inclusive, the element-wise comparison is equivalent toa <= v_i <= b
-
If
a
is exclusive andb
is inclusive, the element-wise comparison is equivalent toa < v_i <= b
-
If
a
is inclusive andb
is exclusive, the element-wise comparison is equivalent toa <= v_i < b
-
If
a
andb
are exclusive, the element-wise comparison is equivalent toa < v_i < b
-
If provided an empty array-like
object
, the function returnsfalse
.var bool = isBetweenArray( [], 0.0, 1.0 ); // returns false
-
If provided non-numeric values, element-wise comparisons are performed according to lexicographic order.
var randu = require( '@stdlib/random/base/randu' );
var filledarrayBy = require( '@stdlib/array/filled-by' );
var isBetweenArray = require( '@stdlib/assert/is-between-array' );
// Create an array of random numbers:
var x = filledarrayBy( 100, 'float64', randu );
// Check whether every element resides within the interval [0.01, 0.99]:
var bool = isBetweenArray( x, 0.01, 0.99 );
console.log( bool );
@stdlib/assert/is-between
: test if a value is between two values.