time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

main.js (3222B)

      1 /**
      2 * @license Apache-2.0
      3 *
      4 * Copyright (c) 2018 The Stdlib Authors.
      5 *
      6 * Licensed under the Apache License, Version 2.0 (the "License");
      7 * you may not use this file except in compliance with the License.
      8 * You may obtain a copy of the License at
      9 *
     10 *    http://www.apache.org/licenses/LICENSE-2.0
     11 *
     12 * Unless required by applicable law or agreed to in writing, software
     13 * distributed under the License is distributed on an "AS IS" BASIS,
     14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     15 * See the License for the specific language governing permissions and
     16 * limitations under the License.
     17 */
     18 
     19 'use strict';
     20 
     21 // MODULES //
     22 
     23 var isCollection = require( './../../is-collection' );
     24 
     25 
     26 // MAIN //
     27 
     28 /**
     29 * Tests if a value is an array-like object where every element is between two values.
     30 *
     31 * @param {*} value - value to test
     32 * @param {*} a - left comparison value
     33 * @param {*} b - right comparison value
     34 * @param {string} [left="closed"] - indicates whether the left comparison value is inclusive
     35 * @param {string} [right="closed"] - indicates whether the right comparison value is inclusive
     36 * @throws {TypeError} `left` must be a recognized string
     37 * @throws {TypeError} `right` must be a recognized string
     38 * @returns {boolean} boolean indicating whether a value is an array-like object where every element is between two values
     39 *
     40 * @example
     41 * var arr = [ 3.0, 3.14, 4.0 ];
     42 * var bool = isBetweenArray( arr, 3.0, 4.0 );
     43 * // returns true
     44 *
     45 * @example
     46 * var arr = [ 3.0, 3.14, 4.0 ];
     47 * var bool = isBetweenArray( arr, 3.14, 4.0 );
     48 * // returns false
     49 *
     50 * @example
     51 * var arr = [ 3.0, 3.14, 4.0 ];
     52 * var bool = isBetweenArray( arr, 3.0, 3.14 );
     53 * // returns false
     54 *
     55 * @example
     56 * var arr = [ 3.0, 3.14, 4.0 ];
     57 * var bool = isBetweenArray( arr, 3.0, 4.0, 'open', 'closed' );
     58 * // returns false
     59 *
     60 * @example
     61 * var arr = [ 3.0, 3.14, 4.0 ];
     62 * var bool = isBetweenArray( arr, 3.0, 4.0, 'closed', 'open' );
     63 * // returns false
     64 */
     65 function isBetweenArray( value, a, b, left, right ) {
     66 	var len;
     67 	var i;
     68 	if ( arguments.length > 3 ) {
     69 		if ( left !== 'closed' && left !== 'open' ) {
     70 			throw new TypeError( 'invalid argument. `left` must be one of the following strings: \'closed\' or \'open\'. Value: `'+left+'`.' );
     71 		}
     72 		if ( right !== 'closed' && right !== 'open' ) {
     73 			throw new TypeError( 'invalid argument. `right` must be one of the following strings: \'closed\' or \'open\'. Value: `'+right+'`.' );
     74 		}
     75 	}
     76 	if ( !isCollection( value ) ) {
     77 		return false;
     78 	}
     79 	len = value.length;
     80 	if ( len === 0 ) {
     81 		return false;
     82 	}
     83 	if ( left === 'closed' || left === void 0 ) {
     84 		if ( right === 'closed' || right === void 0 ) {
     85 			for ( i = 0; i < len; i++ ) {
     86 				if ( value[ i ] < a || value[ i ] > b ) {
     87 					return false;
     88 				}
     89 			}
     90 			return true;
     91 		}
     92 		for ( i = 0; i < len; i++ ) {
     93 			if ( value[ i ] < a || value[ i ] >= b ) {
     94 				return false;
     95 			}
     96 		}
     97 		return true;
     98 	}
     99 	if ( right === 'closed' || right === void 0 ) {
    100 		for ( i = 0; i < len; i++ ) {
    101 			if ( value[ i ] <= a || value[ i ] > b ) {
    102 				return false;
    103 			}
    104 		}
    105 		return true;
    106 	}
    107 	for ( i = 0; i < len; i++ ) {
    108 		if ( value[ i ] <= a || value[ i ] >= b ) {
    109 			return false;
    110 		}
    111 	}
    112 	return true;
    113 }
    114 
    115 
    116 // EXPORTS //
    117 
    118 module.exports = isBetweenArray;