main.js (1430B)
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 computeCis = require( './cis.js' ); 24 25 26 // MAIN // 27 28 /** 29 * Computes the cis function of a complex number. 30 * 31 * @param {(Array|TypedArray|Object)} [out] - output array 32 * @param {number} re - real component 33 * @param {number} im - imaginary component 34 * @returns {(Array|TypedArray|Object)} output array 35 * 36 * @example 37 * var v = cis( 0.0, 0.0 ); 38 * // returns [ 1.0, 0.0 ] 39 * 40 * @example 41 * var v = cis( 1.0, 0.0 ); 42 * // returns [ ~0.540, ~0.841 ] 43 * 44 * @example 45 * var out = [ 0.0, 0.0 ]; 46 * 47 * var v = cis( out, 1.0, 0.0 ); 48 * // returns [ ~0.540, ~0.841 ] 49 * 50 * var bool = ( v === out ); 51 * // returns true 52 */ 53 function cis( out, re, im ) { 54 if ( arguments.length === 2 ) { 55 return computeCis( [ 0.0, 0.0 ], out, re ); 56 } 57 return computeCis( out, re, im ); 58 } 59 60 61 // EXPORTS // 62 63 module.exports = cis;