main.js (2017B)
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 isnan = require( './../../../../base/assert/is-nan' ); 24 var trunc = require( './../../../../base/special/trunc' ); 25 26 27 // MAIN // 28 29 /** 30 * Wraps a value on the half-open interval `[min,max)`. 31 * 32 * @param {number} v - input value 33 * @param {number} min - minimum value 34 * @param {number} max - maximum value 35 * @returns {number} wrapped value 36 * 37 * @example 38 * var v = wrap( 3.14, 0.0, 5.0 ); 39 * // returns 3.14 40 * 41 * v = wrap( -3.14, 0.0, 5.0 ); 42 * // returns ~1.86 43 * 44 * v = wrap( 10.0, 0.0, 5.0 ); 45 * // returns 0.0 46 * 47 * v = wrap( -0.0, 0.0, 5.0 ); 48 * // returns 0.0 49 * 50 * v = wrap( 0.0, -0.0, 5.0 ); 51 * // returns 0.0 52 * 53 * v = wrap( NaN, 0.0, 5.0 ); 54 * // returns NaN 55 * 56 * v = wrap( 0.0, NaN, 5.0 ); 57 * // returns NaN 58 * 59 * v = wrap( 3.14, 0.0, NaN ); 60 * // returns NaN 61 * 62 * v = wrap( 3.14, 5.0, 0.0 ); 63 * // returns NaN 64 */ 65 function wrap( v, min, max ) { 66 var delta; 67 if ( 68 isnan( v ) || 69 isnan( min ) || 70 isnan( max ) || 71 max <= min 72 ) { 73 return NaN; 74 } 75 // Normalize +-0 to +0... 76 if ( v === 0.0 ) { 77 v = 0.0; 78 } 79 if ( min === 0.0 ) { 80 min = 0.0; 81 } 82 if ( max === 0.0 ) { 83 max = 0.0; 84 } 85 // Simple case where value is already within range... 86 if ( min <= v && v < max ) { 87 return v; 88 } 89 // Perform range reduction... 90 delta = max - min; 91 if ( v < min ) { 92 v += delta * ( trunc( (min-v)/delta ) + 1.0 ); 93 } 94 return min + ( (v-min) % delta ); 95 } 96 97 98 // EXPORTS // 99 100 module.exports = wrap;