simple-squiggle

A restricted subset of Squiggle
Log | Files | Refs | README

conj.md (1017B)

      1 <!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
      2 
      3 # Function conj
      4 
      5 Compute the complex conjugate of a complex value.
      6 If `x = a+bi`, the complex conjugate of `x` is `a - bi`.
      7 
      8 For matrices, the function is evaluated element wise.
      9 
     10 
     11 ## Syntax
     12 
     13 ```js
     14 math.conj(x)
     15 ```
     16 
     17 ### Parameters
     18 
     19 Parameter | Type | Description
     20 --------- | ---- | -----------
     21 `x` | number &#124; BigNumber &#124; Complex &#124; Array &#124; Matrix |  A complex number or array with complex numbers
     22 
     23 ### Returns
     24 
     25 Type | Description
     26 ---- | -----------
     27 number &#124; BigNumber &#124; Complex &#124; Array &#124; Matrix |  The complex conjugate of x
     28 
     29 
     30 ### Throws
     31 
     32 Type | Description
     33 ---- | -----------
     34 
     35 
     36 ## Examples
     37 
     38 ```js
     39 math.conj(math.complex('2 + 3i'))  // returns Complex 2 - 3i
     40 math.conj(math.complex('2 - 3i'))  // returns Complex 2 + 3i
     41 math.conj(math.complex('-5.2i'))  // returns Complex 5.2i
     42 ```
     43 
     44 
     45 ## See also
     46 
     47 [re](re.md),
     48 [im](im.md),
     49 [arg](arg.md),
     50 [abs](abs.md)