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 присвоен переменной на выходе.

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

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

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