Test if a value is between two values.
APACHE-2.0 License
Test if a value is between two values.
npm install @stdlib/assert-is-between
Alternatively,
script
tag without installation and bundlers, use the ES Module available on the esm
branch (see README).deno
branch (see README for usage intructions).umd
branch (see README).The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
var isBetween = require( '@stdlib/assert-is-between' );
Tests if a value
is between two values a
(left comparison value) and b
(right comparison value).
var bool = isBetween( 4, 3, 5 );
// returns true
bool = isBetween( 2, 3, 5 );
// returns false
bool = isBetween( 6, 3, 5 );
// returns false
By default, the function assumes that a
and b
are inclusive.
var bool = isBetween( 3, 3, 5 );
// returns true
bool = isBetween( 3, 3, 5, 'closed', 'closed' );
// returns true
bool = isBetween( 5, 3, 5 );
// returns true
bool = isBetween( 5, 3, 5, 'closed', 'closed' );
// returns true
To make a
and/or b
exclusive, set the respective arguments to 'open'
.
var bool = isBetween( 3, 3, 5, 'open', 'closed' );
// returns false
bool = isBetween( 5, 3, 5, 'closed', 'open' );
// returns false
If a
and b
are inclusive, the comparison is equivalent to
a <= v <= b
If a
is exclusive and b
is inclusive, the comparison is equivalent to
a < v <= b
If a
is inclusive and b
is exclusive, the comparison is equivalent to
a <= v < b
If a
and b
are exclusive, the comparison is equivalent to
a < v < b
If provided non-numeric values, comparisons are performed according to lexicographic order.
var randu = require( '@stdlib/random-base-randu' );
var round = require( '@stdlib/math-base-special-round' );
var isBetween = require( '@stdlib/assert-is-between' );
var bool;
var a;
var b;
var v;
var i;
for ( i = 0; i < 100; i++ ) {
a = round( (randu()*10.0) + 5.0 );
b = round( (randu()*10.0) + 15.0 );
v = round( randu()*25.0 );
bool = isBetween( v, a, b, 'open', 'closed' );
console.log( '%d < %d <= %d: %s', a, v, b, bool.toString() );
}
@stdlib/assert-is-between-array
: test if a value is an array-like object where every element is between two values.
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.
See LICENSE.
Copyright © 2016-2024. The Stdlib Authors.