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, well-written, studied, documented, tested, measured, and high-quality 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!
Test if a value is between two values.
npm install @stdlib/assert-is-between
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
andb
are inclusive, the comparison is equivalent toa <= v <= b
-
If
a
is exclusive andb
is inclusive, the comparison is equivalent toa < v <= b
-
If
a
is inclusive andb
is exclusive, the comparison is equivalent toa <= v < b
-
If
a
andb
are exclusive, the comparison is equivalent toa < 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.