annotate scripts/general/cell2mat.m @ 7017:a1dbe9d80eee

[project @ 2007-10-12 21:27:11 by jwe]
author jwe
date Fri, 12 Oct 2007 21:27:37 +0000
parents 93c65f2a5668
children 86955a1559c5 28b0618cf67c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
1 ## Copyright (C) 2005, 2006, 2007 Laurent Mazet
5580
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
2 ##
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
3 ## This file is part of Octave.
5580
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
4 ##
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
6 ## under the terms of the GNU General Public License as published by
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
8 ## your option) any later version.
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
9 ##
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
13 ## General Public License for more details.
5580
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
14 ##
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
17 ## <http://www.gnu.org/licenses/>.
5580
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
18
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
20 ## @deftypefn {Function File} {@var{m} =} cell2mat (@var{c})
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
21 ## Convert the cell array @var{c} into a matrix by concatenating all
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
22 ## elements of @var{c} into a hyperrectangle. Elements of @var{c} must
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
23 ## be numeric, logical or char, and @code{cat} must be able to
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
24 ## concatenate them together.
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5580
diff changeset
25 ## @seealso{mat2cell, num2cell}
5580
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
26 ## @end deftypefn
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
27
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
28 function m = cell2mat (c)
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
29
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
30 if (nargin != 1)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5720
diff changeset
31 print_usage ();
5580
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
32 endif
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
33
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
34 if (! iscell (c))
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
35 error ("cell2mat: c is not a cell array");
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
36 endif
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
37
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
38 nb = numel (c);
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
39
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
40 if (nb == 0)
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
41 m = [];
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
42 elseif (nb == 1)
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
43 elt = c{1};
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
44 if (isnumeric (elt) || ischar (elt) || islogical (elt))
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
45 m = elt;
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
46 elseif (iscell (elt))
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
47 m = cell2mat (elt);
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
48 else
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
49 error ("cell2mat: all elements of cell array must be numeric, logical or char");
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
50 endif
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
51 else
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
52 ## n dimensions case
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
53 for k = ndims (c):-1:2,
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
54 sz = size (c);
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
55 sz(end) = 1;
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
56 c1 = cell (sz);
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
57 for i = 1:(prod (sz))
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
58 c1{i} = cat (k, c{i:(prod (sz)):end});
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
59 endfor
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
60 c = c1;
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
61 endfor
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
62 m = cat (1, c1{:});
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
63 endif
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
64
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
65 endfunction
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
66
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
67 ## Tests
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
68 %!shared C, D, E, F
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
69 %! C = {[1], [2 3 4]; [5; 9], [6 7 8; 10 11 12]};
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
70 %! D = C; D(:,:,2) = C;
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
71 %! E = [1 2 3 4; 5 6 7 8; 9 10 11 12];
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
72 %! F = E; F(:,:,2) = E;
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
73 %!assert (cell2mat (C), E);
5716
7f79a99e273e [project @ 2006-03-24 16:56:09 by jwe]
jwe
parents: 5642
diff changeset
74 %!assert (cell2mat (D), F);
5580
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
75 ## Demos
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
76 %!demo
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
77 %! C = {[1], [2 3 4]; [5; 9], [6 7 8; 10 11 12]};
9cde5eb6f18b [project @ 2005-12-14 18:21:55 by jwe]
jwe
parents:
diff changeset
78 %! cell2mat (C)