11.7 Игнорирование аргументов

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

function val = pick2nd (~, arg2)
  val = arg2;
endfunction

Использование этого объявления не влияет на значение nargin.

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

x = [2, 3, 1];
[s, i] = sort (x)
⇒
s =

   1   2   3

i =

   3   1   2

[~, i] = sort (x)
⇒
i =

   3   1   2

При использовании заполнителя ~ для разделения выходных аргументов необходимо использовать запятые, а не пробелы. В противном случае интерпретатор воспримет ~ как оператор логического отрицания.

[~ i] = sort (x)
parse error:

  invalid left hand side of assignment

Функции могут использовать игнорирование выходных аргументов, чтобы сократить число выполняемых вычислений. Для этого применяйте функцию isargout, чтобы проверить, нужен ли выходной аргумент. Например:

function [out1, out2] = long_function (x, y, z)
  if (isargout (1))
    ## Long calculation
    ...
    out1 = result;
  endif
  ...
endfunction

: tf = isargout (k)

Внутри функции возвращает логическое значение, указывающее, будет ли аргумент k присвоен переменной при выводе.

Если результат — false, аргумент был проигнорирован при вызове функции с помощью специального выходного аргумента тильды (~). Функции могут использовать isargout, чтобы избежать ненужных вычислений для невостребованных выходных аргументов.

Если k находится вне диапазона 1:max (nargout), функция возвращает false. k также может быть массивом; в этом случае функция обрабатывает каждый элемент отдельно и возвращает логический массив. На верхнем уровне isargout возвращает ошибку.

См. также: nargout, varargout, nthargout.