149 lines
3.0 KiB
Markdown
149 lines
3.0 KiB
Markdown
|
<!--
|
||
|
|
||
|
@license Apache-2.0
|
||
|
|
||
|
Copyright (c) 2018 The Stdlib Authors.
|
||
|
|
||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||
|
you may not use this file except in compliance with the License.
|
||
|
You may obtain a copy of the License at
|
||
|
|
||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||
|
|
||
|
Unless required by applicable law or agreed to in writing, software
|
||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
|
See the License for the specific language governing permissions and
|
||
|
limitations under the License.
|
||
|
|
||
|
-->
|
||
|
|
||
|
# isBetweenArray
|
||
|
|
||
|
> Test if a value is an array-like object where every element is between two values.
|
||
|
|
||
|
<section class="usage">
|
||
|
|
||
|
## Usage
|
||
|
|
||
|
```javascript
|
||
|
var isBetweenArray = require( '@stdlib/assert/is-between-array' );
|
||
|
```
|
||
|
|
||
|
#### isBetweenArray( value, a, b\[, left, right] )
|
||
|
|
||
|
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).
|
||
|
|
||
|
```javascript
|
||
|
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.
|
||
|
|
||
|
```javascript
|
||
|
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'`.
|
||
|
|
||
|
```javascript
|
||
|
var arr = [ 3, 4, 5 ];
|
||
|
|
||
|
var bool = isBetweenArray( arr, 3, 5, 'open', 'closed' );
|
||
|
// returns false
|
||
|
|
||
|
bool = isBetweenArray( arr, 3, 5, 'closed', 'open' );
|
||
|
// returns false
|
||
|
```
|
||
|
|
||
|
</section>
|
||
|
|
||
|
<!-- /.usage -->
|
||
|
|
||
|
<section class="notes">
|
||
|
|
||
|
## Notes
|
||
|
|
||
|
- If `a` and `b` are inclusive, the element-wise comparison is equivalent to
|
||
|
|
||
|
```text
|
||
|
a <= v_i <= b
|
||
|
```
|
||
|
|
||
|
- If `a` is exclusive and `b` is inclusive, the element-wise comparison is equivalent to
|
||
|
|
||
|
```text
|
||
|
a < v_i <= b
|
||
|
```
|
||
|
|
||
|
- If `a` is inclusive and `b` is exclusive, the element-wise comparison is equivalent to
|
||
|
|
||
|
```text
|
||
|
a <= v_i < b
|
||
|
```
|
||
|
|
||
|
- If `a` and `b` are exclusive, the element-wise comparison is equivalent to
|
||
|
|
||
|
```text
|
||
|
a < v_i < b
|
||
|
```
|
||
|
|
||
|
- If provided an empty array-like `object`, the function returns `false`.
|
||
|
|
||
|
```javascript
|
||
|
var bool = isBetweenArray( [], 0.0, 1.0 );
|
||
|
// returns false
|
||
|
```
|
||
|
|
||
|
- If provided non-numeric values, element-wise comparisons are performed according to lexicographic order.
|
||
|
|
||
|
</section>
|
||
|
|
||
|
<!-- /.notes -->
|
||
|
|
||
|
<section class="examples">
|
||
|
|
||
|
## Examples
|
||
|
|
||
|
<!-- eslint no-undef: "error" -->
|
||
|
|
||
|
```javascript
|
||
|
var randu = require( '@stdlib/random/base/randu' );
|
||
|
var Float64Array = require( '@stdlib/array/float64' );
|
||
|
var isBetweenArray = require( '@stdlib/assert/is-between-array' );
|
||
|
|
||
|
var x;
|
||
|
var i;
|
||
|
|
||
|
x = new Float64Array( 100 );
|
||
|
for ( i = 0; i < x.length; i++ ) {
|
||
|
x[ i ] = randu();
|
||
|
}
|
||
|
console.log( isBetweenArray( x, 0.01, 0.99 ) );
|
||
|
```
|
||
|
|
||
|
</section>
|
||
|
|
||
|
<!-- /.examples -->
|
||
|
|
||
|
<section class="links">
|
||
|
|
||
|
</section>
|
||
|
|
||
|
<!-- /.links -->
|