annotate scripts/set/powerset.m @ 17194:c954b0a396a2

comet.m: Speed up animation by using low-level graphic commands. * scripts/plot/comet.m: Speed up animation by using low-level graphic commands.
author Rik <rik@octave.org>
date Mon, 05 Aug 2013 15:44:02 -0700
parents 12005245b645
children bc924baa2c4e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 12855
diff changeset
1 ## Copyright (C) 2010-2012 Jaroslav Hajek
10047
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
2 ##
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
3 ## This file is part of Octave.
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
4 ##
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
8 ## your option) any later version.
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
9 ##
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
13 ## General Public License for more details.
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
14 ##
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
18
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
19 ## -*- texinfo -*-
10793
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 10635
diff changeset
20 ## @deftypefn {Function File} {} powerset (@var{a})
10047
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
21 ## @deftypefnx {Function File} {} powerset (@var{a}, "rows")
15686
9671baab36c4 powerset: always return a cell array, even when set is empty. Augmented documentation and new tests.
Carnë Draug <carandraug+dev@gmail.com>
parents: 14363
diff changeset
22 ## Compute the powerset (all subsets) of the set @var{a}.
10047
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
23 ##
15686
9671baab36c4 powerset: always return a cell array, even when set is empty. Augmented documentation and new tests.
Carnë Draug <carandraug+dev@gmail.com>
parents: 14363
diff changeset
24 ## The set @var{a} must be a numerical matrix or a cell array of strings. The
9671baab36c4 powerset: always return a cell array, even when set is empty. Augmented documentation and new tests.
Carnë Draug <carandraug+dev@gmail.com>
parents: 14363
diff changeset
25 ## output will always be a cell array of either vectors or strings.
10047
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
26 ##
15686
9671baab36c4 powerset: always return a cell array, even when set is empty. Augmented documentation and new tests.
Carnë Draug <carandraug+dev@gmail.com>
parents: 14363
diff changeset
27 ## With the optional second argument @code{"rows"}, each row of the set @var{a}
9671baab36c4 powerset: always return a cell array, even when set is empty. Augmented documentation and new tests.
Carnë Draug <carandraug+dev@gmail.com>
parents: 14363
diff changeset
28 ## is considered one element of the set. As a result, @var{a} must then be a
16816
12005245b645 doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 15686
diff changeset
29 ## numerical 2-D matrix.
15686
9671baab36c4 powerset: always return a cell array, even when set is empty. Augmented documentation and new tests.
Carnë Draug <carandraug+dev@gmail.com>
parents: 14363
diff changeset
30 ##
9671baab36c4 powerset: always return a cell array, even when set is empty. Augmented documentation and new tests.
Carnë Draug <carandraug+dev@gmail.com>
parents: 14363
diff changeset
31 ## @seealso{unique, union, setxor, setdiff, ismember}
10047
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
32 ## @end deftypefn
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
33
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
34 function p = powerset (a, byrows_arg)
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
35
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
36 byrows = false;
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
37
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
38 if (nargin == 2)
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
39 if (! strcmpi (byrows_arg, "rows"))
15686
9671baab36c4 powerset: always return a cell array, even when set is empty. Augmented documentation and new tests.
Carnë Draug <carandraug+dev@gmail.com>
parents: 14363
diff changeset
40 error ('powerset: expecting second argument to be "rows"');
10047
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
41 elseif (iscell (a))
10635
d1978e7364ad Print name of function in error() string messages.
Rik <octave@nomad.inbox5.com>
parents: 10047
diff changeset
42 warning ('powerset: "rows" not valid for cell arrays');
10047
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
43 else
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
44 byrows = true;
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
45 endif
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
46 elseif (nargin != 1)
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
47 print_usage ();
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
48 endif
15686
9671baab36c4 powerset: always return a cell array, even when set is empty. Augmented documentation and new tests.
Carnë Draug <carandraug+dev@gmail.com>
parents: 14363
diff changeset
49 if (iscell (a) && ! iscellstr (a))
9671baab36c4 powerset: always return a cell array, even when set is empty. Augmented documentation and new tests.
Carnë Draug <carandraug+dev@gmail.com>
parents: 14363
diff changeset
50 error ("powerset: cell arrays can only used for character strings");
9671baab36c4 powerset: always return a cell array, even when set is empty. Augmented documentation and new tests.
Carnë Draug <carandraug+dev@gmail.com>
parents: 14363
diff changeset
51 endif
10047
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
52
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
53 if (byrows)
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
54 a = unique (a, byrows_arg);
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
55 n = rows (a);
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
56 else
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
57 a = unique (a);
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
58 n = numel (a);
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
59 endif
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
60
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
61 if (n == 0)
15686
9671baab36c4 powerset: always return a cell array, even when set is empty. Augmented documentation and new tests.
Carnë Draug <carandraug+dev@gmail.com>
parents: 14363
diff changeset
62 p = {};
10047
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
63 else
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
64 if (n > 32)
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
65 error ("powerset: not implemented for more than 32 elements");
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
66 endif
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
67
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
68 ## Logical rep
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
69 b = reshape (bitunpack (uint32 (0:2^n-1)), 32, 2^n)(1:n,:);
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
70 ## Convert to indices and lengths.
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
71 [i, k] = find (b);
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
72 k = sum (b, 1);
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
73
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
74 ## Index and split.
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
75 if (byrows)
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
76 p = mat2cell (a(i,:), k, columns (a));
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
77 else
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
78 if (rows (a) == 1)
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
79 p = mat2cell (a(i), 1, k);
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
80 else
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
81 p = mat2cell (a(i), k, 1);
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
82 endif
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
83 endif
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
84 endif
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
85
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
86 endfunction
12852
0232a5300adf codesprint: Add 1 test to powerset.m
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents: 12213
diff changeset
87
0232a5300adf codesprint: Add 1 test to powerset.m
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents: 12213
diff changeset
88
15686
9671baab36c4 powerset: always return a cell array, even when set is empty. Augmented documentation and new tests.
Carnë Draug <carandraug+dev@gmail.com>
parents: 14363
diff changeset
89 %!shared c, p
12852
0232a5300adf codesprint: Add 1 test to powerset.m
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents: 12213
diff changeset
90 %! c = sort (cellstr ({ [], [1], [2], [3], [1, 2], [1, 3], [2, 3], [1, 2, 3]}));
0232a5300adf codesprint: Add 1 test to powerset.m
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents: 12213
diff changeset
91 %! p = sort (cellstr (powerset ([1, 2, 3])));
15686
9671baab36c4 powerset: always return a cell array, even when set is empty. Augmented documentation and new tests.
Carnë Draug <carandraug+dev@gmail.com>
parents: 14363
diff changeset
92 %!assert (p, c);
9671baab36c4 powerset: always return a cell array, even when set is empty. Augmented documentation and new tests.
Carnë Draug <carandraug+dev@gmail.com>
parents: 14363
diff changeset
93 %! c = sort (cellstr ({ [], [1:3], [2:4], [3:5], [1:3; 2:4], [1:3; 3:5], [2:4; 3:5], [1:3; 2:4; 3:5]}));
9671baab36c4 powerset: always return a cell array, even when set is empty. Augmented documentation and new tests.
Carnë Draug <carandraug+dev@gmail.com>
parents: 14363
diff changeset
94 %! p = sort (cellstr (powerset ([1:3;2:4;3:5], "rows")));
9671baab36c4 powerset: always return a cell array, even when set is empty. Augmented documentation and new tests.
Carnë Draug <carandraug+dev@gmail.com>
parents: 14363
diff changeset
95 %!assert (p,c);
9671baab36c4 powerset: always return a cell array, even when set is empty. Augmented documentation and new tests.
Carnë Draug <carandraug+dev@gmail.com>
parents: 14363
diff changeset
96 %!assert (powerset([]), {}); # always return a cell array
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
97