11.6 Списки аргументов переменной длины

Иногда количество входных аргументов неизвестно на момент определения функции. В качестве примера можно рассмотреть функцию, которая возвращает наименьший из всех своих входных аргументов. Например:

a = smallest (1, 2, 3);
b = smallest (1, 2, 3, 4);

В этом примере и a и b будут равны 1. Один из способов написания функции smallest:

function val = smallest (arg1, arg2, arg3, arg4, arg5)
  body
endfunction

и затем использовать значение nargin для определения, какие входные аргументы должны учитываться. Проблема с этим подходом заключается в том, что он может обрабатывать только ограниченное количество входных аргументов.

Если специальное имя параметра varargin появляется в конце списка параметров функции, это указывает на то, что функция принимает переменное количество входных аргументов. Используя varargin, функция выглядит так:

function val = smallest (varargin)
  body
endfunction

В теле функции входные аргументы можно получить через переменную varargin. Эта переменная является массивом ячеек, содержащим все входные аргументы. Подробную информацию о работе с массивами ячеек см. в разделе Массивы ячеек. Теперь функцию smallest можно определить следующим образом:

function val = smallest (varargin)
  val = min ([varargin{:}]);
endfunction

Эта реализация обрабатывает любое количество входных аргументов, но это также очень простое решение проблемы.

Несколько более сложный пример varargin - это функция print_arguments, которая выводит все входные аргументы. Такую функцию можно определить следующим образом:

function print_arguments (varargin)
  for i = 1:length (varargin)
    printf ("Input argument %d: ", i);
    disp (varargin{i});
  endfor
endfunction

Эта функция генерирует вывод, подобный этому:

print_arguments (1, "two", 3);
     -| Input argument 1:  1
     -| Input argument 2: two
     -| Input argument 3:  3

[reg, prop] = parseparams (params)

[reg, var1, …] = parseparams (params, name1, default1, …)

Возвращает в reg элементы ячейки param до первого строкового элемента, а в prop — все оставшиеся элементы, начиная с первого строкового элемента.

Например:

[reg, prop] = parseparams ({1, 2, "linewidth", 10})
reg =
{
  [1,1] = 1
  [1,2] = 2
}
prop =
{
  [1,1] = linewidth
  [1,2] = 10
}

Функция parseparams может использоваться для разделения обычных числовых аргументов от дополнительных аргументов, заданных в виде пар «свойство/значение» массива ячеек varargin.

Во второй форме вызова доступные параметры указываются непосредственно со значениями по умолчанию, заданными в виде пар «имя-значение». Если params не образуют пар «имя-значение» или если параметр не совпадает ни с одним из доступных параметров, возникает ошибка.

При вызове из файла m-функции ошибка предваряется именем вызывающей функции.

Сопоставление параметров не зависит от регистра.

См. также: varargin, inputParser.