time-to-botec

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

index.js (1443B)

      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 * Create a double-precision floating-point number from a higher order word (unsigned 32-bit integer) and a lower order word (unsigned 32-bit integer).
     23 *
     24 * @module @stdlib/number/float64/base/from-words
     25 *
     26 * @example
     27 * var fromWords = require( '@stdlib/number/float64/base/from-words' );
     28 *
     29 * var v = fromWords( 1774486211, 2479577218 );
     30 * // returns 3.14e201
     31 *
     32 * v = fromWords( 3221823995, 1413754136 );
     33 * // returns -3.141592653589793
     34 *
     35 * v = fromWords( 0, 0 );
     36 * // returns 0.0
     37 *
     38 * v = fromWords( 2147483648, 0 );
     39 * // returns -0.0
     40 *
     41 * v = fromWords( 2146959360, 0 );
     42 * // returns NaN
     43 *
     44 * v = fromWords( 2146435072, 0 );
     45 * // returns Infinity
     46 *
     47 * v = fromWords( 4293918720, 0 );
     48 * // returns -Infinity
     49 */
     50 
     51 // MODULES //
     52 
     53 var fromWords = require( './main.js' );
     54 
     55 
     56 // EXPORTS //
     57 
     58 module.exports = fromWords;