complex.js (1402B)
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 CTORS = require( './ctors.js' ); 24 25 26 // MAIN // 27 28 /** 29 * Creates a complex number. 30 * 31 * @param {number} real - real component 32 * @param {number} imag - imaginary component 33 * @param {string} [dtype="float64"] - data type 34 * @throws {TypeError} must provide a recognized data type 35 * @returns {Complex} complex number 36 * 37 * @example 38 * var z = complex( 5.0, 3.0, 'float64' ); 39 * // returns <Complex128> 40 */ 41 function complex( real, imag, dtype ) { 42 var ctor; 43 if ( arguments.length > 2 ) { 44 ctor = CTORS[ dtype ]; 45 if ( ctor ) { 46 return new ctor( real, imag ); 47 } 48 throw new TypeError( 'invalid argument. Must provide a recognized data type. Value: `'+dtype+'`.' ); 49 } 50 return new CTORS[ 'float64' ]( real, imag ); 51 } 52 53 54 // EXPORTS // 55 56 module.exports = complex;