time-to-botec

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

index.js (1544B)

      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 * Return a normal number `y` and exponent `exp` satisfying \\(x = y \cdot 2^\mathrm{exp}\\).
     23 *
     24 * @module @stdlib/number/float64/base/normalize
     25 *
     26 * @example
     27 * var normalize = require( '@stdlib/number/float64/base/normalize' );
     28 * var pow = require( '@stdlib/math/base/special/pow' );
     29 *
     30 * var out = normalize( 3.14e-319 );
     31 * // returns [ 1.4141234400356668e-303, -52 ]
     32 *
     33 * var y = out[ 0 ];
     34 * var exp = out[ 1 ];
     35 *
     36 * var bool = ( y*pow(2.0,exp) === 3.14e-319 );
     37 * // returns true
     38 *
     39 * @example
     40 * var Float64Array = require( '@stdlib/array/float64' );
     41 * var normalize = require( '@stdlib/number/float64/base/normalize' );
     42 *
     43 * var out = new Float64Array( 2 );
     44 *
     45 * var v = normalize( out, 3.14e-319 );
     46 * // returns <Float64Array>[ 1.4141234400356668e-303, -52 ]
     47 *
     48 * var bool = ( v === out );
     49 * // returns true
     50 */
     51 
     52 // MODULES //
     53 
     54 var normalize = require( './main.js' );
     55 
     56 
     57 // EXPORTS //
     58 
     59 module.exports = normalize;