54 lines
1.1 KiB
JavaScript
54 lines
1.1 KiB
JavaScript
/**
|
|
* @license Apache-2.0
|
|
*
|
|
* Copyright (c) 2018 The Stdlib Authors.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
'use strict';
|
|
|
|
// MAIN //
|
|
|
|
/**
|
|
* Restricts an index to the interval `[0,max]`.
|
|
*
|
|
* @param {integer} idx - index
|
|
* @param {NonNegativeInteger} max - maximum index
|
|
* @returns {NonNegativeInteger} index
|
|
*
|
|
* @example
|
|
* var idx = clampIndex( -1, 10 );
|
|
* // returns 0
|
|
*
|
|
* idx = clampIndex( 15, 10 );
|
|
* // returns 10
|
|
*
|
|
* idx = clampIndex( 5, 10 );
|
|
* // returns 5
|
|
*/
|
|
function clampIndex( idx, max ) {
|
|
if ( idx < 0 ) {
|
|
return 0;
|
|
}
|
|
if ( idx > max ) {
|
|
return max;
|
|
}
|
|
return idx;
|
|
}
|
|
|
|
|
|
// EXPORTS //
|
|
|
|
module.exports = clampIndex;
|