octave-nkf: scripts/set/unique.m annotate

annotate scripts/set/unique.m @ 11922:746f13936eee release-3-0-x

improve set functions for Matlab compatibility

author	Jaroslav Hajek <highegg@gmail.com>
date	Fri, 16 Jan 2009 08:10:28 +0100
parents	a1dbe9d80eee
children	304855b33b67

rev	line source
7017 a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe] jwe parents: 7016 diff changeset	1 ## Copyright (C) 2000, 2001, 2005, 2006, 2007 Paul Kienzle
11922 746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	2 ## Copyright (C) 2008 Jaroslav Hajek
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6609 diff changeset	3 ##
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6609 diff changeset	4 ## This file is part of Octave.
5165 b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	5 ##
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6609 diff changeset	6 ## Octave is free software; you can redistribute it and/or modify it
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6609 diff changeset	7 ## under the terms of the GNU General Public License as published by
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6609 diff changeset	8 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6609 diff changeset	9 ## your option) any later version.
5165 b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	10 ##
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6609 diff changeset	11 ## Octave is distributed in the hope that it will be useful, but
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6609 diff changeset	12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6609 diff changeset	13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6609 diff changeset	14 ## General Public License for more details.
5165 b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	15 ##
b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	16 ## You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6609 diff changeset	17 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6609 diff changeset	18 ## <http://www.gnu.org/licenses/>.
5165 b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	19
b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	20 ## -- texinfo --
b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	21 ## @deftypefn {Function File} {} unique (@var{x})
b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	22 ##
b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	23 ## Return the unique elements of @var{x}, sorted in ascending order.
b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	24 ## If @var{x} is a row vector, return a row vector, but if @var{x}
b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	25 ## is a column vector or a matrix return a column vector.
b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	26 ##
b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	27 ## @deftypefnx {Function File} {} unique (@var{A}, 'rows')
b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	28 ##
b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	29 ## Return the unique rows of @var{A}, sorted in ascending order.
b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	30 ##
b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	31 ## @deftypefnx {Function File} {[@var{y}, @var{i}, @var{j}] = } unique (@var{x})
b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	32 ##
b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	33 ## Return index vectors @var{i} and @var{j} such that @code{x(i)==y} and
5532 8ad54ce6a831 [project @ 2005-11-07 20:15:23 by jwe] jwe parents: 5443 diff changeset	34 ## @code{y(j)==x}.
11922 746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	35 ##
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	36 ## Additionally, one of 'first' or 'last' can be given as an argument.
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	37 ## 'last' (default) specifies that the highest possible indices are returned
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	38 ## in @var{i}, while 'first' means the lowest.
5642 2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5532 diff changeset	39 ## @seealso{union, intersect, setdiff, setxor, ismember}
5165 b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	40 ## @end deftypefn
b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	41
11922 746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	42 function [y, i, j] = unique (x, varargin)
5165 b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	43
11922 746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	44 if (nargin < 1)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5737 diff changeset	45 print_usage ();
5165 b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	46 endif
b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	47
11922 746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	48 ## parse options
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	49 if (iscellstr (varargin))
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	50 optfirst = strmatch ('first', varargin) > 0;
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	51 optlast = strmatch ('last', varargin) > 0;
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	52 optrows = strmatch ('rows', varargin) > 0 && size (x, 2) > 1;
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	53 if (optfirst && optlast)
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	54 error ("unique: cannot specify both 'last' and 'first'.");
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	55 elseif (optfirst + optlast + optrows != nargin-1)
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	56 error ("unique: invalid option.");
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	57 endif
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	58 optlast = ! optfirst;
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	59 else
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	60 error ("unique: options must be strings");
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	61 endif
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	62
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	63 if (iscell (x))
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	64 if (optrows)
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	65 warning ("unique: 'rows' is ignored for cell arrays");
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	66 optrows = false;
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	67 endif
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	68 endif
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	69
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	70 if (optrows)
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	71 n = size (x, 1);
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	72 else
6609 30891d1d0c86 [project @ 2007-05-09 02:12:04 by jwe] jwe parents: 6046 diff changeset	73 n = numel (x);
5165 b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	74 endif
b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	75
5168 912058eb8360 [project @ 2005-02-28 03:23:36 by jwe] jwe parents: 5165 diff changeset	76 y = x;
5165 b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	77 if (n < 1)
b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	78 i = j = [];
5168 912058eb8360 [project @ 2005-02-28 03:23:36 by jwe] jwe parents: 5165 diff changeset	79 return;
5165 b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	80 elseif (n < 2)
b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	81 i = j = 1;
5168 912058eb8360 [project @ 2005-02-28 03:23:36 by jwe] jwe parents: 5165 diff changeset	82 return;
5165 b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	83 endif
b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	84
11922 746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	85 if (optrows)
5168 912058eb8360 [project @ 2005-02-28 03:23:36 by jwe] jwe parents: 5165 diff changeset	86 [y, i] = sortrows (y);
11922 746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	87 match = all (y(1:n-1,:) == y(2:n,:), 2);
5165 b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	88 idx = find (match);
5168 912058eb8360 [project @ 2005-02-28 03:23:36 by jwe] jwe parents: 5165 diff changeset	89 y(idx,:) = [];
5165 b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	90 else
5168 912058eb8360 [project @ 2005-02-28 03:23:36 by jwe] jwe parents: 5165 diff changeset	91 if (size (y, 1) != 1)
912058eb8360 [project @ 2005-02-28 03:23:36 by jwe] jwe parents: 5165 diff changeset	92 y = y(:);
912058eb8360 [project @ 2005-02-28 03:23:36 by jwe] jwe parents: 5165 diff changeset	93 endif
912058eb8360 [project @ 2005-02-28 03:23:36 by jwe] jwe parents: 5165 diff changeset	94 [y, i] = sort (y);
5205 59592dcbb5d8 [project @ 2005-03-15 16:04:56 by jwe] jwe parents: 5168 diff changeset	95 if (iscell (y))
11922 746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	96 match = strcmp (y(1:n-1), y(2:n));
5205 59592dcbb5d8 [project @ 2005-03-15 16:04:56 by jwe] jwe parents: 5168 diff changeset	97 else
11922 746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	98 match = (y(1:n-1) == y(2:n));
5205 59592dcbb5d8 [project @ 2005-03-15 16:04:56 by jwe] jwe parents: 5168 diff changeset	99 endif
5165 b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	100 idx = find (match);
5168 912058eb8360 [project @ 2005-02-28 03:23:36 by jwe] jwe parents: 5165 diff changeset	101 y(idx) = [];
5165 b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	102 endif
b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	103
b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	104 ## I don't know why anyone would need reverse indices, but it
b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	105 ## was an interesting challenge. I welcome cleaner solutions.
b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	106 if (nargout >= 3)
b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	107 j = i;
5168 912058eb8360 [project @ 2005-02-28 03:23:36 by jwe] jwe parents: 5165 diff changeset	108 j(i) = cumsum (prepad (! match, n, 1));
5165 b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	109 endif
11922 746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	110 if (optfirst)
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	111 i(idx+1) = [];
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	112 else
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	113 i(idx) = [];
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	114 endif
5165 b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	115
b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	116
b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	117 endfunction
b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	118
b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	119 %!assert(unique([1 1 2; 1 2 1; 1 1 2]),[1;2])
b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	120 %!assert(unique([1 1 2; 1 0 1; 1 1 2],'rows'),[1 0 1; 1 1 2])
b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	121 %!assert(unique([]),[])
b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	122 %!assert(unique([1]),[1])
b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	123 %!assert(unique([1 2]),[1 2])
b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	124 %!assert(unique([1;2]),[1;2])
b822b4895af2 [project @ 2005-02-27 20:51:35 by dbateman] dbateman parents: diff changeset	125 %!assert(unique([1,NaN,Inf,NaN,Inf]),[1,Inf,NaN,NaN])
5205 59592dcbb5d8 [project @ 2005-03-15 16:04:56 by jwe] jwe parents: 5168 diff changeset	126 %!assert(unique({'Foo','Bar','Foo'}),{'Bar','Foo'})
59592dcbb5d8 [project @ 2005-03-15 16:04:56 by jwe] jwe parents: 5168 diff changeset	127 %!assert(unique({'Foo','Bar','FooBar'}),{'Bar','Foo','FooBar'})
11922 746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	128
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	129 %!test
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	130 %! [a,i,j] = unique([1,1,2,3,3,3,4]);
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	131 %! assert(a,[1,2,3,4])
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	132 %! assert(i,[2,3,6,7])
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	133 %! assert(j,[1,1,2,3,3,3,4])
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	134 %!
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	135 %!test
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	136 %! [a,i,j] = unique([1,1,2,3,3,3,4],'first');
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	137 %! assert(a,[1,2,3,4])
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	138 %! assert(i,[1,3,4,7])
746f13936eee improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	139 %! assert(j,[1,1,2,3,3,3,4])

Mercurial > octave-nkf

annotate scripts/set/unique.m @ 11922:746f13936eee release-3-0-x