11.9.1 Проверка количества аргументов

В Octave часто используется следующий шаблон в начале определения функции:

if (nargin < min_#_inputs || nargin > max_#_inputs)
  print_usage ();
endif

который останавливает выполнение функции и выводит сообщение о правильном способе её вызова, если количество входных аргументов неверно.

Аналогичная проверка ошибок выполняется с помощью narginchk и nargoutchk.

: narginchk (minargs, maxargs)

Проверка правильности количества входных аргументов.

Выводит сообщение об ошибке, если количество аргументов в вызывающей функции выходит за пределы диапазона от minargs до maxargs. В противном случае ничего не делает.

И minargs, и maxargs должны быть скалярными числовыми значениями. Допускаются ноль, Inf и отрицательные значения, а minargs и maxargs могут быть равны.

Обратите внимание, что эта функция вычисляет nargin в вызывающей функции.

См. также: nargoutchk, error, nargout, nargin.

: nargoutchk (minargs, maxargs)

: msgstr = nargoutchk (minargs, maxargs, nargs)

: msgstr = nargoutchk (minargs, maxargs, nargs, "string")

: msgstruct = nargoutchk (minargs, maxargs, nargs, "struct")

Проверка правильности количества выходных аргументов.

В первой форме возвращает ошибку, если количество аргументов не находится в диапазоне от minargs до maxargs. В противном случае ничего не делает. Обратите внимание, что эта функция вычисляет значение nargout в вызывающей функции, поэтому это значение не должно быть изменено.

И minargs, и maxargs должны быть числовыми скалярами. Допускаются ноль, Inf и отрицательные значения; эти значения также могут совпадать.

Для обеспечения обратной совместимости остальные формы возвращают подходящую строку сообщения об ошибке (или структуру), если запрошено недопустимое количество выходных аргументов.

Это полезно для проверки того, что количество выходных аргументов, переданных функции, находится в допустимом диапазоне.

См. также: narginchk, error, nargout, nargin.