Mercurial > octave-dspies
diff 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 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/scripts/set/private/validsetargs.m Mon Aug 11 09:39:45 2014 -0700 @@ -0,0 +1,59 @@ +## Copyright (C) 2000-2013 Paul Kienzle +## Copyright (C) 2009-2010 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/>. + +## Validate arguments for binary set operation. + +function [x, y] = validsetargs (caller, x, y, byrows_arg) + + if (nargin == 3) + icx = iscellstr (x); + icy = iscellstr (y); + if (icx || icy) + if (icx && ischar (y)) + y = cellstr (y); + elseif (icy && ischar (x)) + x = cellstr (x); + elseif (! (icx && icy)) + error ("%s: cell array of strings cannot be combined with a nonstring value", caller); + endif + elseif (! (ismatrix (x) && ismatrix (y))) + error ("%s: A and B must be arrays or cell arrays of strings", caller); + endif + elseif (nargin == 4) + if (! strcmpi (byrows_arg, "rows")) + error ("%s: invalid option: %s", caller, byrows_arg); + endif + + if (iscell (x) || iscell (y)) + error ('%s: cells not supported with "rows"', caller); + elseif (! (ismatrix (x) && ismatrix (y))) + error ("%s: A and B must be arrays or cell arrays of strings", caller); + else + if (ndims (x) > 2 || ndims (y) > 2) + error ('%s: A and B must be 2-dimensional matrices for "rows"', caller); + elseif (columns (x) != columns (y) && ! (isempty (x) || isempty (y))) + error ("%s: number of columns in A and B must match", caller); + endif + endif + endif + +endfunction + + +## %!tests for function are in union.m