main.js (1674B)
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 divide = require( './cdiv.js' ); 24 25 26 // MAIN // 27 28 /** 29 * Divides two complex numbers. 30 * 31 * ## References 32 * 33 * - Baudin, Michael, and Robert L. Smith. 2012. "A Robust Complex Division in Scilab." _arXiv_ abs/1210.4539 \[cs.MS\] (October): 1–25. <https://arxiv.org/abs/1210.4539>. 34 * 35 * 36 * @param {(Array|TypedArray|Object)} [out] - output array 37 * @param {number} re1 - real component 38 * @param {number} im1 - imaginary component 39 * @param {number} re2 - real component 40 * @param {number} im2 - imaginary component 41 * @returns {(Array|TypedArray|Object)} output array 42 * 43 * @example 44 * var v = cdiv( -13.0, -1.0, -2.0, 1.0 ); 45 * // returns [ 5.0, 3.0 ] 46 * 47 * @example 48 * var out = new Array( 2 ); 49 * 50 * var v = cdiv( out, -13.0, -1.0, -2.0, 1.0 ); 51 * // returns [ 5.0, 3.0 ] 52 * 53 * var bool = ( v === out ); 54 * // returns true 55 */ 56 function cdiv( out, re1, im1, re2, im2 ) { 57 if ( arguments.length === 4 ) { 58 return divide( [ 0.0, 0.0 ], out, re1, im1, re2 ); 59 } 60 return divide( out, re1, im1, re2, im2 ); 61 } 62 63 64 // EXPORTS // 65 66 module.exports = cdiv;