1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
|
## Copyright (C) 2000-2013 Paul Kienzle
## Copyright (C) 2008-2009 Jaroslav Hajek
##
## This file is part of Octave.
##
## Octave is free software; you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 3 of the License, or (at
## your option) any later version.
##
## Octave is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
## General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Octave; see the file COPYING. If not, see
## <http://www.gnu.org/licenses/>.
## -*- texinfo -*-
## @deftypefn {Function File} {} unique (@var{x})
## @deftypefnx {Function File} {} unique (@var{x}, "rows")
## @deftypefnx {Function File} {} unique (@dots{}, "first")
## @deftypefnx {Function File} {} unique (@dots{}, "last")
## @deftypefnx {Function File} {[@var{y}, @var{i}, @var{j}] =} unique (@dots{})
## Return the unique elements of @var{x}, sorted in ascending order.
## If the input @var{x} is a vector then the output is also a vector with the
## same orientation (row or column) as the input. For a matrix input the
## output is always a column vector. @var{x} may also be a cell array of
## strings.
##
## If the optional argument @qcode{"rows"} is supplied, return the unique
## rows of @var{x}, sorted in ascending order.
##
## If requested, return index vectors @var{i} and @var{j} such that
## @code{x(i)==y} and @code{y(j)==x}.
##
## Additionally, if @var{i} is a requested output then one of @qcode{"first"} or
## @qcode{"last"} may be given as an input. If @qcode{"last"} is specified,
## return the highest possible indices in @var{i}, otherwise, if @qcode{"first"}
## is specified, return the lowest. The default is @qcode{"last"}.
## @seealso{union, intersect, setdiff, setxor, ismember}
## @end deftypefn
function [y, i, j] = unique (x, varargin)
if (nargin < 1)
print_usage ();
endif
if (nargin > 1)
## parse options
if (iscellstr (varargin))
optfirst = strcmp ("first", varargin);
optlast = strcmp ("last", varargin);
optrows = strcmp ("rows", varargin);
if (! all (optfirst | optlast | optrows))
error ("unique: invalid option");
endif
optfirst = any (optfirst);
optlast = any (optlast);
optrows = any (optrows);
if (optfirst && optlast)
error ('unique: cannot specify both "last" and "first"');
endif
else
error ("unique: options must be strings");
endif
if (optrows && iscell (x))
warning ('unique: "rows" is ignored for cell arrays');
optrows = false;
endif
else
optfirst = false;
optrows = false;
endif
## FIXME -- the operations
##
## match = (y(1:n-1) == y(2:n));
## y(idx) = [];
##
## are very slow on sparse matrices. Until they are fixed to be as
## fast as for full matrices, operate on the nonzero elements of the
## sparse array as long as we are not operating on rows.
if (issparse (x) && ! optrows && nargout <= 1)
if (nnz (x) < numel (x))
y = unique ([0; (full (nonzeros (x)))], varargin{:});
else
## Corner case where sparse matrix is actually full
y = unique (full (x), varargin{:});
endif
return;
endif
if (optrows)
n = rows (x);
dim = 1;
else
n = numel (x);
dim = (rows (x) == 1) + 1;
endif
y = x;
## Special cases 0 and 1
if (n == 0)
if (! optrows && isempty (x) && any (size (x)))
if (iscell (y))
y = cell (0, 1);
else
y = zeros (0, 1, class (y));
endif
endif
i = j = [];
return;
elseif (n == 1)
i = j = 1;
return;
endif
if (optrows)
if (nargout > 1)
[y, i] = sortrows (y);
else
y = sortrows (y);
endif
match = all (y(1:n-1,:) == y(2:n,:), 2);
idx = find (match);
y(idx,:) = [];
else
if (! isvector (y))
y = y(:);
endif
if (nargout > 1)
[y, i] = sort (y);
else
y = sort (y);
endif
if (iscell (y))
match = strcmp (y(1:n-1), y(2:n));
else
match = (y(1:n-1) == y(2:n));
endif
idx = find (match);
y(idx) = [];
endif
if (isargout (3))
j = i;
if (dim == 1)
j(i) = cumsum ([1; !match]);
else
j(i) = cumsum ([1, !match]);
endif
endif
if (isargout (2))
if (optfirst)
i(idx+1) = [];
else
i(idx) = [];
endif
endif
endfunction
%!assert (unique ([1 1 2; 1 2 1; 1 1 2]),[1;2])
%!assert (unique ([1 1 2; 1 0 1; 1 1 2],"rows"),[1 0 1; 1 1 2])
%!assert (unique ([]),[])
%!assert (unique ([1]),[1])
%!assert (unique ([1 2]),[1 2])
%!assert (unique ([1;2]),[1;2])
%!assert (unique ([1,NaN,Inf,NaN,Inf]),[1,Inf,NaN,NaN])
%!assert (unique ({"Foo","Bar","Foo"}),{"Bar","Foo"})
%!assert (unique ({"Foo","Bar","FooBar"}'),{"Bar","Foo","FooBar"}')
%!assert (unique (zeros (1,0)), zeros (0,1))
%!assert (unique (zeros (1,0), "rows"), zeros (1,0))
%!assert (unique (cell (1,0)), cell (0,1))
%!assert (unique ({}), {})
%!assert (unique ([1,2,2,3,2,4], "rows"), [1,2,2,3,2,4])
%!assert (unique ([1,2,2,3,2,4]), [1,2,3,4])
%!assert (unique ([1,2,2,3,2,4]', "rows"), [1,2,3,4]')
%!assert (unique (sparse ([2,0;2,0])), [0,2]')
%!assert (unique (sparse ([1,2;2,3])), [1,2,3]')
%!assert (unique ([1,2,2,3,2,4]', "rows"), [1,2,3,4]')
%!assert (unique (single ([1,2,2,3,2,4]), "rows"), single ([1,2,2,3,2,4]))
%!assert (unique (single ([1,2,2,3,2,4])), single ([1,2,3,4]))
%!assert (unique (single ([1,2,2,3,2,4]'), "rows"), single ([1,2,3,4]'))
%!assert (unique (uint8 ([1,2,2,3,2,4]), "rows"), uint8 ([1,2,2,3,2,4]))
%!assert (unique (uint8 ([1,2,2,3,2,4])), uint8 ([1,2,3,4]))
%!assert (unique (uint8 ([1,2,2,3,2,4]'), "rows"), uint8 ([1,2,3,4]'))
%!test
%! [a,i,j] = unique ([1,1,2,3,3,3,4]);
%! assert (a, [1,2,3,4]);
%! assert (i, [2,3,6,7]);
%! assert (j, [1,1,2,3,3,3,4]);
%!
%!test
%! [a,i,j] = unique ([1,1,2,3,3,3,4]', "first");
%! assert (a, [1,2,3,4]');
%! assert (i, [1,3,4,7]');
%! assert (j, [1,1,2,3,3,3,4]');
%!
%!test
%! [a,i,j] = unique ({"z"; "z"; "z"});
%! assert (a, {"z"});
%! assert (i, [3]');
%! assert (j, [1;1;1]);
%!
%!test
%! A = [1,2,3;1,2,3];
%! [a,i,j] = unique (A, "rows");
%! assert (a, [1,2,3]);
%! assert (A(i,:), a);
%! assert (a(j,:), A);
%!error unique({"a", "b", "c"}, "UnknownOption")
%!error unique({"a", "b", "c"}, "UnknownOption1", "UnknownOption2")
%!error unique({"a", "b", "c"}, "rows", "UnknownOption2")
%!error unique({"a", "b", "c"}, "UnknownOption1", "last")
|