Mercurial > hg > octave-nkf
view scripts/general/nargchk.m @ 5915:b2e1be30c8e9 ss-2-9-7
[project @ 2006-07-28 18:08:56 by jwe]
author | jwe |
---|---|
date | Fri, 28 Jul 2006 18:08:56 +0000 |
parents | 4c8a2e4e0717 |
children | 34f96dd5441b |
line wrap: on
line source
## Copyright (C) 1996, 1997 John W. Eaton ## ## 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 2, 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, write to the Free ## Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA ## 02110-1301, USA. ## -*- texinfo -*- ## @deftypefn {Function File} {} nargchk (@var{nargin_min}, @var{nargin_max}, @var{n}) ## If @var{n} is in the range @var{nargin_min} through @var{nargin_max} ## inclusive, return the empty matrix. Otherwise, return a message ## indicating whether @var{n} is too large or too small. ## ## This is useful for checking to see that the number of arguments supplied ## to a function is within an acceptable range. ## @end deftypefn ## Author: jwe function retval = nargchk (nargin_min, nargin_max, n) if (nargin != 3) usage ("nargchk (nargin_min, nargin_max, n)"); endif if (nargin_min > nargin_max) error ("nargchk: nargin_min > nargin_max"); endif if (n < nargin_min) retval = "nargchk: N is less than nargin_min"; elseif (n > nargin_max) retval = "nargchk: N is greater than nargin_max"; else retval = []; endif endfunction