index.js (1300B)
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 * Decompose a double-precision floating-point number into integral and fractional parts. 23 * 24 * @module @stdlib/math/base/special/modf 25 * 26 * @example 27 * var modf = require( '@stdlib/math/base/special/modf' ); 28 * 29 * var parts = modf( 3.14 ); 30 * // returns [ 3.0, 0.14000000000000012 ] 31 * 32 * @example 33 * var Float64Array = require( '@stdlib/array/float64' ); 34 * var modf = require( '@stdlib/math/base/special/modf' ); 35 * 36 * var out = new Float64Array( 2 ); 37 * 38 * var parts = modf( out, 3.14 ); 39 * // returns [ 3.0, 0.14000000000000012 ] 40 * 41 * var bool = ( parts === out ); 42 * // returns true 43 */ 44 45 // MODULES // 46 47 var modf = require( './main.js' ); 48 49 50 // EXPORTS // 51 52 module.exports = modf;