В.Г.Потемкин "Введение в Matlab" (v 5.3)
Глава 3. Программирование в среде Matlab 5

  В оглавление книги \ К следующему разделу \ К предыдущему разделу \ Предметный указатель

3.3. Выполнение М-функций. Списки аргументов. Типы аргументов. Типы данных

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

Назначение имени. Когда появляется новое имя, система MATLAB проверяет:

1. Не является ли новое имя именем переменной.
2. Не является ли это имя именем подфункции, то есть функции, которая размещена в этом же M-файле и является вызываемой.
3. Не является ли оно именем частной функции, размещаемой в каталоге private. Этот каталог доступен только M-файлам, размещенным на один уровень выше.
4. Не является ли оно именем функции в пути доступа системы MATLAB. В этом случае система использует тот М-файл, который встречается первым в пути доступа.

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

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

Допустимы следующие модификации команды clear:

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

Эта команда выполняет синтаксический анализ М-файла average.m и сохраняет результирующий псевдокод в файле с именем average.p. Это позволяет избежать повторного разбора во время нового сеанса работы. Поскольку синтаксический анализ выполняется очень быстро, применение команды pcode почти не влияет на скорость ее исполнения.
Применение P-кода целесообразно в двух случаях:

• когда требуется выполнять синтаксический анализ большого числа M-файлов, необходимых для визуализации графических объектов в приложениях, связанных с разработкой графического интерфейса пользователя; в этом случае применение P-кода обеспечивает существенное ускорение;
• когда пользователь хочет скрыть алгоритмы, реализованные в М-файле.

Правила передачи аргументов. С точки зрения программиста, система MATLAB передает аргумент его значением. На самом деле значением передаются только те аргументы, которые изменяются при работе этой функции. Если функция не изменяет значения аргумента, a только использует его для вычислений, то аргумент передается ссылкой, что позволяет оптимизировать использование памяти.

Рабочие области функции. Каждой M-функции выделяется доплнительная область памяти, не пересекающаяся с рабочей областью системы MATLAB. Такая область называется рабочей областью функции. Каждая функция имеет свою собственную рабочую область.

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

Проверка количества аргументов. Функции nargin и nargout позволяют определить количество входных и выходных аргументов вызываемой функции. Эту информацию в дальнейшем можно использовать в операторах условия для изменения хода вычислений.

Пример:

          function c = testarg1(a,b)
          if(nargin == 1)
             c = a.^2;
          elseif (nargin == 2)
                    c = + b;
          end

При задании единственного входного аргумента функция вычисляет квадрат входной переменной; при задании двух аргументов выполняется операция сложения.

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

Эта функция оформлена в виде М-функции strtok, которая находится в каталоге strfun.

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

Списки аргументов.

Функции varargin и varargout позволяют передавать произвольное количество входных и выходных аргументов. Система MATLAB упаковывает все заданные входные и выходные аргументы в массив ячеек. Каждая ячейка может содержать любой тип и любое количество данных.

Пример
      Функция testvar допускает в качестве входных аргументов любое количество векторов из двух элементов и выводит на экран линии, их соединяющие.

              function testvar(varargin)

              for i = 1:length(varargin)
                     x(i) = varargin{i}(1);
                     y(i) = varargin{i}(2);
              end

              xmin = min(0, min(x));
              ymin = min(0, min(y));
              axis([xmin fix(max(x))+3 ymin fix(max(y))+3])
              plot(x,y)

Таким образом, функция testvar может работать с входными списками разной длины.

Пример:

             testvar([2 3], [1 5], [4 8], [6 5], [4 2], [2 3])
             testvar([-1 0], [3 -5], [4 2], [1 1])

Формирование входного массива varargin. Поскольку список varargin хранит входные аргументы в массиве ячеек, то необходимо использовать индексы ячеек для извлечения данных. Индекс ячейки состоит из двух компонентов:
    - индекс в фигурных скобках;
    - индекс в круглых скобках.

