time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

main.js (1942B)

      1 /**
      2 * @license Apache-2.0
      3 *
      4 * Copyright (c) 2020 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 isnanf = require( './../../../../base/assert/is-nanf' );
     24 var isNegativeZerof = require( './../../../../base/assert/is-negative-zerof' );
     25 
     26 
     27 // MAIN //
     28 
     29 /**
     30 * Restricts a single-precision floating-point number to a specified range.
     31 *
     32 * @param {number} v - input value
     33 * @param {number} min - minimum value
     34 * @param {number} max - maximum value
     35 * @returns {number} value restricted to a specified range
     36 *
     37 * @example
     38 * var v = clampf( 3.0, 0.0, 5.0 );
     39 * // returns 3.0
     40 *
     41 * v = clampf( -3.0, 0.0, 5.0 );
     42 * // returns 0.0
     43 *
     44 * v = clampf( 10.0, 0.0, 5.0 );
     45 * // returns 5.0
     46 *
     47 * v = clampf( -0.0, 0.0, 5.0 );
     48 * // returns 0.0
     49 *
     50 * v = clampf( 0.0, -0.0, 5.0 );
     51 * // returns 0.0
     52 *
     53 * v = clampf( NaN, 0.0, 5.0 );
     54 * // returns NaN
     55 *
     56 * v = clampf( 0.0, NaN, 5.0 );
     57 * // returns NaN
     58 *
     59 * v = clampf( 3.14, 0.0, NaN );
     60 * // returns NaN
     61 */
     62 function clampf( v, min, max ) {
     63 	if (
     64 		isnanf( v ) ||
     65 		isnanf( min ) ||
     66 		isnanf( max )
     67 	) {
     68 		return NaN;
     69 	}
     70 	// Simple cases...
     71 	if ( v < min ) {
     72 		return min;
     73 	}
     74 	if ( v > max ) {
     75 		return max;
     76 	}
     77 	// Special cases for handling +-0.0...
     78 	if ( min === 0.0 && isNegativeZerof( v ) ) {
     79 		return min; // +-0.0
     80 	}
     81 	if ( v === 0.0 && isNegativeZerof( max ) ) {
     82 		return max; // -0.0
     83 	}
     84 	// Case: min <= v <= max
     85 	return v;
     86 }
     87 
     88 
     89 // EXPORTS //
     90 
     91 module.exports = clampf;