main.js (1194B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2021 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 // MAIN // 22 23 /** 24 * Computes the absolute value of a double-precision floating-point number `x`. 25 * 26 * @param {number} x - input value 27 * @returns {number} absolute value 28 * 29 * @example 30 * var v = abs( -1.0 ); 31 * // returns 1.0 32 * 33 * @example 34 * var v = abs( 2.0 ); 35 * // returns 2.0 36 * 37 * @example 38 * var v = abs( 0.0 ); 39 * // returns 0.0 40 * 41 * @example 42 * var v = abs( -0.0 ); 43 * // returns 0.0 44 * 45 * @example 46 * var v = abs( NaN ); 47 * // returns NaN 48 */ 49 function abs( x ) { 50 return Math.abs( x ); // eslint-disable-line stdlib/no-builtin-math 51 } 52 53 54 // EXPORTS // 55 56 module.exports = abs;