10.20.18     UFMUNSTACK: Unstack a Matrix based on a Control File

UFMUNSTACK  control  QUIET

Unstacks a matrix into a set of sub-matrices using a set of filenames read from a  text file “control”.

As with UFMSTACK the first record in “control” gives the name of the .ufm matrix to be unstacked while each following record lists a sub-matrix. The number of sub-matrices should either be equal to the number of levels in the stacked matrix if the output matrices are to be “square” or evenly divisible into the number of levels if the output matrices are to be stacked themselves. For example, if the input matrix has 12 levels and 3 sub-matrices are specified on the control file then each sub-matrix will have 4 levels.

Note that the same control file may be used in both UFMSTACK and UFMUNSTACK; this may be convenient if the objective is to combine a set of matrices together, carry out some operation, e.g., factoring, or the combined matrix and then re-create the original sub-matrices.

As with the alternative procedure to unstack matrices, UNSTACK (10.20.12) there is no limit on the number of levels in the “master” matrix.

If the second parameter is ‘QUIET’ then the program runs in quiet mode; see 14.9. Clearly UFMUNSTACK is the converse of UFMSTACK and the same control file may be used for both.

See MXUNBLOCK (10.20.29) for a similar operation on blocked as opposed to stacked matrices.