annotate scripts/set/powerset.m @ 10793:be55736a0783

Grammarcheck the documentation from m-files.
author Rik <octave@nomad.inbox5.com>
date Sun, 18 Jul 2010 20:35:16 -0700
parents d1978e7364ad
children fd0a3ac60b0e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
10047
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
1 ## Copyright (C) 2010 Jaroslav Hajek
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")
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
22 ##
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
23 ## Return the cell array of all subsets of the set @var{a}.
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
24 ##
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
25 ## @end deftypefn
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
26 ## @seealso{unique, union, setxor, setdiff, ismember}
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
27
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
28 function p = powerset (a, byrows_arg)
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
29
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
30 byrows = false;
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
31
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
32 if (nargin == 2)
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
33 if (! strcmpi (byrows_arg, "rows"))
10635
d1978e7364ad Print name of function in error() string messages.
Rik <octave@nomad.inbox5.com>
parents: 10047
diff changeset
34 error ('powerset: expecting third argument to be "rows"');
10047
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
35 elseif (iscell (a))
10635
d1978e7364ad Print name of function in error() string messages.
Rik <octave@nomad.inbox5.com>
parents: 10047
diff changeset
36 warning ('powerset: "rows" not valid for cell arrays');
10047
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
37 else
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
38 byrows = true;
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
39 endif
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
40 elseif (nargin != 1)
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
41 print_usage ();
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
42 endif
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
43
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
44 if (byrows)
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
45 a = unique (a, byrows_arg);
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
46 n = rows (a);
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
47 else
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
48 a = unique (a);
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
49 n = numel (a);
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
50 endif
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
51
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
52 if (n == 0)
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
53 p = [];
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
54 else
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
55 if (n > 32)
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
56 error ("powerset: not implemented for more than 32 elements");
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
57 endif
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
58
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
59 ## Logical rep
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
60 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
61 ## Convert to indices and lengths.
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
62 [i, k] = find (b);
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
63 k = sum (b, 1);
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
64
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
65 ## Index and split.
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
66 if (byrows)
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
67 p = mat2cell (a(i,:), k, columns (a));
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
68 else
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
69 if (rows (a) == 1)
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
70 p = mat2cell (a(i), 1, k);
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
71 else
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
72 p = mat2cell (a(i), k, 1);
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
73 endif
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
74 endif
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
75 endif
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
76
60904110acbb omitted source from last changeset
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
77 endfunction