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

annotate scripts/set/union.m @ 16033:23a7661e529a ss-3-7-2

snapshot version 3.7.2 * configure.ac (AC_INIT): Set version to 3.7.2. (OCTAVE_RELEASE_DATE): Set to 2013-02-09. (OCTAVE_COPYRIGHT): Update year.

author	John W. Eaton <jwe@octave.org>
date	Sun, 10 Feb 2013 00:59:19 -0500
parents	c2dbdeaa25df
children	36dba9be680b

rev	line source
14138 72c96de7a403 maint: update copyright notices for 2012 John W. Eaton <jwe@octave.org> parents: 11587 diff changeset	1 ## Copyright (C) 1994-2012 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 --
10793 be55736a0783 Grammarcheck the documentation from m-files. Rik <octave@nomad.inbox5.com> parents: 10712 diff changeset	21 ## @deftypefn {Function File} {} union (@var{a}, @var{b})
be55736a0783 Grammarcheck the documentation from m-files. Rik <octave@nomad.inbox5.com> parents: 10712 diff changeset	22 ## @deftypefnx {Function File} {} union (@var{a}, @var{b}, "rows")
7920 e56bb65186f6 improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7411 diff changeset	23 ## Return the set of elements that are in either of the sets @var{a} and
10711 fbd7843974fa Periodic grammar check of documentation files to ensure common format. Rik <octave@nomad.inbox5.com> parents: 10088 diff changeset	24 ## @var{b}. @var{a}, @var{b} may be cell arrays of string(s).
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	25 ## For example:
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3406 diff changeset	26 ##
3368 a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 2847 diff changeset	27 ## @example
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 2847 diff changeset	28 ## @group
7344 4571f691b0ce [project @ 2008-01-04 18:18:22 by jwe] jwe parents: 7017 diff changeset	29 ## union ([1, 2, 4], [2, 3, 5])
14327 4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	30 ## @result{} [1, 2, 3, 4, 5]
7344 4571f691b0ce [project @ 2008-01-04 18:18:22 by jwe] jwe parents: 7017 diff changeset	31 ## @end group
4571f691b0ce [project @ 2008-01-04 18:18:22 by jwe] jwe parents: 7017 diff changeset	32 ## @end example
4571f691b0ce [project @ 2008-01-04 18:18:22 by jwe] jwe parents: 7017 diff changeset	33 ##
4571f691b0ce [project @ 2008-01-04 18:18:22 by jwe] jwe parents: 7017 diff changeset	34 ## If the optional third input argument is the string "rows" each row of
7920 e56bb65186f6 improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7411 diff changeset	35 ## the matrices @var{a} and @var{b} will be considered an element of sets.
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	36 ## For example:
693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	37 ##
7344 4571f691b0ce [project @ 2008-01-04 18:18:22 by jwe] jwe parents: 7017 diff changeset	38 ## @example
4571f691b0ce [project @ 2008-01-04 18:18:22 by jwe] jwe parents: 7017 diff changeset	39 ## @group
14327 4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	40 ## union ([1, 2; 2, 3], [1, 2; 3, 4], "rows")
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	41 ## @result{} 1 2
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	42 ## 2 3
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	43 ## 3 4
3368 a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 2847 diff changeset	44 ## @end group
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 2847 diff changeset	45 ## @end example
7920 e56bb65186f6 improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7411 diff changeset	46 ##
e56bb65186f6 improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7411 diff changeset	47 ## @deftypefnx {Function File} {[@var{c}, @var{ia}, @var{ib}] =} union (@var{a}, @var{b})
e56bb65186f6 improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7411 diff changeset	48 ##
10793 be55736a0783 Grammarcheck the documentation from m-files. Rik <octave@nomad.inbox5.com> parents: 10712 diff changeset	49 ## Return index vectors @var{ia} and @var{ib} such that @code{a(ia)} and
14327 4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	50 ## @code{b(ib)} are disjoint sets whose union is @var{c}.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	51 ##
10712 6a5a0c9df5d7 union.m: Remove seealso reference to deprecated function. Rik <octave@nomad.inbox5.com> parents: 10711 diff changeset	52 ## @seealso{intersect, setdiff, unique}
3406 772cc0f88f09 [project @ 2000-01-05 20:51:46 by jwe] jwe parents: 3405 diff changeset	53 ## @end deftypefn
3368 a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 2847 diff changeset	54
2314 949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe] jwe parents: 2313 diff changeset	55 ## Author: jwe
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe] jwe parents: 2313 diff changeset	56
7920 e56bb65186f6 improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7411 diff changeset	57 function [y, ia, ib] = union (a, b, varargin)
559 4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	58
7344 4571f691b0ce [project @ 2008-01-04 18:18:22 by jwe] jwe parents: 7017 diff changeset	59 if (nargin < 2 \|\| nargin > 3)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5642 diff changeset	60 print_usage ();
559 4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	61 endif
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	62
10088 5edee330d4cb better argument checking and handling in set functions Jaroslav Hajek <highegg@gmail.com> parents: 9659 diff changeset	63 [a, b] = validargs ("union", a, b, varargin{:});
7344 4571f691b0ce [project @ 2008-01-04 18:18:22 by jwe] jwe parents: 7017 diff changeset	64
7920 e56bb65186f6 improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7411 diff changeset	65 if (nargin == 2)
e56bb65186f6 improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7411 diff changeset	66 y = [a(:); b(:)];
e56bb65186f6 improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7411 diff changeset	67 na = numel (a); nb = numel (b);
14872 c2dbdeaa25df maint: use rows() and columns() to clarify m-files. Rik <octave@nomad.inbox5.com> parents: 14363 diff changeset	68 if (rows (a) == 1 \|\| rows (b) == 1)
7920 e56bb65186f6 improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7411 diff changeset	69 y = y.';
4317 1ced186d4b6b [project @ 2003-02-11 16:10:09 by jwe] jwe parents: 3426 diff changeset	70 endif
10088 5edee330d4cb better argument checking and handling in set functions Jaroslav Hajek <highegg@gmail.com> parents: 9659 diff changeset	71 else
7920 e56bb65186f6 improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7411 diff changeset	72 y = [a; b];
e56bb65186f6 improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7411 diff changeset	73 na = rows (a); nb = rows (b);
559 4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	74 endif
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	75
7920 e56bb65186f6 improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7411 diff changeset	76 if (nargout == 1)
e56bb65186f6 improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7411 diff changeset	77 y = unique (y, varargin{:});
e56bb65186f6 improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7411 diff changeset	78 else
e56bb65186f6 improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7411 diff changeset	79 [y, i] = unique (y, varargin{:});
e56bb65186f6 improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7411 diff changeset	80 ia = i(i <= na);
e56bb65186f6 improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7411 diff changeset	81 ib = i(i > na) - na;
e56bb65186f6 improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7411 diff changeset	82 endif
e56bb65186f6 improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7411 diff changeset	83
559 4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	84 endfunction
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7344 diff changeset	85
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7344 diff changeset	86
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	87 %!assert (union ([1, 2, 4], [2, 3, 5]), [1, 2, 3, 4, 5]);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	88 %!assert (union ([1; 2; 4], [2, 3, 5]), [1, 2, 3, 4, 5]);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	89 %!assert (union ([1, 2, 3], [5; 7; 9]), [1, 2, 3, 5, 7, 9]);
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7344 diff changeset	90
7920 e56bb65186f6 improve set functions for Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 7411 diff changeset	91 %!test
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	92 %! a = [3, 1, 4, 1, 5]; 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.');
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	94 %! assert (y, [1, 2, 3, 4, 5]);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	95 %! assert (y, sort ([a(ia), b(ib)]));
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	96
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	97 %!error union (1)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	98 %!error union (1, 2, 3)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	99

Mercurial > octave-nkf

annotate scripts/set/union.m @ 16033:23a7661e529a ss-3-7-2