2.29.4. Создание файл-функций.
Как уже отмечалось, файл-функции отличаются от файл-программ тем, что имеют входные и выходные параметры. Разумеется, что при этом можно создавать файл-функции с одним входным и одним выходным параметром, с несколькими входными или выходными параметрами, а также с переменными числом входных и выходных параметров. Все переменные, используемые в файл-функциях, являются изолированными от рабочего пространства MATLAB, что позволяет реализовывать с использованием файл-функций независимые фрагменты кода для решения конкретных задач.
Файл-функции, как и файл-программы, состоят из набора команд на языке MATLAB и сохраняются в текстовых файлах с расширением .m, однако имеют несколько иной синтаксис. Файл-функция должна состоять из следующих частей: заголовок функции (включает объявление function, имя функции, а также список входных и выходных параметров), определяющий «интерфейс» функции (способ взаимодействия с ней) и тело функции (состоит из инструкций на языке MATLAB, позволяющих вычислить значение функции).
Ввод текста файл-функции.
Рассмотрим создание простейшей
файл-функции с одним входных и одним
выходным параметром, предназначенной
для вычисления значения функции
.
Выберем в главном меню пункт New и далее в ниспадающем меню укажем Function, в результате чего откроется окно редактора M-файлов. В последнем необходимо набрать следующие строки кода (рис. 2.29.5):
function f=sample2(x)
% Вычисление значения функции
% f(x)=x^3*(7*sin(x)^2+5*cos(x)^2)
f(x)=x.^3.*(7*sin(x).^2+5*cos(x).^2);
Первая строка в рассматриваемом примере представляет собой заголовок функции, включающий в себя имя функции (в данном случае sample2), один входной (x) и один выходной (f) параметры. Далее следуют две строки с комментарием, который при вычислении функции игнорируется (это необязательная часть файл-функции). Заметим, что комментарий, введенный после заголовка функции, программа интерпретирует как описание функции которое отобразится в командном окне, если ввести команду
Рис. 2.29.5. Текст файл-функции в окне редактора M-файлов.
help имя_файл-функции
Иными словами, в MATLAB строки комментариев, располагаемые сразу после заголовка функции, играют особую роль – они предназначены не только для программистов, но и для конечных пользователей, желающих ознакомиться с краткой информацией об используемой файл-функции. В этих строках должна быть расположена краткая, но содержательная справка по хорошо документированной функции.
Эти же начальные строки комментариев участвуют в поиске функции по содержащимся в ней текстовым фрагментам, выполняемому с помощью команды вида
lookfor текст -all
Наконец, в результате применения команды
type имя_функции
в командном окне отображается текст M-функции вместе со всеми ее комментариями. Такая визуализация позволяет изучить детали реализации алгоритма, использованного при написании файл-функции, научиться различным приемам программирования, в частности, способам и глубине проверок входных и выходных параматров.
Далее следует тело функции – набор из инструкций M-языка, с помощью которых вычисляются возвращаемые значения (тело функции следует за заголовком функции). При вводе указанных инструкций использовались, в частности, операторы поэлементного умножения и возведения в степень (для того, чтобы можно было использовать функцию, при работе с массивами). В конце строки, вычисляющей значение искомого выражения, поставлена точка с запятой, что позволяет избежать вывода на экран лишней информации.
Заголовок файл-функции и тело файл-функции в совокупности в совокупности составляют определение функции.
Сохранение файл-функции. После введения текста файл-функции, ее следует сохранить в текущем рабочем каталоге. Для этого в главном меню следует выбрать пункт Save и далее в ниспадающем окне указать Save As. В результате в появившемся диалоговом окне Select File for Save As раскроется каталог MATLAB папки Документы, который по умолчанию определен в качестве текущего рабочего каталога. В общем случае размещать M-файл с определением файл-функции, необходимо в одном из каталогов диска, входящих в список доступа системы MATLAB. Данный вопрос уже обсуждался ранее при изучении файл-программ.
В полях Имя файла и Тип файла этого диалогового окна автоматически появятся требуемые имя и тип файл-функции. Содержимое указанных полей менять не требуется. В рассматриваемом случае в поле Имя файла будет предложено имя sample2. Вообще, указанное в заголовке имя файл-функции должно совпадать с именем файла (без учета расширения .m), в который записывается текст файл-функции. Несогласованность имени функции и имени файла не допускается.
Выполнение файл-функций. Созданную файл-функцию можно использовать как в командном режиме (аналогично любой встроенной функции системы MATLAB), так и вызывать из других файл-программ или файл-функций. При вызове файл-функции следует указать все ее входные и выходные параметры. В частности, в рассматриваемом примере обязательным является задание единственного входного параметра x. Вычислим, например, значение функции sample2 при x=4, а результат присвоим произвольной переменной y. Будем иметь:
>> y=sample2(4)
y =
393.3120
При вызове файл-функции MATLAB проверяет, относится ли ее имя к какой-либо переменной, встроенной функции, либо к M-файлу в текущем рабочем каталоге или в каталоге, установленном в пути поиска. Если объект с таким именем есть, будет выполнен именно он. В этой связи, во избежание путаницы, файл-функциям, как и файл-программам следует присваивать уникальные имена.
При создании файл-функции sample2 были определены две переменные: входная переменная x и выходная переменная f. Для того, чтобы убедиться в том, что эти переменные являются локальными и не появляются в рабочем пространстве после вызова файл-функции, можно обратиться к ним после выполнения данной файл-функции и получить сообщения об ошибках:
>> x
Undefined function or variable 'x'.
>> f
Undefined function or variable 'f'.
Существует еще один способ вызова файл-функции, используемый при необходимости ограничить доступ к некоторой M-функции, расположенной в заданном каталоге. В этом случае в данном каталоге нужно создать дочерний каталог с именем private и поместить туда указанную функцию. В результате все функции из каталога private будут доступны лишь функциям из родительского каталога.
Файл-функции с несколькими входными и выходными параметрами. При необходимости вычисления значений функции типа рассмотренной ранее , но при коэффициентах, отличных от 7 и 5, можно внести соответствующие изменения в текст файл-функции и затем сохранить их. Вместе с тем, очевидно, что наиболее рациональным решением в такой ситуации является написание такой функции, для которой значения соответствующих коэффициентов являлись бы входными параметрами. Таким образом, возникает задача составления файл-функции с несколькими входными аргументами (в случае такого решения не придется каждый раз редактировать файл-функцию, меняя значения коэффициентов).
Представленную выше файл-функцию можно переписать в виде:
function f=sample3(x,c1,c2)
% Вычисление значения функции
% f(x)=x^3*(c1*sin(x)^2+c2*cos(x)^2)
% при различных значениях коэффициентов c1, c2
f=x.^3.*(c1*sin(x).^2+c2*cos(x).^2);
Сохранив эту файл-функцию в рабочем каталоге под именем sample3, ее можно будет использовать наряду с другими функциями. Вызов файл-функции sample3 аналогичен вызову файл-функции sample3, однако в данном случае необходимо задать значение не одного, а трех входных параметров. Так, например, будем иметь:
>> y=sample3(5,5,7)
y =
645.1161
В общем случае, если функция имеет несколько выходных параметров (т.е. возвращает несколько значений), их указывают в квадратных скобках через запятую после объявления function. Структура функции при этом будет иметь следующий вид:
function [Ret1,Ret2,...]=имя_функции(par1,par2,...)
% Комментарий
Ret1=выражение
Ret2=выражение
...
end
где имя_функции – имя объявляемой (с помощью ключевого слова function) функции, которая принимает входные значения par1, par2 и т.д. (формальные параметры) и вырабатывает выходные (возвращаемые) значения Ret1, Ret2 и т.д. Многоточия здесь не являются элементами синтаксической конструкции, они применяются лишь для того, чтобы наглядно подчеркнуть тот факт, что функции могут иметь разное входных параметров и выходных значений, например:
function FuncName1
function FuncName2(par1,par2,par3,par4)
function Ret1=FuncName3(par1,par2)
function [Ret1,Ret2,Ret3]=FuncName4(par1)
В первой строке последнего примера представлен заголовок файл-функции FuncName1, не имеющей ни входных, ни выходных параметров. Файл-ункция FuncName2 принимает четыре входных параметра и также не имеет выходных параметров (возвращаемых значений). Далее файл-функция FuncName3 принимает два значения, а возвращает один выходной параметр. Наконец, функция FuncName4 имеет один входной параметр и три выходных значения. Зачастую входные параметры для краткости называют аргументами функции, а возвращаемые (выходные) значения функции называют просто ее значениями.
Вызвать объявленную функцию можно следующим образом:
[Retf1,Retf2,...]=имя_функции(parf1,parf2,...)
где parf1, parf2, … – список входных параметров (фактические параметры); Retf1, Retf2,… – выходные (возвращаемые) значения.
Таким образом, синтаксис вызова файл-функции в системе MATLAB аналогичен вызову функции или подпрограммы в большинстве языков программирования: в командной строке вводится имя функции, после которого в круглых скобках через запятую перечисляются фактические входные параметры, со значениями которых и будут производиться вычисления. Фактические параметры могут быть заданы числовыми (и другими) значениями, именами переменных (уже имеющих конкретные значения), а также выражениями. Отметим, что если фактический параметр задан именем некоторой переменной, то реальные вычисления будут осуществляться с копией этой переменной (а не с ней самой). Это называется передачей параметров по значению.
Рассмотрим в качестве примера функцию sample4, которая вычисляет среднее значение элементов заданного вектора и стандартное отклонение элементов вектора от среднего (соответствующий пример приведен, в частности, в документации к системе MATLAB):
function [mean,stdev]=stat(x)
n=length(x);
mean=sum(x)/n;
stdev=sqrt(sum((x-mean).^2/n));
После сохранения текста приведенной выше файл-функции в файле stat.m ее можно вызвать, задав, например, в качестве входного параметра некоторый вектор k:
>> k=[1 5 3 7 4 2 6];
>> [m,s]=stat(k)
m =
4
s =
2
Интересно, что функции, возвращающие несколько значений, можно также использовать в составе выражений, при этом в качестве значения функции, применяемого для дальнейших вычислений, используется первое из возвращаемых функцией значений. Так, например, продолжая предыдущий пример, будем иметь:
>> a=stat(k)+7
a =
11
Следует обратить внимание на то, что имена фактических входных параметров (в данном случае k) и переменных, в которые записываются результаты вычислений (в данном случае m и s) не совпадают с именами аналогичных переменных в определении функции stat (в данном случае это x и mean, stdev). Для того, чтобы подчеркнуть это возможное отличие, имена входных параметров и выходных значений в определении функции называют формальными (по аналогии с формальными параметрами подпрограмм в языке программирования FORTRAN).
Так как вызов любой функции можно осуществить, написав произвольное выражение в командном окне MATLAB, то всегда имеется вероятность совершения ошибки, связанной с несовпадением типов фактических и формальных параметров. Это тем более опасно, что система MATLAB не выполняет соответствующую проверку их соответствия, а просто передает управление файл-функции. Для предотвращения возникновения подобных ошибочных ситуаций рекомендуется, по возможности, предусматривать проверку входных параметров в тексте файл-функций (для достижения этой цели может быть использован полный набор рассматриваемых далее конструкций управления).
Использование подфункций. В ряде случаев при написании файл-функций возникает потребность в создании и использовании так называемых подфункций (subfunctions), в которых выполняются промежуточные вычисления. Эти подфункции записываются после основных функций и имеют аналогичный им синтаксис, они являются локальными и могут выполняться лишь в пределах основной файл-функции. Файл-функция может включать одну или несколько подфункций.
Приведенную выше функцию stat можно переписать в виде функции, содержащей подфункцию:
function [mean,stdev]=stat_main(x)
% Основная функция
n=length(x);
mean=average(x,n);
stdev=sqrt(sum((x-average(x,n)).^2/n));
function mean=average(x,n)
% Подфункция
mean=sum(x)/n;
Здесь используется подфункция average с двумя входными и одним выходным параметром (аргументом), вычисляющим среднее значение элементов вектора x.
При обращении к функции интерпретатор системы MATLAB, прежде всего, просматривает M-файл на предмет выявления подфункций. В случае их обнаружения они задаются как локальные функции. Благодаря локальному действию подфункций их имена могут совпадать с именами основных функций системы.
Если в M-файле размещаются определения нескольких функций, то вызвать из командного окна MATLAB (или из функций другого M-файла) можно лишь ту из них, имя которой совпадает с именем M-файла. Таким образом, только одна функций из M-файла оказывается видимой вне этого файла, а остальные функции вызываются внутри данного M-файла и выполняют вспомогательные вычисления.