squeeze#

Purpose#

Remove any singleton dimensions from a multi-dimensional array.

Format#

atrim = squeeze(a)#

Parameters:: a (Multi-dimensional array) – data
Returns:: atrim (Multidimensional array or matrix) – with all dimensions equal to 1 removed.

Examples#

// Set seed for repeatable random numbers
rndseed 431234;

x = rndn(8, 1);

// Create 3 dimensional (2x1x4) array with 1 singleton dimension
a = areshape(x, 2|1|4);

// Create a 2x4 matrix 'x_2' from the 2x1x4 array 'a'
x_2 = squeeze(a);

After the above code:

a =     [1,.,.]
             -0.94527  -0.07985  0.88879  -1.0082

        [2,.,.]
             -0.45845   0.77882 -0.36897  0.78537

x_2 =        -0.94527  -0.07985  0.88879  -1.0082
             -0.45845   0.77882 -0.36897  0.78537

Remarks#

If the squeezed array contains two or fewer dimensions, the return will be of type matrix. If the squeezed array contains only one dimension, the orientation of the final two dimensions of the input will be preserved. For example, an input with dimensions 1x1x4, will return a 1x4 row vector. Where a 1x1x4x1 input will return a column vector.