simple-squiggle

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

squeeze.md (1133B)

      1 <!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
      2 
      3 # Function squeeze
      4 
      5 Squeeze a matrix, remove inner and outer singleton dimensions from a matrix.
      6 
      7 
      8 ## Syntax
      9 
     10 ```js
     11 math.squeeze(x)
     12 ```
     13 
     14 ### Parameters
     15 
     16 Parameter | Type | Description
     17 --------- | ---- | -----------
     18 `x` | Matrix &#124; Array | Matrix to be squeezed
     19 
     20 ### Returns
     21 
     22 Type | Description
     23 ---- | -----------
     24 Matrix &#124; Array | Squeezed matrix
     25 
     26 
     27 ### Throws
     28 
     29 Type | Description
     30 ---- | -----------
     31 
     32 
     33 ## Examples
     34 
     35 ```js
     36 math.squeeze([3])           // returns 3
     37 math.squeeze([[3]])         // returns 3
     38 
     39 const A = math.zeros(3, 1)    // returns [[0], [0], [0]] (size 3x1)
     40 math.squeeze(A)             // returns [0, 0, 0] (size 3)
     41 
     42 const B = math.zeros(1, 3)    // returns [[0, 0, 0]] (size 1x3)
     43 math.squeeze(B)             // returns [0, 0, 0] (size 3)
     44 
     45 // only inner and outer dimensions are removed
     46 const C = math.zeros(2, 1, 3) // returns [[[0, 0, 0]], [[0, 0, 0]]] (size 2x1x3)
     47 math.squeeze(C)             // returns [[[0, 0, 0]], [[0, 0, 0]]] (size 2x1x3)
     48 ```
     49 
     50 
     51 ## See also
     52 
     53 [subset](subset.md)