Пример:

             y(i)= varargin{i}(2);
Здесь индекс в фигурных скобках {i} указывает адрес i-ой ячейки массива varargin, а индекс в круглых скобках (2) указывает на второй элемент в ячейке.

Формирование выходного массива varargout. При произвольном количестве выходных аргументов их необходимо упаковать в массив ячеек varargout. Чтобы определить количество выходных аргументов функции, надо использовать функцию nargout.

Пример
    Следующая функция использует в качестве входа массив из двух столбцов, где первый столбец - множество значений координаты x, а второй - множество значений координаты y. Функция разбивает массив на отдельные векторы, которые могут быть переданы в функцию testvar в качестве входов.

              function [varargout] = testvar2(arrayin)
              for i = 1:nargout
                     varargout{i} = arrayin(i, :);
              end

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

Для вызова функции testvar2 можно использовать следующие операторы:

a = [1 2 3 4 5;6 7 8 9 0]';
[p1,p2,p3,p4,p5] = testvar2(a)
p1 = 16
               p2 =     2    7
               p3 =     3    8
               p4 =     4    9
               p5 =     5    0

Использование массивов ячеек в списках аргументов. Аргументы varargin и varargout должны быть последними в соответствующих списках аргументов. При вызове функции аргументы, предшествующие varargout, должны быть вычислены внутри функции.

Пример
Приведенные ниже заголовки функций показывают правильное использование списков varargin и varargout:

        function[out1, out2] = example1(a,b,varargin)
         function[i,j,varargout] = example2(x1,y1,x2,y2,flag)

Типы переменных.

Локальные и глобальные переменные. Использование переменных в M-файле ничем не отличаетсч от использования переменных в командной строке, а именно:

• переменные не требуют объявления; прежде чем переменной присвоить значение, необходимо убедиться, что всем переменным в правой части значения присвоены;
• любая операция присваивания создает переменную, если это необходимо, или изменяет значение существующей переменной;
• имена переменных начинаются с буквы, за которой следует любое количество букв, цифр и подчеркиваний; система MATLAB различает символы верхнего и нижнего регистров;
• имя переменной не должно превышать 31 символа. Более точно, имя может быть и длиннее, но система MATLAB принимает во внимание только первые 31 символ.

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

Пример.
Допустим, требуется исследовать влияние коэффициентов a и b для модели хищник-жертва, описываемой уравнениями Лотке-Вольтерра:

Создадим M-файл lotka.m:

            function yp = lotka(t, y)
             %LOTKA уравнения Лотке-Вольтерра для модели хищник-жертва

            global ALPHA BETA
            yp = [y(1) - ALPHA*y(1)*y(2); -y(2) + BETA*y(1)*y(2)];

Затем через командную строку введем операторы:

           global ALPHA BETA
           ALPHA = 0.01;
           BETA = 0.02;
           [t,y] = ode23('lotka2',[0 10],[1; 1]);
           plot(t,y)

Команда global объявляет переменные ALPHA и BETA глобальными и следовательно, доступными в функции lotka.m. Таким образом, они могут быть изменены из командной строки, а новые решения будут получены без редактирования М-файла lotka.m.

Для работы с глобальными переменными необходимо:

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

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

Специальные переменные. Некоторые М-функции возвращают специальные переменные, которые играют важную роль при работе в среде системы MATLAB :

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

Типы данных.

В системе MATLAB определено шесть базовых типов данных, каждый из которых является многомерным массивом. Шесть классов - это double, char, sparse, uint8, cell, и struct. Двумерные версии этих массивов называются матрицами, откуда MATLAB и получил свое имя МАТричная ЛАБоратория.

Диаграмма принадлежности того или иного объекта системы MATLAB к одному из классов имеет следующий вид (рис. 3.1):

Рис. 3.1

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

Другие типы данных предназначены для таких специальных приложений, как работа с разреженными матрицами (sparse), обработка изображений (uint8), работа с массивами большой размерности (cell и struct).

