main.js (1475B)
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 negate = require( './cnegate.js' ); 24 25 26 // MAIN // 27 28 /** 29 * Negates 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)} negated components 35 * 36 * @example 37 * var v = cneg( -4.2, 5.5 ); 38 * // returns [ 4.2, -5.5 ] 39 * 40 * @example 41 * var out = new Array( 2 ); 42 * 43 * var v = cneg( out, -4.2, 5.5 ); 44 * // returns [ 4.2, -5.5 ] 45 * 46 * var bool = ( v === out ); 47 * // returns true 48 * 49 * @example 50 * var v = cneg( 0.0, 0.0 ); 51 * // returns [ -0.0, -0.0 ] 52 * 53 * @example 54 * var v = cneg( NaN, NaN ); 55 * // returns [ NaN, NaN ] 56 */ 57 function cneg( out, re, im ) { 58 if ( arguments.length === 2 ) { 59 return negate( [ 0.0, 0.0 ], out, re ); 60 } 61 return negate( out, re, im ); 62 } 63 64 65 // EXPORTS // 66 67 module.exports = cneg;