11.5 Списки возвращаемых значений переменной длины

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

В качестве примера, следующая функция устанавливает первый выходной аргумент в 1, второй во 2, и так далее.

function varargout = one_to_n ()
  for i = 1:nargout
    varargout{i} = i;
  endfor
endfunction

При вызове эта функция возвращает значения следующим образом

[a, b, c] = one_to_n ()
     ⇒ a =  1
     ⇒ b =  2
     ⇒ c =  3

Если varargin (varargout) не отображается в качестве последнего элемента списка входных (выходных) параметров, то он не является специальным и обрабатывается так же, как и любое другое имя параметра.

: [r1, r2, …, rn] = deal (a) ¶

: [r1, r2, …, rn] = deal (a1, a2, …, an) ¶

Скопировать входные параметры в соответствующие выходные параметры.

Если предоставлен только один входной параметр, его значение копируется в каждый из выходов.

Например,

[a, b, c] = deal (x, y, z);

эквивалентно

a = x;
b = y;
c = z;

и

[a, b, c] = deal (x);

эквивалентно

a = b = c = x;

Примечание для программистов: deal часто используется со списками, разделенными запятыми, полученными из ячейковых массивов или структур. Это не требуется, так как интерпретатор может выполнить то же действие без накладных расходов вызова функции. Например:

c = {[1 2], "Three", 4};
[x, y, z] = c{:}
⇒
   x =

      1   2

   y = Three
   z =  4

См. также: cell2struct, struct2cell, repmat.