Mercurial > octave-libtiff
view scripts/miscellaneous/nargchk.m @ 30564:796f54d4ddbf stable
update Octave Project Developers copyright for the new year
In files that have the "Octave Project Developers" copyright notice,
update for 2021.
In all .txi and .texi files except gpl.txi and gpl.texi in the
doc/liboctave and doc/interpreter directories, change the copyright
to "Octave Project Developers", the same as used for other source
files. Update copyright notices for 2022 (not done since 2019). For
gpl.txi and gpl.texi, change the copyright notice to be "Free Software
Foundation, Inc." and leave the date at 2007 only because this file
only contains the text of the GPL, not anything created by the Octave
Project Developers.
Add Paul Thomas to contributors.in.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Tue, 28 Dec 2021 18:22:40 -0500 |
parents | 7854d5752dd2 |
children |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2008-2022 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## 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 ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {@var{msgstr} =} nargchk (@var{minargs}, @var{maxargs}, @var{nargs}) ## @deftypefnx {} {@var{msgstr} =} nargchk (@var{minargs}, @var{maxargs}, @var{nargs}, "string") ## @deftypefnx {} {@var{msgstruct} =} nargchk (@var{minargs}, @var{maxargs}, @var{nargs}, "struct") ## Return an appropriate error message string (or structure) if the number of ## inputs requested is invalid. ## ## This is useful for checking to see that the number of input arguments ## supplied to a function is within an acceptable range. ## ## @strong{Caution}: @code{nargchk} is scheduled for deprecation. Use ## @code{narginchk} in all new code. ## @seealso{narginchk, nargoutchk, error, nargin, nargout} ## @end deftypefn function msg = nargchk (minargs, maxargs, nargs, outtype = "string") if (nargin < 3) print_usage (); elseif (minargs > maxargs) error ("nargchk: MINARGS must be <= MAXARGS"); elseif (! any (strcmpi (outtype, {"string", "struct"}))) error ('nargchk: output type must be either "string" or "struct"'); elseif (! (isscalar (minargs) && isscalar (maxargs) && isscalar (nargs))) error ("nargchk: MINARGS, MAXARGS, and NARGS must be scalars"); endif msg = struct ("message", "", "identifier", ""); if (nargs < minargs) msg.message = "not enough input arguments"; msg.identifier = "Octave:nargchk:not-enough-inputs"; elseif (nargs > maxargs) msg.message = "too many input arguments"; msg.identifier = "Octave:nargchk:too-many-inputs"; endif if (strcmpi (outtype, "string")) msg = msg.message; elseif (isempty (msg.message)) ## Compatibility: Matlab returns a 0x1 empty struct when nargchk passes msg = resize (msg, 0, 1); endif endfunction ## Tests %!shared stnul, stmin, stmax %! stnul = resize (struct ("message", "", "identifier", ""), 0, 1); %! stmin = struct ("message", "not enough input arguments", %! "identifier", "Octave:nargchk:not-enough-inputs"); %! stmax = struct ("message", "too many input arguments", %! "identifier", "Octave:nargchk:too-many-inputs"); %!assert (nargchk (0, 1, 0), "") %!assert (nargchk (0, 1, 1), "") %!assert (nargchk (1, 1, 0), "not enough input arguments") %!assert (nargchk (0, 1, 2), "too many input arguments") %!assert (nargchk (0, 1, 2, "string"), "too many input arguments") ## Struct outputs %!assert (nargchk (0, 1, 0, "struct"), stnul) %!assert (nargchk (0, 1, 1, "struct"), stnul) %!assert (nargchk (1, 1, 0, "struct"), stmin) %!assert (nargchk (0, 1, 2, "struct"), stmax)