index.js (1387B)
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 * Compute the relative difference in units of double-precision floating-point epsilon. 23 * 24 * @module @stdlib/math/base/utils/float64-epsilon-difference 25 * 26 * @example 27 * var epsdiff = require( '@stdlib/math/base/utils/float64-epsilon-difference' ); 28 * 29 * var d = epsdiff( 12.15, 12.149999999999999 ); // => ~0.658ε 30 * // returns ~0.658 31 * 32 * d = epsdiff( 2.4341309458983933, 2.4341309458633909, 'mean-abs' ); // => ~64761.5ε => ~1.438e-11 33 * // returns ~64761.5 34 * 35 * function scale( x, y ) { 36 * // Return the minimum value: 37 * return ( x > y ) ? y : x; 38 * } 39 * 40 * d = epsdiff( 1.0000000000000002, 1.0000000000000100, scale ); // => ~44ε 41 * // returns ~44 42 */ 43 44 // MODULES // 45 46 var epsdiff = require( './main.js' ); 47 48 49 // EXPORTS // 50 51 module.exports = epsdiff;