conj.js (1036B)
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 /** 22 * Returns the complex conjugate of a complex number. 23 * 24 * @param {Complex} z - complex number 25 * @returns {Complex} complex conjugate 26 * 27 * @example 28 * var Complex128 = require( '@stdlib/complex/float64' ); 29 * 30 * var z = new Complex128( 5.0, 3.0 ); 31 * 32 * var v = conj( z ); 33 * // returns <Complex128> 34 */ 35 function conj( z ) { 36 return new z.constructor( z.re, -z.im ); 37 } 38 39 40 // EXPORTS // 41 42 module.exports = conj;