Ускорьте алгоритм MATLAB путем генерации MEX-функции

Можно использовать MATLAB^® Coder™, чтобы сгенерировать MEX-функцию из кода MATLAB. MEX-функция является исполняемым файлом MATLAB. Это - сгенерированный код, который может быть назван из MATLAB. При работе в среде MATLAB используйте MEX-функции, чтобы ускорить в вычислительном отношении интенсивные фрагменты кода MATLAB. Сгенерируйте MEX-функцию из своего кода MATLAB при помощи приложения MATLAB Coder или при помощи codegen в командной строке MATLAB.

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

Учебные файлы

Скопируйте учебные файлы с папки matlabroot\help\toolbox\coder\examples\euclidean к локальной рабочей папке. Здесь, matlabroot папка установки MATLAB, например, C:\Program Files\MATLAB\R2019a. Чтобы скопировать эти файлы в вашу текущую папку, запустите эту команду MATLAB:

copyfile(fullfile(matlabroot,'help','toolbox','coder','examples','euclidean'))

Локальная рабочая папка не может быть частной папкой или папка. Этот пример использует euclidean_data.mat, euclidean.m, test.m, test_2d.m, build_mex_fixed.m, и build_mex_variable.m файлы.

Файл данных MATLAB euclidean_data.mat содержит две части данных: одна точка в 3D Евклидово пространстве и наборе нескольких других точек в 3D Евклидово пространстве. Более в частности:
- x 3- 1 вектор-столбец, который представляет точку в 3D Евклидово пространстве.
- cb 3- 216 массив. Каждый столбец в cb представляет точку в 3D Евклидово пространстве.
ФАЙЛ MATLAB euclidean.m содержит функциональный euclidean это реализует основной алгоритм в этом примере. Функция берет x и cb как входные параметры. Это вычисляет Евклидово расстояние между x и каждая точка в cb и возвращает эти количества:
- Вектор-столбец y_min, который равен столбцу в cb это представляет точку, самую близкую к x.
- Вектор-столбец y_max, который равен столбцу в cb это представляет точку, самую дальнюю от x.
- 2-мерный векторный idx это содержит индексы столбца векторов y_min и y_max в cb.
- 2-мерный векторный distance это содержит расчетные наименьшие и самые большие расстояния до x.
```
function [y_min,y_max,idx,distance] = euclidean(x,cb)
% Initialize minimum distance as distance to first element of cb
% Initialize maximum distance as distance to first element of cb
idx(1)=1;
idx(2)=1;

distance(1)=norm(x-cb(:,1));
distance(2)=norm(x-cb(:,1));

% Find the vector in cb with minimum distance to x
% Find the vector in cb with maximum distance to x
for index=2:size(cb,2)
    d=norm(x-cb(:,index));
    if d < distance(1)
        distance(1)=d;
        idx(1)=index;
    end
    if d > distance(2)
        distance(2)=d;
        idx(2)=index;
    end
end

% Output the minimum and maximum distance vectors
y_min=cb(:,idx(1));
y_max=cb(:,idx(2));

end
```

test.m скрипта MATLAB загружает файл данных euclidean_data.mat в рабочую область. Это вызывает функциональный euclidean вычислить y_minymax idx , и distance. Скрипт затем отображает расчетные количества в командной строке.

Загрузка euclidean_data.mat шаг предварительной обработки, который выполняется прежде, чем вызвать основной алгоритм. Отображение результатов является шагом последующей обработки.

% Load test data 
load euclidean_data.mat

% Determine closest and farthest points and corresponding distances
[y_min,y_max,idx,distance] = euclidean(x,cb);

