index.js (1328B)
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 /** 22 * Restrict a double-precision floating-point number to a specified range. 23 * 24 * @module @stdlib/math/base/special/clamp 25 * 26 * @example 27 * var clamp = require( '@stdlib/math/base/special/clamp' ); 28 * 29 * var v = clamp( 3.14, 0.0, 5.0 ); 30 * // returns 3.14 31 * 32 * v = clamp( -3.14, 0.0, 5.0 ); 33 * // returns 0.0 34 * 35 * v = clamp( 10.0, 0.0, 5.0 ); 36 * // returns 5.0 37 * 38 * v = clamp( -0.0, 0.0, 5.0 ); 39 * // returns 0.0 40 * 41 * v = clamp( 0.0, -0.0, 5.0 ); 42 * // returns 0.0 43 * 44 * v = clamp( NaN, 0.0, 5.0 ); 45 * // returns NaN 46 * 47 * v = clamp( 0.0, NaN, 5.0 ); 48 * // returns NaN 49 * 50 * v = clamp( 3.14, 0.0, NaN ); 51 * // returns NaN 52 */ 53 54 // MODULES // 55 56 var clamp = require( './main.js' ); 57 58 59 // EXPORTS // 60 61 module.exports = clamp;