Нельзя задать тип переменной numeric или array. Эти типы называются виртуальными и служат только для того, чтобы сгруппировать переменные, которые имеют общие атрибуты.

Тип uint8 предназначен для эффективного хранения данных в памяти. К данным этого типа можно применять только базовые операции индексации и изменения размеров, но нельзя выполнить никакой математической операции. Для этого такие массивы необходимо преобразовать в тип double.

Создание собственных типов и добавление методов для встроенных типов. Нижеприведенная таблица содержит седьмой тип данных - UserObject. Язык MATLAB позволяет создавать собственные типы данных и работать с ними по аналогии со встроенными типами.

Для встроенных типов данных можно переопределять метод точно также, как это делается для объекта. Например, чтобы задать операцию сортировки для массива типа uint8, необходимо создать метод (sort.m или sort.mex) и поместить его в специальный каталог @uint8.

Следующая таблица описывает типы данных более подробно.

Описание диаграммы. Соединительные линии на диаграмме (рис. 3.1) определяют принадлежность того или иного типа данных к одному или нескольким классам.

Пример
Матрица типа sparse имеет также типы double и numeric. Операторы
              isa(S',sparse')
              isa(S',double')
              isa(S',numeric')
возвращают значения 1(истина), то есть S - числовая разреженная матрица удвоенной точности.

Обратите внимание, что тип array - массив находится в вершине диаграммы. Это означает, что все данные системы MATLAB являются массивами.

Каждому типу данных можно соотнести свои функции и операторы обработки, или другими словами, методы. Дочерние типы данных, расположенные на диаграмме ниже родительского типа, поддержаны также и методами родителя. Следовательно, массив типа double поддержан методами, применяемыми для типа numeric.

В таблице приведены некоторые из таких методов:

Пустые массивы. Ранние версии системы MATLAB допускали единственную форму пустого массива размера 0х0, обозначаемого как [ ]. MATLAB 5 поддерживает массивы, у которых одна, но не все из размерностей, равна нулю, то есть массивы с размерами 1х0, 10х0х20 или [3 4 0 5 2] определяются как пустые.

Квадратные скобки [ ] продолжают обозначать массив 0х0. Пустые массивы другого размера могут быть созданы с помощью функций zeros, ones, rand или eye. Например, для формирования пустого массива размера 0х5, можно использовать опертор присваивания
               E = zeros(0,5).

Основное назначение пустых массивов состаит в том, чтобы любая операция, которая определена для массива(матрицы) размера m?n, определяла правильный результат для случая, когда m или n равно нулю. Размер массива(матрицы) результата должен соответствовать значению функции, вычисленной в нуле.

Например, оператор
                C = [A B]
требует, чтобы массивы A и B имели одинаковое число строк. Таким образом, если массив A имеет размер m x n, а B - m x p, то C есть массив размера m x (n+p). Результат будет правильным, если любой из параметров m, n или p равен нулю.

Многие операции в системе MATLAB создают вектор-строку или вектор-столбец. В этом случае результат может быть, либо пустой вектор-строкой
                r = zeros(1, 0),
либо пустым вектор-столбцом
               C = zeros(0, 1).

MATLAB 5 поддерживает правила системы MATLAB 4 для операторов if и while. Например, условный оператор типа
               if A, S1, else, S0, end
выполняет оператор S0, когда A - пустой массив.

Некоторые функции системы MATLAB такие, как sum, prod, min и max понижают размерность результата: если аргумент массив, то результат - вектор; если аргумент вектор, то результат - скаляр.

Для этих функций при пустом массиве входа получаются следующие результаты:
              sum([ ]) = 0 ;
              prod([ ]) = 1 ;
              max([ ]) = [ ] ;
              min([ ]) = [ ] .

  В оглавление книги \ К следующему разделу \ К предыдущему разделу \ Предметный указатель