main.js (1144B)
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 // MAIN // 22 23 /** 24 * Compute the principal square root of a double-precision floating-point number. 25 * 26 * @type {Function} 27 * @param {number} x - input value 28 * @returns {number} principal square root 29 * 30 * @example 31 * var v = sqrt( 4.0 ); 32 * // returns 2.0 33 * 34 * v = sqrt( 9.0 ); 35 * // returns 3.0 36 * 37 * v = sqrt( 0.0 ); 38 * // returns 0.0 39 * 40 * v = sqrt( -4.0 ); 41 * // returns NaN 42 * 43 * v = sqrt( NaN ); 44 * // returns NaN 45 */ 46 var sqrt = Math.sqrt; // eslint-disable-line stdlib/no-builtin-math 47 48 49 // EXPORTS // 50 51 module.exports = sqrt;