home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / octa21fb.zip / octave / SCRIPTS.ZIP / scripts / general / nargchk.m < prev    next >
Encoding:
Text File  |  1999-11-21  |  1.6 KB  |  51 lines
  1. ## Copyright (C) 1996, 1997 John W. Eaton
  2. ##
  3. ## This file is part of Octave.
  4. ##
  5. ## Octave is free software; you can redistribute it and/or modify it
  6. ## under the terms of the GNU General Public License as published by
  7. ## the Free Software Foundation; either version 2, or (at your option)
  8. ## any later version.
  9. ##
  10. ## Octave is distributed in the hope that it will be useful, but
  11. ## WITHOUT ANY WARRANTY; without even the implied warranty of
  12. ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13. ## General Public License for more details.
  14. ##
  15. ## You should have received a copy of the GNU General Public License
  16. ## along with Octave; see the file COPYING.  If not, write to the Free
  17. ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  18. ## 02111-1307, USA.
  19.  
  20. ## -*- texinfo -*-
  21. ## @deftypefn {Function File} {} nargchk (@var{nargin_min}, @var{nargin_max}, @var{n})
  22. ## If @var{n} is in the range @var{nargin_min} through @var{nargin_max}
  23. ## inclusive, return the empty matrix.  Otherwise, return a message
  24. ## indicating whether @var{n} is too large or too small.
  25. ## 
  26. ## This is useful for checking to see that the number of arguments supplied
  27. ## to a function is within an acceptable range.
  28. ## @end deftypefn
  29.  
  30. ## Author: jwe
  31.  
  32. function retval = nargchk (nargin_min, nargin_max, n)
  33.  
  34.   if (nargin != 3)
  35.     usage ("nargchk (nargin_min, nargin_max, n)");
  36.   endif
  37.  
  38.   if (nargin_min > nargin_max)
  39.     error  ("nargchk: nargin_min > nargin_max");
  40.   endif
  41.  
  42.   if (n < nargin_min)
  43.     retval = "nargchk: N is less than nargin_min";
  44.   elseif (n > nargin_max)
  45.     retval = "nargchk: N is greater than nargin_max";
  46.   else
  47.     retval = [];
  48.   endif
  49.  
  50. endfunction
  51.