index.js (1557B)
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 * Split a double-precision floating-point number into a normalized fraction and an integer power of two. 23 * 24 * @module @stdlib/math/base/special/frexp 25 * 26 * @example 27 * var frexp = require( '@stdlib/math/base/special/frexp' ); 28 * 29 * var out = frexp( 4.0 ); 30 * // returns [ 0.5, 3 ] 31 * 32 * out = frexp( 0.0 ); 33 * // returns [ 0.0, 0 ] 34 * 35 * out = frexp( -0.0 ); 36 * // returns [ -0.0, 0 ] 37 * 38 * out = frexp( NaN ); 39 * // returns [ NaN, 0 ] 40 * 41 * out = frexp( Infinity ); 42 * // returns [ Infinity , 0 ] 43 * 44 * out = frexp( -Infinity ); 45 * // returns [ -Infinity , 0 ] 46 * 47 * @example 48 * var Float64Array = require( '@stdlib/array/float64' ); 49 * var frexp = require( '@stdlib/math/base/special/frexp' ); 50 * 51 * var out = new Float64Array( 2 ); 52 * 53 * var y = frexp( out, 4.0 ); 54 * // returns <Float64Array>[ 0.5, 3 ] 55 * 56 * var bool = ( y === out ); 57 * // returns true 58 */ 59 60 // MODULES // 61 62 var frexp = require( './main.js' ); 63 64 65 // EXPORTS // 66 67 module.exports = frexp;