Файл: MATLAB. Довідник для користувача.pdf

% FACT Factorial. % Первая строка помощи (H1 line)

%FACT(N) returns the factorial of N, H! % Текст помощи (Help text)

%usually denoted by N!

%Put simply, FACT(N) is PROD(1:N).

f = prod(1:n); % Тело функции

Эта функция имеет некоторые элементы, которые являются общими для всех функций систе-

мы MATLAB:

•Строка определения функции. Эта строка задает имя функции , а также число и порядок входных и выходных аргументов.

•Строка H1 (H1 line). H1 обозначает «первую строку» помощи. MATLAB выводит эту строку в командное окно, когда вы пользуетесь функцией lookfor или запрашиваете помощь по всей директории.

•Текст помощи (Help text). MATLAB выводит в командное окно данный текст вместе со строкой H1, когда вы запрашиваете помощь по конкретной функции, то есть вводите help

Имя_Функции.

•Тело функции. Эта часть функции содержит коды (команды), которые выполняют вычисления и определяют значения всех выходных переменных.

Обеспечение помощи для вашей программы

Вы можете снабдить пользователя информацией(помощью) о вашей программе, путем включения раздела текста помощи в начало М-файла. Этот раздел начинается со строки, следующей непосредственно за строкой опеределения функции и заканчивается на первой пустой строке, или строке тела функции. Каждая строка текста (эти строки окрашены в зеленый цвет) помощи должна начинаться символом процента(%). MATLAB выводит в командное окно данный текст каждый раз когда вы вводите

help Имя_Функции

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

help Имя_Директории

Если данная директория не содержит файл Contents.m, то при вводе help Имя_Директории в командное окно выводится первая строка помощи (H1 line) для каждого файла директории.

Создание М-файлов: Использование текстовых редакторов

М-файлы представляют собой обычные текстовые файлы, которые вы создаете с использованием текстового редактора. MATLAB содержит встроенный редактор, хотя в принципе можно воспользоваться любым другим текстовым редактором.

Внимание! Для вызова редактора нужно в меню File выбрать New и затем M-File.

Другой способ вызова редактира М-файла из командной строки состоит в использовании функции edit. For example, при вводе

edit foo

98

MATLAB открывает встроенный текстовой редактор на файлеfoo.m. Если не указать имени файла, то будет вызван редактор с новым, неозаглавленным файлом. Вы можете создать функцию fact, приведенную выше, путем открытия вашего текстового редактора, ввода показанных строк, и запоминанием текста в файле под названиемfact.m в вашей текущей директории.

После того как вы создали этот файл, его можно найти в списке файлов вашей текущей директории, для чего надо ввести команду

what

Можно также распечатать в командном окне файл командой

type fact

Наконец, вы можете вычислить факториал любого целого числа, например, 5-и

fact(5) ans =

120

Внимание! Сохраняйте все созданные или измененные вами М-файлы в директории(каталоге), который не находится в дереве каталоговMATLAB-а. Если вы сохраните ваши М-файлы в дереве каталогов MATLAB-а, они могут быть уничтожены при установке новой версии MATLAB-а.

Сценарии

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

Простой пример сценария

Приведенные ниже выражения вычисляют функциюrho для нескольких тригонометрических функций угла theta, и строят серию графиков в полярной системе координат

Попробуйте ввести эти команды в М-файл, названный petals.m. Этот файл является теперь сценарием MATLAB-а. Ввод команды petals (лепестки) в командной строке MATLAB –а приводит к выполнению команд сценария. Команда pause приостанавливает выполнение

99

цикла до нажатия какой-либо клавиши(например, Return). Таким образом, после того как сценарий отображает один график из четырех, нажатие клавиши Return приводит к появлению следующего. Здесь мы не имеем входных или выходных переменных; сценарий petals создает требуемые ему переменные в основном рабочем пространстве MATLAB-а. Когда выполнение сценария завершено, все созданные переменные (i, theta, и rho) остаются в рабочем пространстве. Вы можете убедиться в этом, вводя команду whos в командной строке.

Функции

Функции представляют собой М-файлы, которые принимают входные аргументы и выдают выходные. Они работают над переменными в своем собственном рабочем пространстве, которое не совпадает с основным рабочим пространством, доступном из командной строки

