simple-squiggle

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

ctranspose.md (954B)

      1 <!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
      2 
      3 # Function ctranspose
      4 
      5 Transpose and complex conjugate a matrix. All values of the matrix are
      6 reflected over its main diagonal and then the complex conjugate is
      7 taken. This is equivalent to complex conjugation for scalars and
      8 vectors.
      9 
     10 
     11 ## Syntax
     12 
     13 ```js
     14 math.ctranspose(x)
     15 ```
     16 
     17 ### Parameters
     18 
     19 Parameter | Type | Description
     20 --------- | ---- | -----------
     21 `x` | Array &#124; Matrix | Matrix to be ctransposed
     22 
     23 ### Returns
     24 
     25 Type | Description
     26 ---- | -----------
     27 Array &#124; Matrix | The ctransposed matrix
     28 
     29 
     30 ### Throws
     31 
     32 Type | Description
     33 ---- | -----------
     34 
     35 
     36 ## Examples
     37 
     38 ```js
     39 const A = [[1, 2, 3], [4, 5, math.complex(6,7)]]
     40 math.ctranspose(A)               // returns [[1, 4], [2, 5], [3, {re:6,im:7}]]
     41 ```
     42 
     43 
     44 ## See also
     45 
     46 [transpose](transpose.md),
     47 [diag](diag.md),
     48 [inv](inv.md),
     49 [subset](subset.md),
     50 [squeeze](squeeze.md)