About stdlib...
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, wellwritten, studied, documented, tested, measured, and highquality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
isBetweenArray
Test if a value is an arraylike object where every element is between two values.
Installation
npm install @stdlib/assertisbetweenarray
Usage
var isBetweenArray = require( '@stdlib/assertisbetweenarray' );
isBetweenArray( value, a, b[, left, right] )
Tests if a value
is an arraylike 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
Notes

If
a
andb
are inclusive, the elementwise comparison is equivalent toa <= v_i <= b

If
a
is exclusive andb
is inclusive, the elementwise comparison is equivalent toa < v_i <= b

If
a
is inclusive andb
is exclusive, the elementwise comparison is equivalent toa <= v_i < b

If
a
andb
are exclusive, the elementwise comparison is equivalent toa < v_i < b

If provided an empty arraylike
object
, the function returnsfalse
.var bool = isBetweenArray( [], 0.0, 1.0 ); // returns false

If provided nonnumeric values, elementwise comparisons are performed according to lexicographic order.
Examples
var randu = require( '@stdlib/randombaserandu' );
var filledarrayBy = require( '@stdlib/arrayfilledby' );
var isBetweenArray = require( '@stdlib/assertisbetweenarray' );
// 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 );
See Also

@stdlib/assertisbetween
: test if a value is between two values.
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
License
See LICENSE.
Copyright
Copyright © 20162023. The Stdlib Authors.