main.js (1388B)
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 modes = require( './../../../../index-modes' ); 24 25 26 // VARIABLES // 27 28 var MODES = modes(); 29 var len = MODES.length; 30 31 32 // MAIN // 33 34 /** 35 * Tests whether an input value is a supported ndarray index mode. 36 * 37 * @param {*} v - value to test 38 * @returns {boolean} boolean indicating whether an input value is a supported ndarray index mode 39 * 40 * @example 41 * var bool = isIndexMode( 'wrap' ); 42 * // returns true 43 * 44 * bool = isIndexMode( 'clamp' ); 45 * // returns true 46 * 47 * bool = isIndexMode( 'throw' ); 48 * // returns true 49 * 50 * bool = isIndexMode( 'foo' ); 51 * // returns false 52 */ 53 function isIndexMode( v ) { 54 var i; 55 for ( i = 0; i < len; i++ ) { 56 if ( v === MODES[ i ] ) { 57 return true; 58 } 59 } 60 return false; 61 } 62 63 64 // EXPORTS // 65 66 module.exports = isIndexMode;