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.