/usr/share/octave/packages/image-2.2.2/iptchecknargin.m is in octave-image 2.2.2-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 | ## Copyright (C) 2011 Carnë Draug <carandraug+dev@gmail.com>
##
## This program 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.
##
## This program 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
## this program; if not, see <http://www.gnu.org/licenses/>.
## -*- texinfo -*-
## @deftypefn {Function File} {} iptchecknargin (@var{low}, @var{high}, @var{in}, @var{func_name})
## Checks for correct number of arguments.
##
## This function has been deprecated. For an exact replacement, use
## @code{narginchk (@var{low}, @var{high})} instead. Alternatively,
## @code{print_usage} is able to provide an even better error message
## provided that there is documentation for the function:
##
## @example
## @group
## if (nargin < min_inputs || nargin > max_inputs)
## print_usage ();
## endif
## @end group
## @end example
##
## This function returns an error unless @var{in} is between the values of
## @var{low} and @var{high}. It does nothing otherwise. They all must be non
## negative scalar integers. @var{high} can also be Inf.
##
## @var{func_name} is the name of the function to be used on the error message.
##
## @seealso{error, nargin, nargout, narginchk, nargoutchk}
## @end deftypefn
function iptchecknargin (low, high, in, func_name)
persistent warned = false;
if (! warned)
warned = true;
warning ("Octave:deprecated-function",
"iptchecknargin is obsolete and will be removed from a future version of the image package, please use narginchk instead");
endif
if (nargin != 4)
print_usage;
elseif (!isnumeric (low) || !isscalar (low) || !isreal (low) || low < 0 || !isfinite (low) || rem (low, 1) != 0)
error ("Argument 'low' must be a non-negative scalar integer");
elseif (!isnumeric (high) || !isscalar (high) || !isreal (high) || low < 0 || (isfinite (high) && rem (low, 1) != 0))
error ("Argument 'high' must be a non-negative scalar integer or Inf");
elseif (!isnumeric (in) || !isscalar (in) || !isreal (in) || in < 0 || !isfinite (in) || rem (in, 1) != 0)
error ("Argument 'in' must be a non-negative scalar integer");
elseif (!ischar (func_name))
error ("Argument 'func_name' must be a string");
elseif (low > high)
error ("Minimun number of arguments cannot be larger than maximum number of arguments")
endif
## error ends in \n so the back trace of the error is not show. This is on
## purpose since the whole idea of this function is already to give a properly
## formatted error message
if (in < low)
error ("Function %s expected at least %d input arguments(s) but was called instead with %d input argument(s).\n", ...
func_name, low, in);
elseif (in > high)
error ("Function %s expected at most %d input argument(s) but was called instead with %d input argument(s).\n", ...
func_name, high, in);
endif
endfunction
%!test ('iptchecknargin (0, 2, 1, "func")'); # check simple works
%!test ('iptchecknargin (0, Inf, 1, "func")'); # check Inf on max
%!fail ('iptchecknargin (3, 2, 1, "func")'); # check fail min >max
%!fail ('iptchecknargin (2, 3, 1, "func")'); # check fail in out of range
|