main.js (1142B)
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 // MAIN // 22 23 /** 24 * Restricts an index to the interval `[0,max]`. 25 * 26 * @param {integer} idx - index 27 * @param {NonNegativeInteger} max - maximum index 28 * @returns {NonNegativeInteger} index 29 * 30 * @example 31 * var idx = clampIndex( -1, 10 ); 32 * // returns 0 33 * 34 * idx = clampIndex( 15, 10 ); 35 * // returns 10 36 * 37 * idx = clampIndex( 5, 10 ); 38 * // returns 5 39 */ 40 function clampIndex( idx, max ) { 41 if ( idx < 0 ) { 42 return 0; 43 } 44 if ( idx > max ) { 45 return max; 46 } 47 return idx; 48 } 49 50 51 // EXPORTS // 52 53 module.exports = clampIndex;