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.