simple-squiggle

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

transpose.md (934B)

      1 <!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
      2 
      3 # Function transpose
      4 
      5 Transpose a matrix. All values of the matrix are reflected over its
      6 main diagonal. Only applicable to two dimensional matrices containing
      7 a vector (i.e. having size `[1,n]` or `[n,1]`). One dimensional
      8 vectors and scalars return the input unchanged.
      9 
     10 
     11 ## Syntax
     12 
     13 ```js
     14 math.transpose(x)
     15 ```
     16 
     17 ### Parameters
     18 
     19 Parameter | Type | Description
     20 --------- | ---- | -----------
     21 `x` | Array &#124; Matrix | Matrix to be transposed
     22 
     23 ### Returns
     24 
     25 Type | Description
     26 ---- | -----------
     27 Array &#124; Matrix | The transposed 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, 6]]
     40 math.transpose(A)               // returns [[1, 4], [2, 5], [3, 6]]
     41 ```
     42 
     43 
     44 ## See also
     45 
     46 [diag](diag.md),
     47 [inv](inv.md),
     48 [subset](subset.md),
     49 [squeeze](squeeze.md)