time-to-botec

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

main.js (1418B)

      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 * Converts a double-precision floating-point number to an unsigned 32-bit integer.
     25 *
     26 * @param {number} x - double-precision floating-point number
     27 * @returns {uinteger32} unsigned 32-bit integer
     28 *
     29 * @example
     30 * var y = float64ToUint32( 4294967297.0 );
     31 * // returns 1
     32 *
     33 * @example
     34 * var y = float64ToUint32( 3.14 );
     35 * // returns 3
     36 *
     37 * @example
     38 * var y = float64ToUint32( -3.14 );
     39 * // returns 4294967293
     40 *
     41 * @example
     42 * var y = float64ToUint32( NaN );
     43 * // returns 0
     44 *
     45 * @example
     46 * var y = float64ToUint32( Infinity );
     47 * // returns 0
     48 *
     49 * @example
     50 * var y = float64ToUint32( -Infinity );
     51 * // returns 0
     52 */
     53 function float64ToUint32( x ) {
     54 	// NOTE: we could also use typed-arrays to achieve the same end.
     55 	return x >>> 0;
     56 }
     57 
     58 
     59 // EXPORTS //
     60 
     61 module.exports = float64ToUint32;