В этом примере вы используете MATLAB® Coder™
codegen команда, чтобы сгенерировать статическую библиотеку C для функции MATLAB. Вы сначала генерируете код С, который может принять только входные параметры, которые зафиксировали предписанный размер. Вы затем генерируете код С, который может принять входные параметры многих различных размеров.
Можно также сгенерировать код при помощи приложения MATLAB Coder. Для примера на этом рабочем процессе смотрите, Генерируют код С при помощи Приложения MATLAB Coder.
Скопируйте учебные файлы с папки matlabroot\help\toolbox\coder\examples\euclideanmatlabrootC:\Program Files\MATLAB\R2019a. Чтобы скопировать эти файлы в вашу текущую папку, запустите эту команду MATLAB:
copyfile(fullfile(matlabroot,'help','toolbox','coder','examples','euclidean'))
euclidean_data.mat, euclidean.m, test.m, build_lib_fixed.m, и build_lib_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))]);
Скрипты сборки build_lib_fixed.m и build_lib_variable.m содержите команды для генерации статических библиотек C из вашего кода MATLAB, которые принимают фиксированный размер и входные параметры переменного размера, соответственно. Содержимое этих скриптов показывают позже в примере, когда вы генерируете код С.
Можно сгенерировать код от функций MATLAB при помощи MATLAB Coder. Генерация кода из скриптов 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 и функции тулбокса, классы и Системные объекты, которые поддерживаются для генерации кода 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-функцию от своей функции точки входа. MEX-функция является сгенерированным кодом, который может быть назван из MATLAB. Вы запускаете MEX-функцию и проверяете, имеют ли сгенерированная MEX-функция и исходная функция MATLAB ту же функциональность.
Это - лучшая практика выполнить этот шаг, потому что можно обнаружить и зафиксировать ошибки времени выполнения, которые более трудно диагностировать в сгенерированном коде C. По умолчанию MEX-функция включает проверки целостности памяти. Эти проверки выполняют границы массивов и проверку размерности. Проверки обнаруживают нарушения целостности памяти в коде, сгенерированном для функций MATLAB. Для получения дополнительной информации смотрите Проверки на этапе выполнения Управления.
Чтобы преобразовать код MATLAB в эффективный исходный код C/C++, генератор кода вводит оптимизацию, которая, в определенных ситуациях, заставляет сгенерированный код вести себя по-другому, чем код первоисточника. Смотрите Различия Между Сгенерированным кодом и кодом MATLAB.
Сгенерируйте файл MEX для euclidean.m при помощи codegen команда. Чтобы проверить MEX-функцию, запустите тестовый скрипт test с вызовами функции MATLAB euclidean замененный вызовами сгенерированной MEX-функции.
codegen euclidean.m -args {x,cb} -test test
По умолчанию, codegen генерирует MEX-функцию под названием euclidean_mex в текущей папке.
Вы используете -args опция, чтобы задать демонстрационные входные параметры к точке входа функционирует euclidean. Генератор кода использует эту информацию, чтобы определить свойства входных параметров.
Вы используете -test опция, чтобы запустить тестовый файл test.m. Эта опция заменяет вызовы euclidean в тестовом файле с вызовами euclidean_mex.
Выход:
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
euclidean.
Скрипт сборки build_lib_fixed.m содержит команды, которые вы используете, чтобы сгенерировать код для euclidean.m.
% Load the test data load euclidean_data.mat % Generate code for euclidean.m with codegen. Use the test data as example input. codegen -report -config:lib euclidean.m -args {x, cb}
codegen читает файл euclidean.m и переводит код MATLAB в код С.
-report опция сообщает codegen чтобы сгенерировать генерацию кода сообщают, что можно использовать, чтобы отладить проблемы генерации кода и проверить, что код MATLAB подходит для генерации кода.
-config:lib опция сообщает codegen сгенерировать статическую библиотеку C вместо того, чтобы генерировать MEX-функцию по умолчанию.
-args опция сообщает codegen сгенерировать код для euclidean.m с помощью класса, размера и сложности демонстрационных входных параметров x и cb.
Вместо того, чтобы генерировать статическую библиотеку C, можно принять решение сгенерировать MEX-функцию или другие типы сборки C/C++ при помощи подходящих опций с codegen команда. Для получения дополнительной информации о различных опциях генерации кода смотрите codegen.
Запустите скрипт сборки.
MATLAB обрабатывает файл типа "build" и выводит сообщение:
Code generation successful: View report.euclidean Cwork\codegen\lib\euclideanworkЧтобы просмотреть отчет генерации кода в Средстве просмотра Отчета, нажмите View report .
Если генератор кода обнаруживает ошибки или предупреждения во время генерации кода, отчет описывает проблемы и обеспечивает ссылки на проблематичный код MATLAB. См. Отчеты Генерации кода.
Используйте скрипт сборки, чтобы сгенерировать код в командной строке. Скрипт сборки автоматизирует серию команд MATLAB, которые вы неоднократно выполняете в командной строке, экономя вам время и устранение входных ошибок.
Чтобы сравнить ваш сгенерированный код C с оригинальным кодом MATLAB, откройте файл C, euclidean.c, и euclidean.m файл в редакторе MATLAB.
Важная информация о сгенерированном коде C:
Функциональная подпись:
void euclidean(const double x[3], const double cb[648], double y_min[3], double
y_max[3], double idx[2], double distance[2])const double x[3] соответствует входу x в вашем коде MATLAB. Размер x 3, который соответствует общему размеру (3 x 1) примера вводит вас используемый когда вы сгенерированный код для вашего кода MATLAB.
const double cb[648] соответствует входу cb в вашем коде MATLAB. Размер cb 648, который соответствует общему размеру (3 x 216) примера вводит вас используемый когда вы сгенерированный код для вашего кода MATLAB. В этом случае сгенерированный код использует одномерный массив, чтобы представлять двумерный массив в коде MATLAB.
Сгенерированный код имеет четыре дополнительных входных параметра: массивы y_minymax idx , и distance. Эти массивы используются, чтобы возвратить выходные значения. Они соответствуют выходным аргументам y_minymax idx , и distance в оригинальном коде MATLAB.
Генератор кода сохраняет ваше имя функции и комментарии. Когда возможно, генератор кода сохраняет ваши имена переменных.
Если переменная в вашем коде MATLAB установлена в постоянное значение, это не появляется как переменная в сгенерированном коде C. Вместо этого сгенерированный код C содержит фактическое значение переменной.
С Embedded Coder® вы можете в интерактивном режиме проследить между кодом MATLAB и сгенерировали код C/C++. Смотрите В интерактивном режиме Трассировку Между кодом MATLAB и Сгенерированным Кодом C/C++ (Embedded Coder).
Функция C, которую вы сгенерировали для euclidean.m может принять только входные параметры, которые имеют тот же размер как демонстрационные входные параметры, которые вы задали во время генерации кода. Однако входные массивы к соответствующей функции MATLAB могут иметь любой размер. В этой части примера вы генерируете код С от euclidean.m это принимает входные параметры переменного размера.
Предположим, что вы хотите размерности x и cb в сгенерированном коде C, чтобы иметь эти свойства:
Первая размерность обоих x и cb может отличаться по размеру до 3.
Второе измерение x фиксируется и имеет значение 1.
Второе измерение cb может отличаться по размеру до 216.
Чтобы задать эти входные свойства, используйте coder.typeof функция. coder.typeof(A,B,1) задает вход переменного размера с тем же классом и сложностью как A и верхние границы, данные соответствующим элементом вектора размера B. Используйте скрипт сборки build_lib_variable.m это использует coder.typeof задавать свойства переменного размера вводит в сгенерированной библиотеке C.
% 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 -config:lib euclidean.m -args {eg_x,eg_cb}
Можно теперь сгенерировать код путем выполнения тех же шагов как прежде. Функциональная подпись для сгенерированного кода C в euclidean.c теперь чтения:
void euclidean(const double x_data[], const int x_size[1], const double cb_data[],
const int cb_size[2], double y_min_data[], int y_min_size[1],
double y_max_data[], int y_max_size[1], double idx[2], double
distance[2])x_data, cb_data, y_min_data, и y_max_data соответствуйте входным параметрам x и cb и выходные аргументы y_min и y_max в исходной функции MATLAB. Функция C теперь принимает четыре дополнительных входных параметра x_size, cb_size, y_min_size и y_max_size это задает размеры x_data, cb_data, y_min_data, и y_max_data во время выполнения.| Цель | Больше информации |
|---|---|
Узнайте о поддержке генерации кода встроенных функций MATLAB и функций тулбокса, классов и Системных объектов | |
Создайте и отредактируйте входные типы в интерактивном режиме | Создайте и отредактируйте входные типы при помощи редактора типов кодера |
Сгенерируйте и измените пример C основная функция и используйте ее, чтобы создать исполняемую программу C | |
Пакет сгенерировал файлы в сжатый файл | |
Оптимизируйте скорость выполнения или использование памяти сгенерированного кода | |
Интегрируйте свой пользовательский код C/C++ в сгенерированный код | |
Узнайте об отчете генерации кода | В интерактивном режиме Проследите Между кодом MATLAB и Сгенерированным Кодом C/C++ (Embedded Coder) |