Home > Objects > @iData > permute.m

iFit/permute

PURPOSE ^

c = permute(a, order) : Permute object dimensions from iData objects/arrays

SYNOPSIS ^

function a = permute(a, order)

DESCRIPTION ^

 c = permute(a, order) : Permute object dimensions from iData objects/arrays

   @iData/permute rearranges the dimensions of object A so that they
     are in the order specified by the vector ORDER.  The object produced
     has the same values as A but the order of the subscripts needed to 
     access any particular element are rearranged as specified by ORDER.
   For an N-D array A, numel(ORDER)>=ndims(A). All the elements of 
     ORDER must be unique.
   PERMUTE is a generalization of transpose (.') 

 input:  a: object or array (iData)
         order: index of dimensions to swap/permute. 
                Default is [2 1], that is transpose.
 output: c: object or array (iData)
 ex:     c=permute(iData(rand(2,3,4)),[2 3 1]);

 Version: Aug. 22, 2017
 See also iData, iData/size, iData/reshape, iData/resize

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Tue 22-Aug-2017 11:03:30 by m2html © 2005. iFit (c) E.Farhi/ILL EUPL 1.1