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

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

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

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

Аналогичная проверка ошибок предоставляется narginchk и nargoutchk.

: narginchk (minargs, maxargs) ¶

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

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

И minargs, и maxargs должны быть скалярными числовыми значениями. Допускаются нулевые, бесконечные и отрицательные значения, а также 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 должны быть числовыми скалярами. Допускаются нулевые, бесконечные и отрицательные значения, а также они могут иметь одинаковое значение.

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

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

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