main.js (1746B)
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 fcn = require( './frexp.js' ); 24 25 26 // MAIN // 27 28 /** 29 * Splits a double-precision floating-point number into a normalized fraction and an integer power of two. 30 * 31 * @param {(Array|TypedArray|Object)} [out] - output array 32 * @param {number} x - input value 33 * @returns {(Array|TypedArray|Object)} output array 34 * 35 * @example 36 * var out = frexp( 4.0 ); 37 * // returns [ 0.5, 3 ] 38 * 39 * @example 40 * var Float64Array = require( '@stdlib/array/float64' ); 41 * 42 * var out = new Float64Array( 2 ); 43 * 44 * var y = frexp( out, 4.0 ); 45 * // returns <Float64Array>[ 0.5, 3 ] 46 * 47 * var bool = ( y === out ); 48 * // returns true 49 * 50 * @example 51 * var out = frexp( 0.0 ); 52 * // returns [ 0.0, 0 ] 53 * 54 * @example 55 * var out = frexp( -0.0 ); 56 * // returns [ -0.0, 0 ] 57 * 58 * @example 59 * var out = frexp( NaN ); 60 * // returns [ NaN, 0 ] 61 * 62 * @example 63 * var out = frexp( Infinity ); 64 * // returns [ Infinity , 0 ] 65 * 66 * @example 67 * var out = frexp( -Infinity ); 68 * // returns [ -Infinity , 0 ] 69 */ 70 function frexp( out, x ) { 71 if ( arguments.length === 1 ) { 72 return fcn( [ 0.0, 0 ], out ); 73 } 74 return fcn( out, x ); 75 } 76 77 78 // EXPORTS // 79 80 module.exports = frexp;