Mercurial > hg > octave-nkf
annotate scripts/set/ismember.m @ 14138:72c96de7a403 stable
maint: update copyright notices for 2012
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Mon, 02 Jan 2012 14:25:41 -0500 |
parents | e8c52b442a99 |
children | 4d917a6a858b |
rev | line source |
---|---|
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
13228
diff
changeset
|
1 ## Copyright (C) 2000-2012 Paul Kienzle |
9345 | 2 ## Copyright (C) 2009 Jaroslav Hajek |
5178 | 3 ## |
5181 | 4 ## This file is part of Octave. |
5178 | 5 ## |
5181 | 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 | |
7016 | 8 ## the Free Software Foundation; either version 3 of the License, or (at |
9 ## your option) any later version. | |
5181 | 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. | |
5178 | 15 ## |
16 ## You should have received a copy of the GNU General Public License | |
7016 | 17 ## along with Octave; see the file COPYING. If not, see |
18 ## <http://www.gnu.org/licenses/>. | |
5178 | 19 |
20 ## -*- texinfo -*- | |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
21 ## @deftypefn {Function File} {@var{tf} =} ismember (@var{A}, @var{s}) |
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
22 ## @deftypefnx {Function File} {[@var{tf}, @var{S_idx}] =} ismember (@var{A}, @var{s}) |
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11431
diff
changeset
|
23 ## @deftypefnx {Function File} {[@var{tf}, @var{S_idx}] =} ismember (@var{A}, @var{s}, "rows") |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
24 ## Return a logical matrix @var{tf} with the same shape as @var{A} which is |
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11431
diff
changeset
|
25 ## true (1) if @code{A(i,j)} is in @var{s} and false (0) if it is not. If a |
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11431
diff
changeset
|
26 ## second output argument is requested, the index into @var{s} of each of the |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
27 ## matching elements is also returned. |
7128 | 28 ## |
29 ## @example | |
30 ## @group | |
31 ## a = [3, 10, 1]; | |
32 ## s = [0:9]; | |
9276
f5e4b5fd1f1e
Update ismember examples to remove incorrect reference to residue function
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
33 ## [tf, s_idx] = ismember (a, s); |
7128 | 34 ## @result{} tf = [1, 0, 1] |
9276
f5e4b5fd1f1e
Update ismember examples to remove incorrect reference to residue function
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
35 ## @result{} s_idx = [4, 0, 2] |
7128 | 36 ## @end group |
37 ## @end example | |
38 ## | |
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11431
diff
changeset
|
39 ## The inputs, @var{A} and @var{s}, may also be cell arrays. |
7128 | 40 ## |
41 ## @example | |
42 ## @group | |
43 ## a = @{'abc'@}; | |
44 ## s = @{'abc', 'def'@}; | |
9276
f5e4b5fd1f1e
Update ismember examples to remove incorrect reference to residue function
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
45 ## [tf, s_idx] = ismember (a, s); |
7128 | 46 ## @result{} tf = [1, 0] |
9276
f5e4b5fd1f1e
Update ismember examples to remove incorrect reference to residue function
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
47 ## @result{} s_idx = [1, 0] |
7128 | 48 ## @end group |
49 ## @end example | |
50 ## | |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
51 ## With the optional third argument @code{"rows"}, and matrices |
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11431
diff
changeset
|
52 ## @var{A} and @var{s} with the same number of columns, compare rows in |
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11431
diff
changeset
|
53 ## @var{A} with the rows in @var{s}. |
7128 | 54 ## |
55 ## @example | |
56 ## @group | |
57 ## a = [1:3; 5:7; 4:6]; | |
58 ## s = [0:2; 1:3; 2:4; 3:5; 4:6]; | |
9276
f5e4b5fd1f1e
Update ismember examples to remove incorrect reference to residue function
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
59 ## [tf, s_idx] = ismember(a, s, 'rows'); |
7128 | 60 ## @result{} tf = logical ([1; 0; 1]) |
9276
f5e4b5fd1f1e
Update ismember examples to remove incorrect reference to residue function
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
61 ## @result{} s_idx = [2; 0; 5]; |
7128 | 62 ## @end group |
63 ## @end example | |
64 ## | |
8286
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7883
diff
changeset
|
65 ## @seealso{unique, union, intersect, setxor, setdiff} |
5178 | 66 ## @end deftypefn |
67 | |
7129 | 68 ## Author: Paul Kienzle <pkienzle@users.sf.net> |
69 ## Author: Søren Hauberg <hauberg@gmail.com> | |
70 ## Author: Ben Abbott <bpabbott@mac.com> | |
5181 | 71 ## Adapted-by: jwe |
9345 | 72 ## Reimplemented using lookup & unique: Jaroslav Hajek <highegg@gmail.com> |
5181 | 73 |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
74 function [tf, a_idx] = ismember (A, s, varargin) |
10088
5edee330d4cb
better argument checking and handling in set functions
Jaroslav Hajek <highegg@gmail.com>
parents:
9924
diff
changeset
|
75 |
5edee330d4cb
better argument checking and handling in set functions
Jaroslav Hajek <highegg@gmail.com>
parents:
9924
diff
changeset
|
76 if (nargin < 2 || nargin > 3) |
5edee330d4cb
better argument checking and handling in set functions
Jaroslav Hajek <highegg@gmail.com>
parents:
9924
diff
changeset
|
77 print_usage (); |
5edee330d4cb
better argument checking and handling in set functions
Jaroslav Hajek <highegg@gmail.com>
parents:
9924
diff
changeset
|
78 endif |
5edee330d4cb
better argument checking and handling in set functions
Jaroslav Hajek <highegg@gmail.com>
parents:
9924
diff
changeset
|
79 |
13228
e8c52b442a99
Allow logical inputs to ismember() (Bug #33531).
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
80 ## lookup() does not handle logical values |
e8c52b442a99
Allow logical inputs to ismember() (Bug #33531).
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
81 if (islogical (A)) |
e8c52b442a99
Allow logical inputs to ismember() (Bug #33531).
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
82 A = uint8 (A); |
e8c52b442a99
Allow logical inputs to ismember() (Bug #33531).
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
83 endif |
e8c52b442a99
Allow logical inputs to ismember() (Bug #33531).
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
84 if (islogical (s)) |
e8c52b442a99
Allow logical inputs to ismember() (Bug #33531).
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
85 s = uint8 (s); |
e8c52b442a99
Allow logical inputs to ismember() (Bug #33531).
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
86 endif |
e8c52b442a99
Allow logical inputs to ismember() (Bug #33531).
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
87 |
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11431
diff
changeset
|
88 [A, s] = validargs ("ismember", A, s, varargin{:}); |
5181 | 89 |
9345 | 90 if (nargin == 2) |
91 s = s(:); | |
92 ## We do it this way, because we expect the array to be often sorted. | |
93 if (issorted (s)) | |
94 is = []; | |
95 else | |
96 [s, is] = sort (s); | |
97 endif | |
9364 | 98 |
9924 | 99 ## sort out NaNs in table |
9364 | 100 if (isreal (s) && ! isempty (s) && isnan (s(end))) |
101 s = s(1:end - sum (isnan (s))); | |
102 endif | |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
103 |
9345 | 104 if (nargout > 1) |
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11431
diff
changeset
|
105 a_idx = lookup (s, A, "m"); |
9345 | 106 tf = logical (a_idx); |
107 if (! isempty (is)) | |
108 a_idx(tf) = is (a_idx(tf)); | |
7128 | 109 endif |
110 else | |
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11431
diff
changeset
|
111 tf = lookup (s, A, "b"); |
9345 | 112 endif |
113 | |
10088
5edee330d4cb
better argument checking and handling in set functions
Jaroslav Hajek <highegg@gmail.com>
parents:
9924
diff
changeset
|
114 else |
5edee330d4cb
better argument checking and handling in set functions
Jaroslav Hajek <highegg@gmail.com>
parents:
9924
diff
changeset
|
115 |
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11431
diff
changeset
|
116 if (isempty (A) || isempty (s)) |
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11431
diff
changeset
|
117 tf = false (rows (A), 1); |
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11431
diff
changeset
|
118 a_idx = zeros (rows (A), 1); |
9733
aab4f2aa9ed9
make ismember more matlab compatible
Jaroslav Hajek <highegg@gmail.com>
parents:
9364
diff
changeset
|
119 else |
9345 | 120 |
9733
aab4f2aa9ed9
make ismember more matlab compatible
Jaroslav Hajek <highegg@gmail.com>
parents:
9364
diff
changeset
|
121 ## FIXME: lookup does not support "rows", so we just use unique. |
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11431
diff
changeset
|
122 [xx, ii, jj] = unique ([A; s], "rows", "last"); |
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11431
diff
changeset
|
123 na = rows (A); |
9733
aab4f2aa9ed9
make ismember more matlab compatible
Jaroslav Hajek <highegg@gmail.com>
parents:
9364
diff
changeset
|
124 jj = ii(jj(1:na)); |
aab4f2aa9ed9
make ismember more matlab compatible
Jaroslav Hajek <highegg@gmail.com>
parents:
9364
diff
changeset
|
125 tf = jj > na; |
9345 | 126 |
9733
aab4f2aa9ed9
make ismember more matlab compatible
Jaroslav Hajek <highegg@gmail.com>
parents:
9364
diff
changeset
|
127 if (nargout > 1) |
aab4f2aa9ed9
make ismember more matlab compatible
Jaroslav Hajek <highegg@gmail.com>
parents:
9364
diff
changeset
|
128 a_idx = max (0, jj - na); |
aab4f2aa9ed9
make ismember more matlab compatible
Jaroslav Hajek <highegg@gmail.com>
parents:
9364
diff
changeset
|
129 endif |
aab4f2aa9ed9
make ismember more matlab compatible
Jaroslav Hajek <highegg@gmail.com>
parents:
9364
diff
changeset
|
130 |
9345 | 131 endif |
5178 | 132 endif |
133 | |
7128 | 134 endfunction |
135 | |
6533 | 136 %!assert (ismember ({''}, {'abc', 'def'}), false); |
137 %!assert (ismember ('abc', {'abc', 'def'}), true); | |
138 %!assert (isempty (ismember ([], [1, 2])), true); | |
7077 | 139 %!assert (isempty (ismember ({}, {'a', 'b'})), true); |
7128 | 140 %!assert (ismember ('', {'abc', 'def'}), false); |
7883
3092dd54ad95
fix expected output from lasterr in tests; fix fail tests in ismember.m
John W. Eaton <jwe@octave.org>
parents:
7652
diff
changeset
|
141 %!fail ('ismember ([], {1, 2})'); |
3092dd54ad95
fix expected output from lasterr in tests; fix fail tests in ismember.m
John W. Eaton <jwe@octave.org>
parents:
7652
diff
changeset
|
142 %!fail ('ismember ({[]}, {1, 2})'); |
3092dd54ad95
fix expected output from lasterr in tests; fix fail tests in ismember.m
John W. Eaton <jwe@octave.org>
parents:
7652
diff
changeset
|
143 %!fail ('ismember ({}, {1, 2})'); |
3092dd54ad95
fix expected output from lasterr in tests; fix fail tests in ismember.m
John W. Eaton <jwe@octave.org>
parents:
7652
diff
changeset
|
144 %!fail ('ismember ({1}, {''1'', ''2''})'); |
3092dd54ad95
fix expected output from lasterr in tests; fix fail tests in ismember.m
John W. Eaton <jwe@octave.org>
parents:
7652
diff
changeset
|
145 %!fail ('ismember (1, ''abc'')'); |
3092dd54ad95
fix expected output from lasterr in tests; fix fail tests in ismember.m
John W. Eaton <jwe@octave.org>
parents:
7652
diff
changeset
|
146 %!fail ('ismember ({''1''}, {''1'', ''2''},''rows'')'); |
3092dd54ad95
fix expected output from lasterr in tests; fix fail tests in ismember.m
John W. Eaton <jwe@octave.org>
parents:
7652
diff
changeset
|
147 %!fail ('ismember ([1 2 3], [5 4 3 1], ''rows'')'); |
7128 | 148 %!assert (ismember ({'foo', 'bar'}, {'foobar'}), logical ([0, 0])); |
149 %!assert (ismember ({'foo'}, {'foobar'}), false); | |
150 %!assert (ismember ({'bar'}, {'foobar'}), false); | |
151 %!assert (ismember ({'bar'}, {'foobar', 'bar'}), true); | |
152 %!assert (ismember ({'foo', 'bar'}, {'foobar', 'bar'}), logical ([0, 1])); | |
153 %!assert (ismember ({'xfb', 'f', 'b'}, {'fb', 'b'}), logical ([0, 0, 1])); | |
154 %!assert (ismember ("1", "0123456789."), true); | |
155 | |
156 %!test | |
7652
b5731e43283a
ismember: correctly size idx output for empty args
John W. Eaton <jwe@octave.org>
parents:
7129
diff
changeset
|
157 %! [result, a_idx] = ismember ([1, 2], []); |
b5731e43283a
ismember: correctly size idx output for empty args
John W. Eaton <jwe@octave.org>
parents:
7129
diff
changeset
|
158 %! assert (result, logical ([0, 0])) |
b5731e43283a
ismember: correctly size idx output for empty args
John W. Eaton <jwe@octave.org>
parents:
7129
diff
changeset
|
159 %! assert (a_idx, [0, 0]); |
b5731e43283a
ismember: correctly size idx output for empty args
John W. Eaton <jwe@octave.org>
parents:
7129
diff
changeset
|
160 |
b5731e43283a
ismember: correctly size idx output for empty args
John W. Eaton <jwe@octave.org>
parents:
7129
diff
changeset
|
161 %!test |
b5731e43283a
ismember: correctly size idx output for empty args
John W. Eaton <jwe@octave.org>
parents:
7129
diff
changeset
|
162 %! [result, a_idx] = ismember ([], [1, 2]); |
b5731e43283a
ismember: correctly size idx output for empty args
John W. Eaton <jwe@octave.org>
parents:
7129
diff
changeset
|
163 %! assert (result, logical ([])) |
b5731e43283a
ismember: correctly size idx output for empty args
John W. Eaton <jwe@octave.org>
parents:
7129
diff
changeset
|
164 %! assert (a_idx, []); |
b5731e43283a
ismember: correctly size idx output for empty args
John W. Eaton <jwe@octave.org>
parents:
7129
diff
changeset
|
165 |
b5731e43283a
ismember: correctly size idx output for empty args
John W. Eaton <jwe@octave.org>
parents:
7129
diff
changeset
|
166 %!test |
b5731e43283a
ismember: correctly size idx output for empty args
John W. Eaton <jwe@octave.org>
parents:
7129
diff
changeset
|
167 %! [result, a_idx] = ismember ({'a', 'b'}, ''); |
b5731e43283a
ismember: correctly size idx output for empty args
John W. Eaton <jwe@octave.org>
parents:
7129
diff
changeset
|
168 %! assert (result, logical ([0, 0])) |
b5731e43283a
ismember: correctly size idx output for empty args
John W. Eaton <jwe@octave.org>
parents:
7129
diff
changeset
|
169 %! assert (a_idx, [0, 0]); |
b5731e43283a
ismember: correctly size idx output for empty args
John W. Eaton <jwe@octave.org>
parents:
7129
diff
changeset
|
170 |
b5731e43283a
ismember: correctly size idx output for empty args
John W. Eaton <jwe@octave.org>
parents:
7129
diff
changeset
|
171 %!test |
b5731e43283a
ismember: correctly size idx output for empty args
John W. Eaton <jwe@octave.org>
parents:
7129
diff
changeset
|
172 %! [result, a_idx] = ismember ({'a', 'b'}, {}); |
b5731e43283a
ismember: correctly size idx output for empty args
John W. Eaton <jwe@octave.org>
parents:
7129
diff
changeset
|
173 %! assert (result, logical ([0, 0])) |
b5731e43283a
ismember: correctly size idx output for empty args
John W. Eaton <jwe@octave.org>
parents:
7129
diff
changeset
|
174 %! assert (a_idx, [0, 0]); |
b5731e43283a
ismember: correctly size idx output for empty args
John W. Eaton <jwe@octave.org>
parents:
7129
diff
changeset
|
175 |
b5731e43283a
ismember: correctly size idx output for empty args
John W. Eaton <jwe@octave.org>
parents:
7129
diff
changeset
|
176 %!test |
b5731e43283a
ismember: correctly size idx output for empty args
John W. Eaton <jwe@octave.org>
parents:
7129
diff
changeset
|
177 %! [result, a_idx] = ismember ('', {'a', 'b'}); |
b5731e43283a
ismember: correctly size idx output for empty args
John W. Eaton <jwe@octave.org>
parents:
7129
diff
changeset
|
178 %! assert (result, false) |
b5731e43283a
ismember: correctly size idx output for empty args
John W. Eaton <jwe@octave.org>
parents:
7129
diff
changeset
|
179 %! assert (a_idx, 0); |
b5731e43283a
ismember: correctly size idx output for empty args
John W. Eaton <jwe@octave.org>
parents:
7129
diff
changeset
|
180 |
b5731e43283a
ismember: correctly size idx output for empty args
John W. Eaton <jwe@octave.org>
parents:
7129
diff
changeset
|
181 %!test |
b5731e43283a
ismember: correctly size idx output for empty args
John W. Eaton <jwe@octave.org>
parents:
7129
diff
changeset
|
182 %! [result, a_idx] = ismember ({}, {'a', 'b'}); |
b5731e43283a
ismember: correctly size idx output for empty args
John W. Eaton <jwe@octave.org>
parents:
7129
diff
changeset
|
183 %! assert (result, logical ([])) |
b5731e43283a
ismember: correctly size idx output for empty args
John W. Eaton <jwe@octave.org>
parents:
7129
diff
changeset
|
184 %! assert (a_idx, []); |
b5731e43283a
ismember: correctly size idx output for empty args
John W. Eaton <jwe@octave.org>
parents:
7129
diff
changeset
|
185 |
b5731e43283a
ismember: correctly size idx output for empty args
John W. Eaton <jwe@octave.org>
parents:
7129
diff
changeset
|
186 %!test |
7128 | 187 %! [result, a_idx] = ismember([1 2 3 4 5], [3]); |
188 %! assert (all (result == logical ([0 0 1 0 0])) && all (a_idx == [0 0 1 0 0])); | |
189 | |
190 %!test | |
191 %! [result, a_idx] = ismember([1 6], [1 2 3 4 5 1 6 1]); | |
9345 | 192 %! assert (all (result == logical ([1 1])) && a_idx(2) == 7); |
7128 | 193 |
194 %!test | |
195 %! [result, a_idx] = ismember ([3,10,1], [0,1,2,3,4,5,6,7,8,9]); | |
196 %! assert (all (result == logical ([1, 0, 1])) && all (a_idx == [4, 0, 2])); | |
197 | |
198 %!test | |
199 %! [result, a_idx] = ismember ("1.1", "0123456789.1"); | |
9364 | 200 %! assert (all (result == logical ([1, 1, 1])) && all (a_idx == [12, 11, 12])); |
7128 | 201 |
202 %!test | |
203 %! [result, a_idx] = ismember([1:3; 5:7; 4:6], [0:2; 1:3; 2:4; 3:5; 4:6], 'rows'); | |
204 %! assert (all (result == logical ([1; 0; 1])) && all (a_idx == [2; 0; 5])); | |
205 | |
206 %!test | |
207 %! [result, a_idx] = ismember([1.1,1.2,1.3; 2.1,2.2,2.3; 10,11,12], [1.1,1.2,1.3; 10,11,12; 2.12,2.22,2.32], 'rows'); | |
208 %! assert (all (result == logical ([1; 0; 1])) && all (a_idx == [1; 0; 2])); | |
209 |