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

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

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.