Mercurial > octave-antonio

annotate scripts/set/powerset.m @ 20160:03b9d17a2d95 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update more docstrings to have one sentence summary as first line. Reviewed io, java, linear-algebra, prefs, and set script directories. * scripts/io/beep.m, scripts/io/dlmwrite.m, scripts/io/importdata.m, scripts/io/strread.m, scripts/io/textread.m, scripts/java/javaArray.m, scripts/java/java_get.m, scripts/java/java_set.m, scripts/java/javaaddpath.m, scripts/java/javachk.m, scripts/java/javaclasspath.m, scripts/java/javamem.m, scripts/java/javarmpath.m, scripts/linear-algebra/bandwidth.m, scripts/linear-algebra/commutation_matrix.m, scripts/linear-algebra/cond.m, scripts/linear-algebra/condest.m, scripts/linear-algebra/cross.m, scripts/linear-algebra/duplication_matrix.m, scripts/linear-algebra/expm.m, scripts/linear-algebra/housh.m, scripts/linear-algebra/isdefinite.m, scripts/linear-algebra/ishermitian.m, scripts/linear-algebra/issymmetric.m, scripts/linear-algebra/istril.m, scripts/linear-algebra/istriu.m, scripts/linear-algebra/krylov.m, scripts/linear-algebra/logm.m, scripts/linear-algebra/normest.m, scripts/linear-algebra/null.m, scripts/linear-algebra/onenormest.m, scripts/linear-algebra/orth.m, scripts/linear-algebra/qzhess.m, scripts/linear-algebra/rank.m, scripts/linear-algebra/rref.m, scripts/linear-algebra/vech.m, scripts/path/matlabroot.m, scripts/prefs/addpref.m, scripts/prefs/getpref.m, scripts/prefs/ispref.m, scripts/prefs/rmpref.m, scripts/prefs/setpref.m, scripts/set/powerset.m, scripts/set/setdiff.m: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Sun, 03 May 2015 15:36:23 -0700
parents 9fc020886ae9
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19697
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 19003
diff changeset
1 ## Copyright (C) 2010-2015 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 ##
20160
03b9d17a2d95 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19833
diff changeset
27 ## With the optional argument @qcode{"rows"}, each row of the set @var{a} is
03b9d17a2d95 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19833
diff changeset
28 ## considered one element of the set. The input must be a 2-D numeric matrix
03b9d17a2d95 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19833
diff changeset
29 ## to use this argument.
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 ##
19003
d00f6b09258f Overhaul functions in scripts/set directory.
Rik <rik@octave.org>
parents: 17744
diff changeset
31 ## @seealso{unique, union, intersect, setdiff, setxor, 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
19003
d00f6b09258f Overhaul functions in scripts/set directory.
Rik <rik@octave.org>
parents: 17744
diff changeset
36 if (nargin < 1 || nargin > 2)
d00f6b09258f Overhaul functions in scripts/set directory.
Rik <rik@octave.org>
parents: 17744
diff changeset
37 print_usage ();
d00f6b09258f Overhaul functions in scripts/set directory.
Rik <rik@octave.org>
parents: 17744
diff changeset
38 endif
d00f6b09258f Overhaul functions in scripts/set directory.
Rik <rik@octave.org>
parents: 17744
diff changeset
39
10047
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
40 byrows = false;
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
41 if (nargin == 2)
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
42 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
43 error ('powerset: expecting second argument to be "rows"');
10047
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
44 elseif (iscell (a))
19003
d00f6b09258f Overhaul functions in scripts/set directory.
Rik <rik@octave.org>
parents: 17744
diff changeset
45 error ('powerset: "rows" not valid for cell arrays');
10047
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
46 else
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
47 byrows = true;
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
48 endif
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
49 endif
19003
d00f6b09258f Overhaul functions in scripts/set directory.
Rik <rik@octave.org>
parents: 17744
diff changeset
50
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
51 if (iscell (a) && ! iscellstr (a))
19003
d00f6b09258f Overhaul functions in scripts/set directory.
Rik <rik@octave.org>
parents: 17744
diff changeset
52 error ("powerset: cell arrays can only be used for character strings");
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
53 endif
10047
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
54
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
55 if (byrows)
19003
d00f6b09258f Overhaul functions in scripts/set directory.
Rik <rik@octave.org>
parents: 17744
diff changeset
56 a = unique (a, "rows");
10047
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
57 n = rows (a);
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
58 else
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
59 a = unique (a);
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
60 n = numel (a);
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
61 endif
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
62
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
63 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
64 p = {};
10047
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
65 else
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
66 if (n > 32)
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
67 error ("powerset: not implemented for more than 32 elements");
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
68 endif
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
69
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
70 ## Logical rep
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
71 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
72 ## Convert to indices and lengths.
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
73 [i, k] = find (b);
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
74 k = sum (b, 1);
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
75
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
76 ## Index and split.
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
77 if (byrows)
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
78 p = mat2cell (a(i,:), k, columns (a));
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
79 else
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
80 if (rows (a) == 1)
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
81 p = mat2cell (a(i), 1, k);
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
82 else
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
83 p = mat2cell (a(i), k, 1);
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 endif
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
86 endif
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
87
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
88 endfunction
12852
0232a5300adf codesprint: Add 1 test to powerset.m
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents: 12213
diff changeset
89
0232a5300adf codesprint: Add 1 test to powerset.m
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents: 12213
diff changeset
90
19003
d00f6b09258f Overhaul functions in scripts/set directory.
Rik <rik@octave.org>
parents: 17744
diff changeset
91 %!test
d00f6b09258f Overhaul functions in scripts/set directory.
Rik <rik@octave.org>
parents: 17744
diff changeset
92 %! c = sort (cellstr ({[], [1], [2], [3], [1, 2], [1, 3], [2, 3], [1, 2, 3]}));
12852
0232a5300adf codesprint: Add 1 test to powerset.m
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents: 12213
diff changeset
93 %! p = sort (cellstr (powerset ([1, 2, 3])));
19003
d00f6b09258f Overhaul functions in scripts/set directory.
Rik <rik@octave.org>
parents: 17744
diff changeset
94 %! assert (p, c);
d00f6b09258f Overhaul functions in scripts/set directory.
Rik <rik@octave.org>
parents: 17744
diff changeset
95
d00f6b09258f Overhaul functions in scripts/set directory.
Rik <rik@octave.org>
parents: 17744
diff changeset
96 %!test
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
97 %! 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
98 %! p = sort (cellstr (powerset ([1:3;2:4;3:5], "rows")));
19003
d00f6b09258f Overhaul functions in scripts/set directory.
Rik <rik@octave.org>
parents: 17744
diff changeset
99 %! assert (p,c);
d00f6b09258f Overhaul functions in scripts/set directory.
Rik <rik@octave.org>
parents: 17744
diff changeset
100
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
101 %!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
102
19833
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19697
diff changeset
103 ## Test input validation
19003
d00f6b09258f Overhaul functions in scripts/set directory.
Rik <rik@octave.org>
parents: 17744
diff changeset
104 %!error powerset ()
d00f6b09258f Overhaul functions in scripts/set directory.
Rik <rik@octave.org>
parents: 17744
diff changeset
105 %!error powerset (1,2,3)
d00f6b09258f Overhaul functions in scripts/set directory.
Rik <rik@octave.org>
parents: 17744
diff changeset
106 %!error <expecting second argument to be "rows"> powerset (1, "cols")
d00f6b09258f Overhaul functions in scripts/set directory.
Rik <rik@octave.org>
parents: 17744
diff changeset
107 %!error <"rows" not valid for cell arrays> powerset ({1}, "rows")
d00f6b09258f Overhaul functions in scripts/set directory.
Rik <rik@octave.org>
parents: 17744
diff changeset
108 %!error <cell arrays can only be used for character> powerset ({1})
d00f6b09258f Overhaul functions in scripts/set directory.
Rik <rik@octave.org>
parents: 17744
diff changeset
109 %!error <not implemented for more than 32 elements> powerset (1:33)
d00f6b09258f Overhaul functions in scripts/set directory.
Rik <rik@octave.org>
parents: 17744
diff changeset
110