comparison scripts/set/private/validsetargs.m @ 19003:d00f6b09258f @

Overhaul functions in scripts/set directory. * set.txi: Rewrite documentation for set functions. * intersect.m: Rewrite docstring. Use by_rows variable for code clarity. Return output orientation which is compatible with Matlab. Add %!tests for output orientation and N-dimensional inputs. * setdiff.m: Rewrite docstring. Use by_rows variable for code clarity. Rename output i to ia to clarify it is an index into the set a. Return output orientation which is compatible with Matlab. Add %!tests for N-dimensional inputs. * setxor.m: Rewrite docstring. Use by_rows variable for code clarity. Return output orientation which is compatible with Matlab. Add %!tests for output orientation and N-dimensional inputs. * union.m: Rewrite docstring. Use by_rows variable for code clarity. Return output orientation which is compatible with Matlab. Add %!tests for output orientation and N-dimensional inputs. Add %!tests for validsetargs which are common to all set functions. * unique.m: Rewrite docstring. Verify that input is numeric or cell array of strings. Avoid computing idx for optional i,j outputs unless required. Add %!error tests for input validation. * ismember.m: Rewrite docstring. Use input variable 'a' instead of 'A' for conformance with rest of set functions. Rename output index variable to s_idx for clarity that it is an index into the set s. * powerset.m: Rewrite doctring. Add input validation on nargin. Add %!error input validation tests. * module.mk: Include validsetargs.m in build system. * validsetargs.m: Function renamed from validargs which was too general. * validargs.m: Function renamed to validsetargs.
author Rik <rik@octave.org>
date Mon, 11 Aug 2014 09:39:45 -0700
parents scripts/set/private/validargs.m@d63878346099
children
comparison
equal deleted inserted replaced
19001:391e080ae810 19003:d00f6b09258f
1 ## Copyright (C) 2000-2013 Paul Kienzle
2 ## Copyright (C) 2009-2010 Jaroslav Hajek
3 ##
4 ## This file is part of Octave.
5 ##
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
8 ## the Free Software Foundation; either version 3 of the License, or (at
9 ## your option) any later version.
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.
15 ##
16 ## You should have received a copy of the GNU General Public License
17 ## along with Octave; see the file COPYING. If not, see
18 ## <http://www.gnu.org/licenses/>.
19
20 ## Validate arguments for binary set operation.
21
22 function [x, y] = validsetargs (caller, x, y, byrows_arg)
23
24 if (nargin == 3)
25 icx = iscellstr (x);
26 icy = iscellstr (y);
27 if (icx || icy)
28 if (icx && ischar (y))
29 y = cellstr (y);
30 elseif (icy && ischar (x))
31 x = cellstr (x);
32 elseif (! (icx && icy))
33 error ("%s: cell array of strings cannot be combined with a nonstring value", caller);
34 endif
35 elseif (! (ismatrix (x) && ismatrix (y)))
36 error ("%s: A and B must be arrays or cell arrays of strings", caller);
37 endif
38 elseif (nargin == 4)
39 if (! strcmpi (byrows_arg, "rows"))
40 error ("%s: invalid option: %s", caller, byrows_arg);
41 endif
42
43 if (iscell (x) || iscell (y))
44 error ('%s: cells not supported with "rows"', caller);
45 elseif (! (ismatrix (x) && ismatrix (y)))
46 error ("%s: A and B must be arrays or cell arrays of strings", caller);
47 else
48 if (ndims (x) > 2 || ndims (y) > 2)
49 error ('%s: A and B must be 2-dimensional matrices for "rows"', caller);
50 elseif (columns (x) != columns (y) && ! (isempty (x) || isempty (y)))
51 error ("%s: number of columns in A and B must match", caller);
52 endif
53 endif
54 endif
55
56 endfunction
57
58
59 ## %!tests for function are in union.m