11.2 Определение функций

В самом простом виде определение функции с именем name выглядит так:

function name
  body
endfunction

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

Тело функции body состоит из операторов Octave. Это самая важная часть определения, так как она определяет, что функция должна фактически делать.

Например, вот функция, которая при выполнении прозвонит звонок на вашем терминале (при условии, что это возможно):

function wakeup
  printf ("\a");
endfunction

Оператор printf (см. Ввод и вывод) просто сообщает Octave распечатать строку "\a". Специальный символ ‘\a’ обозначает символ оповещения (ASCII 7). См. Строки.

После определения этой функции вы можете попросить Octave оценить ее, набрав имя функции.

Обычно вы захотите передать некоторую информацию в определенные вами функции. Синтаксис передачи параметров функции в Octave:

function name (arg-list)
  body
endfunction

где arg-list — это список аргументов функции, разделенные запятыми. При вызове функции имена аргументов используются для хранения значений аргументов, заданных в вызове. Список аргументов может быть пустым, в этом случае этот формат эквивалентен приведенному выше.

Чтобы вывести сообщение вместе с звонком, можно изменить wakeup следующим образом:

function wakeup (message)
  printf ("\a%s\n", message);
endfunction

Вызов этой функции с помощью оператора

wakeup ("Rise and shine!");

приведет к звонку на вашем терминале и выводу сообщения «Подъем и просветление!», за которым следует символ новой строки (символ «\n» в первом аргументе оператора printf).

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

function ret-var = name (arg-list)
  body
endfunction

Символ ret-var — это имя переменной, которая будет содержать возвращаемое функцией значение. Эта переменная должна быть определена перед концом тела функции, чтобы функция могла вернуть значение.

Переменные, используемые в теле функции, являются локальными для функции. Переменные, указанные в arg-list и ret-var, также являются локальными для функции. См. Глобальные переменные для получения информации о том, как обращаться к глобальным переменным внутри функции.

Например, вот функция, вычисляющая среднее значение элементов вектора:

function retval = avg (v)
  retval = sum (v) / length (v);
endfunction

Если бы мы написали avg следующим образом:

function retval = avg (v)
  if (isvector (v))
    retval = sum (v) / length (v);
  endif
endfunction

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

error: value on right hand side of assignment is undefined

потому что тело оператора if никогда не выполнялось, и retval никогда не было определено. Чтобы предотвратить неясные ошибки такого рода, всегда убеждайтесь, что переменные возврата всегда будут иметь значения, и генерируйте осмысленные сообщения об ошибках при возникновении проблем. Например, avg можно было бы написать так:

function retval = avg (v)
  retval = 0;
  if (isvector (v))
    retval = sum (v) / length (v);
  else
    error ("avg: expecting vector argument");
  endif
endfunction

Еще есть одна проблема с этой функцией. Что, если она вызывается без аргумента? Без дополнительной проверки ошибок Octave, вероятно, выведет сообщение об ошибке, которое не поможет вам отследить источник ошибки. Для возможности отслеживания таких ошибок Octave предоставляет каждой функции автоматическую переменную, называемую nargin. Каждый раз, когда функция вызывается, nargin автоматически инициализируется числом аргументов, которые фактически были переданы в функцию. Например, мы можем переписать функцию avg следующим образом:

function retval = avg (v)
  retval = 0;
  if (nargin != 1)
    usage ("avg (vector)");
  endif
  if (isvector (v))
    retval = sum (v) / length (v);
  else
    error ("avg: expecting vector argument");
  endif
endfunction

Хотя Octave не сообщает об ошибке автоматически, если вы вызываете функцию с большим количеством аргументов, чем ожидалось, это, вероятно, указывает на наличие проблемы. Octave также не сообщает об ошибке автоматически, если функция вызывается с недостаточным количеством аргументов, но любая попытка использовать переменную, которой не было присвоено значение, приведет к ошибке. Чтобы избежать таких проблем и предоставить полезные сообщения, мы проверяем обе возможности и выводим собственное сообщение об ошибке.

nargin ()

nargin (fcn)

Сообщает количество входных аргументов функции.

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

Если вызывается с необязательным аргументом fcn (имя или дескриптор функции), возвращает объявленное количество аргументов, которые может принимать функция.

Если последним аргументом для fcn является varargin, возвращаемое значение является отрицательным. Например, функция union для множеств объявлена как

function [y, ia, ib] = union (a, b, varargin)

and

nargin ("union")
⇒ -3

Примечание по программированию: nargin не работает с скомпилированными функциями (.oct-файлами), такими как встроенные или динамически загруженные функции.

См. также: nargout, narginchk, varargin, inputname.

inputname (n)

inputname (n, ids_only)

Возвращает имя n-го аргумента вызывающей функции.

Если аргумент не является простым именем переменной, возвращает пустую строку. Например, ссылка на поле в структуре, такой как s.field, не является простым именем и вернет "".

inputname полезна только внутри функции. При использовании в командной строке она всегда возвращает пустую строку.

По умолчанию возвращает пустую строку, если n-й аргумент не является допустимым именем переменной. Если необязательный аргумент ids_only имеет значение false, возвращает текст аргумента, даже если он не является допустимым именем переменной.

См. также: nargin, nthargout.

val = silent_functions ()

old_val = silent_functions (new_val)

silent_functions (new_val, "local")

Запрос или установка внутренней переменной, которая управляет тем, подавляется ли внутренний вывод функции.

Если этот параметр отключен, Octave отобразит результаты вычисления выражений внутри тела функции, не завершающихся точкой с запятой.

При вызове изнутри функции с опцией "local", переменная изменяется локально для функции и всех вызываемых ею подпрограмм. Исходное значение переменной восстанавливается при выходе из функции.