MATLAB-а.

Простой пример функции

Функция average является простым М-файлом, который вычисляет среднее значение элементов вектора.

function y = average(x)

%AVERAGE Mean of vector elements.

%AVERAGE(X), where X is a vector, is the mean of vector elements.

%Non-vector input results in an error.

[m,n] = size(x);

if (~((m == 1) | (n == 1)) | (m == 1 & n == 1)) error('Input must be a vector')

end

y = sum(x) / length(x) ; % Фактические вычисления

При вводе не векторной величины, данная функция выдает сообщение об ошибке (более точно, на дисплей выводится фраза «Вход должен быть вектором»). Вы можете ввести эти команды в М-файл, названный average.m. Функция average допускает единственный вход и возвращает единственный выходной аргумент. Для обращения к данной функции, введите

z = 1:99; average(z)

что даст следующий результат

ans =

50

Основные части синтаксиса М-функций

Функции в общем случае состоят из следующий частей:

·Строка определения функции (The Function Definition Line)

·Строка помощи H1 (The H1 Line)

·Текст помощи (Help Text)

·Тело функции (The Function Body)

·Комментарии (Comments)

Строка определения функции

Строка определения функции информирует систему MATLAB , что М-файл содержит функцию, и задает последовательность входных и выходных переменных. Для функции average эта строк имеет следующий вид:

100

где input argument – входной аргумент; function name – имя функции;

output argument – выходной аргумент; keyword – зарезервированное слово;

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

function [x,y,z] = sphere(theta, phi, rho)

Если функция не имеет выходных переменных, оставьте выход пустым, например,

function printresults(x)

или используйте пустые квадратные скобки

function [ ] = printresults(x)

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

Строка помощи H1

Строка H1, названная так потому что она является первой строкой текста помощи (Help text), является линией комментария, которая следует непосредственно за строкой определения функции. Поскольку она состоит из текста комментария, строка H1начинается с символа процента (%). Для функции average эта строка имеет вид

% AVERAGE Mean of vector elements.

(СРЕДНЕЕ ЗНАЧЕНИЕ Вычисление среднего значения векторов)

Эта строка является первой строкой текста, который появляется при вводе пользователем в командной строке команды

help function_name

(help имя_функции)

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

101

Текст помощи

Вы можете создать возможность оперативной помощи (справки) для вашей М-функции , путем ввода одной или большего числа строк комментария, начинающихся непосредственно за строкой H1. Текст помощи для функции average имеет вид

%AVERAGE(X), where X is a vector, is the mean of vector elements.

%Nonvector input results in an error.

(% СРЕДНЕЕ(Х), где Х является вектором, вычисляет среднее значение %элементов вектора. Не векторный вход приводит к ошибке).

Когда вы вводите help function_name, MATLAB выводит линии комментариев, которые находятся между строкой определения функции и первой строкой не комментариев (выполняемой или пустой строкой). MATLAB игнорирует любые линии комментариев, которые появляются за данным блоком текста помощи. Например, напечатав help sin получим

SIN Sine.

SIN(X) is the sine of the elements of X.

(SIN(X) является синусом элементов массива Х)

Тело функции

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

[m,n] = size(x);

if (~((m == 1) | (n == 1)) | (m == 1 & n == 1)) % Flow control error('Input must be a vector') % Error message display

end

y = sum(x)/length(x); % Computation and assignment

Комментарии

Как было указано ранее, строки комментариев начинаются с символа процента (%). Строки комментариев могут быть в любом месте М-файла, а также вы можете добавить комментарии к концу строки кодов программы. Например,

% Add up all the vector elements.

y = sum(x) % Use the sum function.

( % Суммирование всех элементов вектора. y = sum(x) % Используйте функцию sum)

Первая строка комментариев, следующая непосредственно за строкой определения функции рассматривается как строка H1 данной функции. Строка H1 и любые строки комментариев, непосредственно следующие за Н1, составляют запись оперативной помощи для данного файла. В дополнение к строкам комментариев, вы можете вводить пустые строки в любом месте М-файла. Пустые строки игнорируются. С другой стороны, пустая строка может обозначать конец текста помощи.

102