% Display output for the closest point
disp('Coordinates of the closest point are: ');
disp(num2str(y_min'));
disp(['Index of the closest point is ', num2str(idx(1))]);
disp(['Distance to the closest point is ', num2str(distance(1))]);

disp(newline);

% Display output for the farthest point
disp('Coordinates of the farthest point are: ');
disp(num2str(y_max'));
disp(['Index of the farthest point is ', num2str(idx(2))]);
disp(['Distance to the farthest point is ', num2str(distance(2))]);

test_2d.m скрипта MATLAB модификация test.m для точек в двумерном Евклидово пространстве. Содержимое test_2d.m показаны позже в примере, когда вы используете его, чтобы протестировать MEX-функцию на входные параметры переменного размера.
Скрипты сборки build_mex_fixed.m и build_mex_variable.m содержите команды для генерации статических библиотек C из вашего кода MATLAB, которые принимают фиксированный размер и входные параметры переменного размера, соответственно. Содержимое этих скриптов показывают позже в примере, когда вы генерируете код С.

Совет

Можно сгенерировать код от функций MATLAB при помощи MATLAB Coder. Генерация кода из скриптов MATLAB не поддержана.

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

Сгенерируйте MEX-функцию для функции MATLAB

Запустите оригинальный код MATLAB

Запустите тестовый скрипт test.m в MATLAB. Выход отображает yidx , и distance.

Coordinates of the closest point are: 
0.8         0.8         0.4
Index of the closest point is 171
Distance to the closest point is 0.080374


Coordinates of the farthest point are: 
0  0  1
Index of the farthest point is 6
Distance to the farthest point is 1.2923

Сделайте код MATLAB подходящим для генерации кода

Чтобы сделать ваш код MATLAB подходящим для генерации кода, вы используете Анализатор кода и Инструмент Готовности Генерации кода. Анализатор кода в редакторе MATLAB постоянно проверяет ваш код, когда вы вводите его. Это сообщает о проблемах и рекомендует модификациям максимизировать производительность и поддерживаемость. Инструмент Готовности Генерации кода экранирует код MATLAB на функции и функции, которые не поддерживаются для генерации кода.

Определенные встроенные функции MATLAB и функции тулбокса, классы и Системные объекты, которые поддерживаются для генерации кода C/C++, имеют определенные ограничения генерации кода. Эти ограничения и связанные указания по применению перечислены в разделах Extended Capabilities их соответствующих страниц с описанием. Для получения дополнительной информации смотрите Функции и Объекты, Поддержанные для Генерации кода C/C++.

Открытый euclidean.m в редакторе MATLAB. Индикатор сообщения Анализатора кода в правом верхнем углу редактора MATLAB является зеленым. Анализатор не обнаружил ошибки, предупреждения или возможности для улучшения кода.
После объявления функции добавьте %#codegen директива:
```
function [y,idx,distance] = euclidean(x,cb) %#codegen
```
%#codegen директива запрашивает Анализатор кода идентифицировать предупреждения и ошибки, характерные для генерации кода.
Индикатор сообщения Анализатора кода становится красным, указывая, что он обнаружил проблемы генерации кода.
Чтобы просмотреть предупреждающие сообщения, переместите свой курсор в подчеркнутые фрагменты кода. Предупреждения указывают, что генерация кода требует переменных idx и distance быть полностью заданным прежде, чем преобразовать их в нижний индекс. Это предупреждение появляется, потому что генератор кода должен определить размеры этих переменных в их первом выступлении в коде. Чтобы устранить эту проблему, используйте ones функционируйте, чтобы одновременно выделить и инициализировать эти массивы.
```
% Initialize minimum distance as distance to first element of cb
% Initialize maximum distance as distance to first element of cb
idx = ones(1,2);

distance = ones(1,2)*norm(x-cb(:,1));
```
Индикатор сообщения Анализатора кода становится зеленым снова, указывая, что он больше не обнаруживает проблемы генерации кода.
Для получения дополнительной информации об использовании Анализатора кода смотрите Контрольный код для Ошибок и Предупреждений (MATLAB).
Сохраните файл.
Чтобы запустить Инструмент Готовности Генерации кода, вызовите coder.screener функция из командной строки MATLAB:
```
coder.screener('euclidean')
```
Инструмент не обнаруживает проблем генерации кода для euclidean. Для получения дополнительной информации смотрите Инструмент Готовности Генерации кода.
Инструмент Готовности Генерации кода не поддержан в MATLAB Online™.
Примечание
Анализатор кода и Инструмент Готовности Генерации кода не могут обнаружить все проблемы генерации кода. После устранения ошибок или предупреждений, что эти инструменты обнаруживают, сгенерируйте код при помощи MATLAB Coder, чтобы определить, имеет ли ваш код MATLAB другие проблемы соответствия.

Вы теперь готовы скомпилировать свой код при помощи приложения MATLAB Coder. Здесь, compilation относится к генерации кода C/C++ из вашего кода MATLAB.

Примечание

Компиляция кода MATLAB относится к генерации кода C/C++ из кода MATLAB. В других контекстах термин компиляция мог отнестись к действию компилятора C/C++.

Определение входных типов

Поскольку C использует статический контроль типов, генератор кода должен определить класс, размер и сложность всех переменных в файлах MATLAB во время генерации кода, также известное как время компиляции. Поэтому, когда вы генерируете код для файлов, необходимо задать свойства всех входных параметров к функциям точки входа. entry-point function является функция MATLAB верхнего уровня, от которой вы генерируете код.

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

На следующем шаге вы используете codegen команда, чтобы сгенерировать файл MEX от вашей точки входа функционирует euclidean.

Сгенерируйте и подтвердите MEX-функцию

Скрипт сборки build_mex_fixed.m содержит команды, которые вы используете, чтобы сгенерировать и подтвердить MEX-функцию для euclidean.m. Чтобы подтвердить MEX-функцию, вы запускаете тестовый скрипт test с вызовами функции MATLAB euclidean замененный вызовами сгенерированной MEX-функции.

% Load the test data
load euclidean_data.mat
% Generate code for euclidean.m with codegen. Use the test data as example input. Validate MEX by using test.m.
codegen -report euclidean.m -args {x, cb} -test test

Обратите внимание на то, что:

По умолчанию, codegen генерирует MEX-функцию под названием euclidean_mex в текущей папке.
-report опция сообщает codegen чтобы сгенерировать генерацию кода сообщают, что можно использовать, чтобы отладить проблемы генерации кода и проверить, что код MATLAB подходит для генерации кода.
-args опция задает демонстрационные входные параметры к функции точки входа euclidean. Генератор кода использует эту информацию, чтобы определить класс, размер и сложность входных параметров.
Вы используете -test опция, чтобы запустить тестовый файл test.m. Эта опция заменяет вызовы euclidean в тестовом файле с вызовами euclidean_mex.

Для получения дополнительной информации об опциях генерации кода смотрите codegen.

Запустите скрипт сборки build_mex_fixed.m.
Генератор кода производит MEX-функцию euclidean_mex в текущей рабочей папке.
Выход:
```
Code generation successful: View report.
Running test file: 'test' with MEX function 'euclidean_mex'.
Coordinates of the closest point are: 
0.8         0.8         0.4
Index of the closest point is 171
Distance to the closest point is 0.080374


Coordinates of the farthest point are: 
0  0  1
Index of the farthest point is 6
Distance to the farthest point is 1.2923
```
Этот выход совпадает с выходом, который был сгенерирован исходной функцией MATLAB и проверяет MEX-функцию.
Чтобы просмотреть отчет генерации кода в Средстве просмотра Отчета, нажмите View report .
Если генератор кода обнаруживает ошибки или предупреждения во время генерации кода, отчет описывает проблемы и обеспечивает ссылки на проблематичный код MATLAB. См. Отчеты Генерации кода.

Совет

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

Сгенерируйте MEX-функцию для входных параметров Переменного Размера

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

Предположим, что вы хотите размерности x и cb в сгенерированной MEX-функции, чтобы иметь эти свойства:

Первая размерность обоих x и cb может отличаться по размеру до 3.
Второе измерение x фиксируется и имеет значение 1.
Второе измерение cb может отличаться по размеру до 216.

Чтобы задать эти входные свойства, вы используете coder.typeof функция. coder.typeof(A,B,1) задает вход переменного размера с тем же классом и сложностью как A и верхние границы, данные соответствующим элементом вектора размера B. Используйте скрипт сборки build_mex_variable.m это использует coder.typeof задавать свойства переменного размера вводит в сгенерированной MEX-функции.

% Load the test data
load euclidean_data.mat

% Use coder.typeof to specify variable-size inputs
eg_x=coder.typeof(x,[3 1],1);
eg_cb=coder.typeof(cb,[3 216],1);

% Generate code for euclidean.m using coder.typeof to specify
% upper bounds for the example inputs
codegen -report euclidean.m -args {eg_x,eg_cb}

Можно проверить что новая MEX-функция euclidean_mex принимает входные параметры размерностей, отличающихся от тех из x и cb. Тестовый скрипт test_2d.m создает входные массивы x2d и cb2d это - двумерные версии x и cb, соответственно. Это затем вызывает функцию MATLAB euclidean при помощи этих входных параметров.

% Load the test data
load euclidean_data.mat

% Create 2-D versions of x and cb
x2d=x(1:2,:);
cb2d=cb(1:2,1:6:216);

% Determine closest and farthest points and corresponding distances
[y_min,y_max,idx,distance] = euclidean(x2d,cb2d);

% Display output for the closest point
disp('Coordinates of the closest point are: ');
disp(num2str(y_min'));
disp(['Index of the closest point is ', num2str(idx(1))]);
disp(['Distance to the closest point is ', num2str(distance(1))]);

disp(newline);

% Display output for the farthest point
disp('Coordinates of the farthest point are: ');
disp(num2str(y_max'));
disp(['Index of the farthest point is ', num2str(idx(2))]);
disp(['Distance to the farthest point is ', num2str(distance(2))]);

Выполнение test_2d.m производит выход:

Coordinates of the closest point are: 
0.8         0.8
Index of the closest point is 29
Distance to the closest point is 0.078672


Coordinates of the farthest point are: 
0  0
Index of the farthest point is 1
Distance to the farthest point is 1.1357

Запускать тестовый скрипт test_2d.m с вызовами euclidean замененный вызовами euclidean_mex, используйте coder.runTest.

coder.runTest('test_2d','euclidean')

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

Следующие шаги

Цель	Больше информации
Узнайте о поддержке генерации кода встроенных функций MATLAB и функций тулбокса, классов и Системных объектов	Функции и Объекты, Поддержанные для Генерации кода C/C++
Создайте и отредактируйте входные типы в интерактивном режиме	Создайте и отредактируйте входные типы при помощи редактора типов кодера
Оптимизируйте скорость выполнения или использование памяти сгенерированного кода	Стратегии оптимизации
Узнайте об отчете генерации кода	Генерация кода сообщает
Смотрите времена выполнения и покрытие кода для сгенерированных MEX-функций в профилировщике MATLAB	Профилируйте MEX-функции при помощи профилировщика MATLAB

Документация