octave_packages/m/general/cell2mat.m

   1 ## Copyright (C) 2005-2012 Laurent Mazet
   2 ## Copyright (C) 2010 Jaroslav Hajek
   3 ##
   4 ## This file is part of Octave.
   5 ##
   6 ## Octave is free software; you can redistribute it and/or modify it
   7 ## under the terms of the GNU General Public License as published by
   8 ## the Free Software Foundation; either version 3 of the License, or (at
   9 ## your option) any later version.
  10 ##
  11 ## Octave is distributed in the hope that it will be useful, but
  12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
  13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 ## General Public License for more details.
  15 ##
  16 ## You should have received a copy of the GNU General Public License
  17 ## along with Octave; see the file COPYING.  If not, see
  18 ## <http://www.gnu.org/licenses/>.
  19
  20 ## -*- texinfo -*-
  21 ## @deftypefn {Function File} {@var{m} =} cell2mat (@var{c})
  22 ## Convert the cell array @var{c} into a matrix by concatenating all
  23 ## elements of @var{c} into a hyperrectangle.  Elements of @var{c} must
  24 ## be numeric, logical or char matrices, or cell arrays, and @code{cat}
  25 ## must be able to concatenate them together.
  26 ## @seealso{mat2cell, num2cell}
  27 ## @end deftypefn
  28
  29 function m = cell2mat (c)
  30
  31   if (nargin != 1)
  32     print_usage ();
  33   endif
  34
  35   if (! iscell (c))
  36     error ("cell2mat: C is not a cell array");
  37   endif
  38
  39   nb = numel (c);
  40
  41   if (nb == 0)
  42     m = [];
  43   else
  44
  45     ## We only want numeric, logical, and char matrices.
  46     valid = cellfun ("isnumeric", c);
  47     valid |= cellfun ("islogical", c);
  48     valid |= cellfun ("isclass", c, "char");
  49     validc = cellfun ("isclass", c, "cell");
  50     valids = cellfun ("isclass", c, "struct");
  51
  52     if (! all (valid(:)) && ! all (validc(:)) && ! all (valids(:)))
  53       error ("cell2mat: wrong type elements or mixed cells, structs and matrices");
  54     endif
  55
  56     ## The goal is to minimize the total number of cat() calls.
  57     ## The dimensions can be concatenated along in arbitrary order.
  58     ## The numbers of concatenations are:
  59     ## n / d1
  60     ## n / (d1 * d2)
  61     ## n / (d1 * d2 * d3)
  62     ## etc.
  63     ## This is minimized if d1 >= d2 >= d3...
  64
  65     sc = size (c);
  66     nd = ndims (c);
  67     [~, isc] = sort (sc);
  68     for idim = isc
  69       if (sc(idim) == 1)
  70         continue;
  71       endif
  72       xdim = [1:idim-1, idim+1:nd];
  73       cc = num2cell (c, xdim);
  74       c = cellfun ("cat", {idim}, cc{:}, "uniformoutput", false);
  75     endfor
  76     m = c{1};
  77   endif
  78
  79 endfunction
  80
  81 ## Tests
  82 %!shared C, D, E, F
  83 %! C = {[1], [2 3 4]; [5; 9], [6 7 8; 10 11 12]};
  84 %! D = C; D(:,:,2) = C;
  85 %! E = [1 2 3 4; 5 6 7 8; 9 10 11 12];
  86 %! F = E; F(:,:,2) = E;
  87 %!assert (cell2mat (C), E);
  88 %!assert (cell2mat (D), F);
  89 %!test
  90 %! m = rand (10) + i * rand (10);
  91 %! c = mat2cell (m, [1 2 3 4], [4 3 2 1]);
  92 %! assert (cell2mat (c), m)
  93 %!test
  94 %! m = int8 (256*rand (4, 5, 6, 7, 8));
  95 %! c = mat2cell (m, [1 2 1], [1 2 2], [3 1 1 1], [4 1 2], [3 1 4]);
  96 %! assert (cell2mat (c), m)
  97 %!test
  98 %! m = {1, 2, 3};
  99 %! assert (cell2mat (mat2cell (m, 1, [1 1 1])), m);
 100 %!assert (cell2mat ({}), []);
 101 ## Demos
 102 %!demo
 103 %! C = {[1], [2 3 4]; [5; 9], [6 7 8; 10 11 12]};
 104 %! cell2mat (C)