cabs.js (1050B)
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 // MODULES // 22 23 var hypot = require( './../../../../base/special/hypot' ); 24 25 26 // MAIN // 27 28 /** 29 * Computes the absolute value of a complex number. 30 * 31 * @param {number} re - real component 32 * @param {number} im - imaginary component 33 * @returns {number} absolute value 34 * 35 * @example 36 * var v = cabs( 5.0, 3.0 ); 37 * // returns ~5.83 38 */ 39 function cabs( re, im ) { 40 return hypot( re, im ); 41 } 42 43 44 // EXPORTS // 45 46 module.exports = cabs;