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

annotate scripts/set/union.m @ 20473:e59a44fa74ff

union.m: Matlab compatible output when mixed input and one is empty (bug #45685). * union.m: add BIST tests for mixed cell/matrix inputs. * validasetargs.m: Check for cases of cellstr and empty array and coerce empty array into cellstr.

author	Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
date	Mon, 03 Aug 2015 23:22:14 +0200
parents	c3b2ec6a1586
children

rev	line source
19731 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 19631 diff changeset	1 ## Copyright (C) 1994-2015 John W. Eaton
11523 fd0a3ac60b0e update copyright notices John W. Eaton <jwe@octave.org> parents: 10821 diff changeset	2 ## Copyright (C) 2008-2009 Jaroslav Hajek
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	3 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	4 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	5 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	6 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	7 ## under the terms of the GNU General Public License as published by
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6046 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: 6046 diff changeset	9 ## your option) any later version.
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	10 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	11 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	14 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	15 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 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: 6046 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: 6046 diff changeset	18 ## <http://www.gnu.org/licenses/>.
2303 5cffc4b8de57 [project @ 1996-06-24 09:15:24 by jwe] jwe parents: 904 diff changeset	19
3368 a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 2847 diff changeset	20 ## -- texinfo --
19037 d00f6b09258f Overhaul functions in scripts/set directory. Rik <rik@octave.org> parents: 17744 diff changeset	21 ## @deftypefn {Function File} {@var{c} =} union (@var{a}, @var{b})
d00f6b09258f Overhaul functions in scripts/set directory. Rik <rik@octave.org> parents: 17744 diff changeset	22 ## @deftypefnx {Function File} {@var{c} =} union (@var{a}, @var{b}, "rows")
d00f6b09258f Overhaul functions in scripts/set directory. Rik <rik@octave.org> parents: 17744 diff changeset	23 ## @deftypefnx {Function File} {[@var{c}, @var{ia}, @var{ib}] =} union (@dots{})
16489 36dba9be680b doc: Make documentation compatible with Texinfo 5.0 (bug #38392) Amod Mulay <amodmulay1@gmail.com> parents: 14872 diff changeset	24 ##
20009 72ccbd36e23c Return a column vector by default for Matlab compatibility (bug #44425, bug #44453). Rik <rik@octave.org> parents: 19867 diff changeset	25 ## Return the unique elements that are in either @var{a} or @var{b} sorted in
72ccbd36e23c Return a column vector by default for Matlab compatibility (bug #44425, bug #44453). Rik <rik@octave.org> parents: 19867 diff changeset	26 ## ascending order.
7344 4571f691b0ce [project @ 2008-01-04 18:18:22 by jwe] jwe parents: 7017 diff changeset	27 ##
20009 72ccbd36e23c Return a column vector by default for Matlab compatibility (bug #44425, bug #44453). Rik <rik@octave.org> parents: 19867 diff changeset	28 ## If @var{a} and @var{b} are both row vectors then return a row vector;
72ccbd36e23c Return a column vector by default for Matlab compatibility (bug #44425, bug #44453). Rik <rik@octave.org> parents: 19867 diff changeset	29 ## Otherwise, return a column vector. The inputs may also be cell arrays of
19037 d00f6b09258f Overhaul functions in scripts/set directory. Rik <rik@octave.org> parents: 17744 diff changeset	30 ## strings.
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	31 ##
19037 d00f6b09258f Overhaul functions in scripts/set directory. Rik <rik@octave.org> parents: 17744 diff changeset	32 ## If the optional input @qcode{"rows"} is given then return rows that are in
d00f6b09258f Overhaul functions in scripts/set directory. Rik <rik@octave.org> parents: 17744 diff changeset	33 ## either @var{a} or @var{b}. The inputs must be 2-D matrices to use this
d00f6b09258f Overhaul functions in scripts/set directory. Rik <rik@octave.org> parents: 17744 diff changeset	34 ## option.
19631 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19037 diff changeset	35 ##
19037 d00f6b09258f Overhaul functions in scripts/set directory. Rik <rik@octave.org> parents: 17744 diff changeset	36 ## The optional outputs @var{ia} and @var{ib} are index vectors such that
d00f6b09258f Overhaul functions in scripts/set directory. Rik <rik@octave.org> parents: 17744 diff changeset	37 ## @code{@var{a}(@var{ia})} and @code{@var{b}(@var{ib})} are disjoint sets
d00f6b09258f Overhaul functions in scripts/set directory. Rik <rik@octave.org> parents: 17744 diff changeset	38 ## whose union is @var{c}.
7920 e56bb65186f6 improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7411 diff changeset	39 ##
19037 d00f6b09258f Overhaul functions in scripts/set directory. Rik <rik@octave.org> parents: 17744 diff changeset	40 ## @seealso{unique, intersect, setdiff, setxor, ismember}
3406 772cc0f88f09 [project @ 2000-01-05 20:51:46 by jwe] jwe parents: 3405 diff changeset	41 ## @end deftypefn
3368 a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 2847 diff changeset	42
2314 949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe] jwe parents: 2313 diff changeset	43 ## Author: jwe
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe] jwe parents: 2313 diff changeset	44
7920 e56bb65186f6 improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7411 diff changeset	45 function [y, ia, ib] = union (a, b, varargin)
559 4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	46
7344 4571f691b0ce [project @ 2008-01-04 18:18:22 by jwe] jwe parents: 7017 diff changeset	47 if (nargin < 2 \|\| nargin > 3)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5642 diff changeset	48 print_usage ();
559 4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	49 endif
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	50
19037 d00f6b09258f Overhaul functions in scripts/set directory. Rik <rik@octave.org> parents: 17744 diff changeset	51 [a, b] = validsetargs ("union", a, b, varargin{:});
d00f6b09258f Overhaul functions in scripts/set directory. Rik <rik@octave.org> parents: 17744 diff changeset	52
d00f6b09258f Overhaul functions in scripts/set directory. Rik <rik@octave.org> parents: 17744 diff changeset	53 by_rows = nargin == 3;
20472 c3b2ec6a1586 Remove redundant isvector() calls in set/ functions. Rik <rik@octave.org> parents: 20456 diff changeset	54 isrowvec = isrow (a) && isrow (b);
7344 4571f691b0ce [project @ 2008-01-04 18:18:22 by jwe] jwe parents: 7017 diff changeset	55
19037 d00f6b09258f Overhaul functions in scripts/set directory. Rik <rik@octave.org> parents: 17744 diff changeset	56 if (by_rows)
d00f6b09258f Overhaul functions in scripts/set directory. Rik <rik@octave.org> parents: 17744 diff changeset	57 y = [a; b];
d00f6b09258f Overhaul functions in scripts/set directory. Rik <rik@octave.org> parents: 17744 diff changeset	58 else
7920 e56bb65186f6 improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7411 diff changeset	59 y = [a(:); b(:)];
19037 d00f6b09258f Overhaul functions in scripts/set directory. Rik <rik@octave.org> parents: 17744 diff changeset	60 ## Adjust output orientation for Matlab compatibility
20009 72ccbd36e23c Return a column vector by default for Matlab compatibility (bug #44425, bug #44453). Rik <rik@octave.org> parents: 19867 diff changeset	61 if (isrowvec)
7920 e56bb65186f6 improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7411 diff changeset	62 y = y.';
4317 1ced186d4b6b [project @ 2003-02-11 16:10:09 by jwe] jwe parents: 3426 diff changeset	63 endif
559 4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	64 endif
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	65
19037 d00f6b09258f Overhaul functions in scripts/set directory. Rik <rik@octave.org> parents: 17744 diff changeset	66 if (nargout <= 1)
7920 e56bb65186f6 improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7411 diff changeset	67 y = unique (y, varargin{:});
e56bb65186f6 improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7411 diff changeset	68 else
19037 d00f6b09258f Overhaul functions in scripts/set directory. Rik <rik@octave.org> parents: 17744 diff changeset	69 [y, idx] = unique (y, varargin{:});
d00f6b09258f Overhaul functions in scripts/set directory. Rik <rik@octave.org> parents: 17744 diff changeset	70 na = numel (a);
d00f6b09258f Overhaul functions in scripts/set directory. Rik <rik@octave.org> parents: 17744 diff changeset	71 ia = idx(idx <= na);
d00f6b09258f Overhaul functions in scripts/set directory. Rik <rik@octave.org> parents: 17744 diff changeset	72 ib = idx(idx > na) - na;
7920 e56bb65186f6 improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7411 diff changeset	73 endif
e56bb65186f6 improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7411 diff changeset	74
559 4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	75 endfunction
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7344 diff changeset	76
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7344 diff changeset	77
19037 d00f6b09258f Overhaul functions in scripts/set directory. Rik <rik@octave.org> parents: 17744 diff changeset	78 %!assert (union ([1, 2, 4], [2, 3, 5]), [1, 2, 3, 4, 5])
20009 72ccbd36e23c Return a column vector by default for Matlab compatibility (bug #44425, bug #44453). Rik <rik@octave.org> parents: 19867 diff changeset	79 %!assert (union ([1; 2; 4], [2, 3, 5]), [1; 2; 3; 4; 5])
19037 d00f6b09258f Overhaul functions in scripts/set directory. Rik <rik@octave.org> parents: 17744 diff changeset	80 %!assert (union ([1; 2; 4], [2; 3; 5]), [1; 2; 3; 4; 5])
20009 72ccbd36e23c Return a column vector by default for Matlab compatibility (bug #44425, bug #44453). Rik <rik@octave.org> parents: 19867 diff changeset	81 %!assert (union ([1, 2, 3], [5; 7; 9]), [1; 2; 3; 5; 7; 9])
19037 d00f6b09258f Overhaul functions in scripts/set directory. Rik <rik@octave.org> parents: 17744 diff changeset	82
d00f6b09258f Overhaul functions in scripts/set directory. Rik <rik@octave.org> parents: 17744 diff changeset	83 ## Test multi-dimensional arrays
d00f6b09258f Overhaul functions in scripts/set directory. Rik <rik@octave.org> parents: 17744 diff changeset	84 %!test
d00f6b09258f Overhaul functions in scripts/set directory. Rik <rik@octave.org> parents: 17744 diff changeset	85 %! a = rand (3,3,3);
d00f6b09258f Overhaul functions in scripts/set directory. Rik <rik@octave.org> parents: 17744 diff changeset	86 %! b = a;
d00f6b09258f Overhaul functions in scripts/set directory. Rik <rik@octave.org> parents: 17744 diff changeset	87 %! b(1,1,1) = 2;
20009 72ccbd36e23c Return a column vector by default for Matlab compatibility (bug #44425, bug #44453). Rik <rik@octave.org> parents: 19867 diff changeset	88 %! assert (union (a, b), sort ([a(1:end)'; 2]));
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7344 diff changeset	89
7920 e56bb65186f6 improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7411 diff changeset	90 %!test
19631 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19037 diff changeset	91 %! a = [3, 1, 4, 1, 5];
19037 d00f6b09258f Overhaul functions in scripts/set directory. Rik <rik@octave.org> parents: 17744 diff changeset	92 %! b = [1, 2, 3, 4];
7920 e56bb65186f6 improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7411 diff changeset	93 %! [y, ia, ib] = union (a, b.');
20009 72ccbd36e23c Return a column vector by default for Matlab compatibility (bug #44425, bug #44453). Rik <rik@octave.org> parents: 19867 diff changeset	94 %! assert (y, [1; 2; 3; 4; 5]);
72ccbd36e23c Return a column vector by default for Matlab compatibility (bug #44425, bug #44453). Rik <rik@octave.org> parents: 19867 diff changeset	95 %! assert (y, sort ([a(ia)'; b(ib)']));
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	96
20473 e59a44fa74ff union.m: Matlab compatible output when mixed input and one is empty (bug #45685). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: 20472 diff changeset	97 ## Test empty cell string array unions
e59a44fa74ff union.m: Matlab compatible output when mixed input and one is empty (bug #45685). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: 20472 diff changeset	98 %!assert (union ({}, []), cell (0,1))
e59a44fa74ff union.m: Matlab compatible output when mixed input and one is empty (bug #45685). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: 20472 diff changeset	99 %!assert (union ([], {}), cell (0,1))
e59a44fa74ff union.m: Matlab compatible output when mixed input and one is empty (bug #45685). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: 20472 diff changeset	100 %!assert (union ([], {'a', 'b'}), {'a';'b'})
e59a44fa74ff union.m: Matlab compatible output when mixed input and one is empty (bug #45685). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: 20472 diff changeset	101 %!assert (union ({'a', 'b'}, []), {'a';'b'})
e59a44fa74ff union.m: Matlab compatible output when mixed input and one is empty (bug #45685). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: 20472 diff changeset	102 %!assert (union (['a', 'b'], {}), {'ab'})
e59a44fa74ff union.m: Matlab compatible output when mixed input and one is empty (bug #45685). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: 20472 diff changeset	103 %!assert (union ({}, ['a', 'b']), {'ab'})
e59a44fa74ff union.m: Matlab compatible output when mixed input and one is empty (bug #45685). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: 20472 diff changeset	104
19867 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19731 diff changeset	105 ## Test common input validation for set routines contained in validsetargs
19037 d00f6b09258f Overhaul functions in scripts/set directory. Rik <rik@octave.org> parents: 17744 diff changeset	106 %!error <cell array of strings cannot be combined> union ({"a"}, 1)
d00f6b09258f Overhaul functions in scripts/set directory. Rik <rik@octave.org> parents: 17744 diff changeset	107 %!error <A and B must be arrays or cell arrays> union (@sin, 1)
d00f6b09258f Overhaul functions in scripts/set directory. Rik <rik@octave.org> parents: 17744 diff changeset	108 %!error <invalid option: columns> union (1, 2, "columns")
d00f6b09258f Overhaul functions in scripts/set directory. Rik <rik@octave.org> parents: 17744 diff changeset	109 %!error <cells not supported with "rows"> union ({"a"}, {"b"}, "rows")
d00f6b09258f Overhaul functions in scripts/set directory. Rik <rik@octave.org> parents: 17744 diff changeset	110 %!error <A and B must be arrays or cell arrays> union (@sin, 1, "rows")
d00f6b09258f Overhaul functions in scripts/set directory. Rik <rik@octave.org> parents: 17744 diff changeset	111 %!error <A and B must be 2-dimensional matrices> union (rand(2,2,2), 1, "rows")
d00f6b09258f Overhaul functions in scripts/set directory. Rik <rik@octave.org> parents: 17744 diff changeset	112 %!error <number of columns in A and B must match> union ([1 2], 1, "rows")
20456 6dc15d4cc17e Backout cset 2edd668e7784 and return column orientation for union.m. Rik <rik@octave.org> parents: 20448 diff changeset	113

Mercurial > octave-nkf

annotate scripts/set/union.m @ 20473:e59a44fa74ff