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

Что необходимо знать

Чтобы завершить этот пример, у вас должно быть основное знакомство с программным обеспечением MATLAB.

Необходимые продукты

Чтобы завершить этот пример, необходимо установить следующие продукты:

Для получения инструкций по установке Продуктов Mathworks обратитесь к документации по установке. Если вы установили MATLAB и хотите проверить, который установлены другие Продукты Mathworks, введите ver в Окно Команды MATLAB.

Описание

Евклидово расстояние между точками p и q является продолжительностью линейного сегмента $$\stackrel{pq¯}{}$$. В Декартовых координатах, если $$p=({}_{\mathrm{p1}},{}_{\mathrm{p2}\mathrm{...},}{}_{\mathrm{pn})}$$ и $$q=({}_{\mathrm{q1}},{}_{\mathrm{q2}\mathrm{...},}{}_{\mathrm{qn})}$$ являются двумя точками на Евклидовом n-пробеле, то расстоянием от p до q дают:

В одной размерности, расстоянии между двумя точками, x1 и x2, на строке просто абсолютное значение различия между двумя точками:

В двух измерениях расстояние между $$p=({}_{\mathrm{p1}},{}_{\mathrm{p2}})$$ и $$q=({}_{\mathrm{q1}},{}_{\mathrm{q2}})$$: $$\sqrt{{{}_{\mathrm{}}{}_{\mathrm{}}(p1-q1)}^2+{{}_{\mathrm{}}{}_{\mathrm{}}(p2-q2)}^2}$$

Пример для этого примера вычисляет минимальное Евклидово расстояние между вектором - столбцом x и набором векторов - столбцов в матрице книги шифров cb. Функция имеет три выходных переменные:

Алгоритм

Этот алгоритм вычисляет минимальное Евклидово расстояние между вектором - столбцом x и набором векторов - столбцов в матрице книги шифров cb. Алгоритм вычисляет минимальное расстояние до x и находит вектор - столбец в cb, который является самым близким к x. Это выводит этот вектор - столбец, y, его индекс, idx, в cb, и расстоянии, расстоянии между x и y.

Функциональная подпись для алгоритма:

function [y,idx,distance] = euclidean(x,cb)

Минимальное расстояние первоначально установлено в первый элемент cb.

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

Минимальный расчет расстояния выполняется в for - цикл.

for index=2:size(cb,2)
    d=norm(x-cb(:,index));
    if d < distance
        distance=d;
        idx=index;
    end
end

Вывод y установлен в минимальный вектор расстояния.

y=cb(:,idx);

Об учебных файлах

Пример использует следующие файлы:

Местоположение файлов

Учебные файлы доступны в следующей папке: docroot\toolbox\coder\examples\euclidean. Чтобы запустить пример, необходимо скопировать эти файлы в локальную папку. Для инструкций смотрите Копирование Файлов Локально.

Имена и описания файлов

Копирование файлов локально

Скопируйте учебные файлы в папку локальных решений и создайте локальную рабочую папку:

Выполнение оригинального кода MATLAB

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

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

Куда Пойти Затем.  Прежде, чем продолжить пример, необходимо настроить компилятор C, как детализировано в Подготовке компилятора C.

Подготовка вашего компилятора C

MATLAB CODER автоматически определяет местоположение и использует поддерживаемый установленный компилятор. Для текущего списка поддерживаемых компиляторов см. Поддерживаемые и Совместимые Компиляторы на веб-сайте MathWorks.

Можно использовать mex -setup, чтобы изменить компилятор по умолчанию. См. Компилятор Значения по умолчанию Изменения (MATLAB).

Факторы для того, чтобы сделать ваш код совместимым

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

Проверка Проблемы во Время проектирования.  Существует два инструмента, которые помогают вам обнаружить проблемы генерации кода во время проектирования: анализатор кода и инструмент готовности генерации кода.

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

Чтобы использовать анализатор кода, чтобы идентифицировать предупреждения и ошибки, характерные для MATLAB для генерации кода, необходимо добавить директиву %#codegen (или прагма) к файлу MATLAB. Полный список MATLAB для сообщений анализатора кода Генерации кода доступен в настройках Анализатора КОДА MATLAB. Смотрите Выполнение Отчета Анализатора кода (MATLAB) для получения дополнительной информации.

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

Можно получить доступ к инструменту готовности генерации кода следующими способами:

Проверка Проблемы во Время Генерации кода.  Можно использовать codegen, чтобы проверить на проблемы во время генерации кода. codegen проверяет, что ваш код MATLAB подходит для генерации кода.

Когда codegen обнаруживает ошибки или предупреждения, он автоматически генерирует сообщение об ошибке, которое описывает проблемы и обеспечивает ссылки на оскорбление код MATLAB. Для получения дополнительной информации см. Отчеты Генерации кода.

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

Проверка Проблемы во Время выполнения.  Можно использовать codegen, чтобы сгенерировать MEX-функцию и проверку на проблемы во время выполнения. В моделировании код, сгенерированный для ваших функций MATLAB, включает проверки на этапе выполнения. Отключение проверок на этапе выполнения и внешних вызовов обычно приводит к оптимизированному сгенерированному коду и более быстрому моделированию. Вы управляете проверками на этапе выполнения с помощью объекта настройки MEX, coder.MexCodeConfig. Для получения дополнительной информации смотрите Проверки на этапе выполнения Управления.

Если вы сталкиваетесь с ошибками времени выполнения в своих функциях MATLAB, стек этапа выполнения появляется автоматически в Окне Команды MATLAB. Смотрите Ошибки времени выполнения Отладки.

Куда Пойти Затем.  Следующий раздел примера, Делая Ваш Код Подходящим для Генерации кода, показывает вам, как использовать анализатор кода MATLAB и codegen, чтобы сделать ваш код подходящим для генерации кода.

Создание КОДА MATLAB, подходящего для генерации кода

• Создание кода, подходящего для генерации кода

Создание Кода, Подходящего для Генерации кода.  Чтобы начать процесс создания вашего кода MATLAB, подходящего для генерации кода, вы работаете с файлом euclidean01.m. Этот файл является версией MATLAB трехмерного Евклидова примера, который строит график расстояний между входным вектором x и каждым из векторов в матрице книги шифров cb. Это определяет, какой вектор в cb является самым близким к x и выводит этот вектор, его положение в cb и расстояние до y.

Генерация MEX-функции Используя codegen

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

Используя codegen.  Поскольку C использует статический контроль типов, codegen должен определить свойства всех переменных в файлах MATLAB во время компиляции. Поэтому необходимо задать свойства всех входных параметров функции в то же время, что и вы компилируете файл с codegen. Чтобы скомпилировать euclidean02.m, необходимо задать размер входного вектора x и матрица книги шифров cb.

MATLAB CODER обрабатывает общие функции визуализации MATLAB как внешние. Это не генерирует код для этих функций. Вместо этого для MEX-функции это генерирует код, чтобы запустить функцию в MATLAB. Эти функции включают line, grid, clf, axis и pause. Отчет подсвечивает внешние функции. Если функция не поддерживается для генерации кода и не обработана как внешняя, необходимо явным образом объявить, что функция является внешней при помощи coder.extrinsic. Смотрите Внешние Функции.

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

Проверка MEX-функции

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

Выполнение сгенерированной MEX-функции

Используя сборку и тестовые скрипты

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

 Почему скрипты сборки использования?

 Почему тестовые скрипты использования?

Изменение Кода, чтобы Удалить Функцию plot.  В файле euclidean02.m m:

 Содержимое euclidean03. m

function [y,idx,distance] = euclidean03(x,cb) %#codegen
% Initialize minimum distance as first element of cb
idx=1;
distance=norm(x-cb(:,1));
% Find the vector in cb with minimum distance to x
for index=2:size(cb,2)
    d=norm(x-cb(:,index));
    if d < distance
        distance=d;
        idx=index;
    end
end
% Output the minimum distance vector
y=cb(:,idx);
end

Используя Скрипт build01 Сборки. m  . Затем вы используете скрипт сборки build01.m, который компилирует euclidean03.m с помощью codegen. Используйте опцию -report, которая сообщает, что codegen, чтобы сгенерировать генерацию кода сообщает, что можно использовать, чтобы отладить код MATLAB и проверить, что это подходит для генерации кода.

 Лучшая практика — генерация отчета генерации кода

 Содержимое Файла типа "build" build01. m

% Load the test data
load euclidean.mat
% Compile euclidean03.m with codegen
codegen -report euclidean03.m -args {x(:,1), cb}

В подсказке команды MATLAB войдите:

build01

Вы готовы протестировать MEX-функцию euclidean03_mex.

Используя Тестовый скрипт test01. m  . Вы используете тестовый скрипт test01.m, чтобы протестировать MEX-функцию euclidean03_mex.

Тестовый скрипт:

 Содержимое Тестового скрипта test01. m

% Load test data 
load euclidean.mat
% Take a single input vector from the matrix x 
x1=x(:,1);
% Run the original MATLAB function
disp('Running MATLAB function euclidean03');
[y, idx, distance] = euclidean03(x1,cb);
disp(['y = ', num2str(y')]);
disp(['idx = ', num2str(idx)]);
disp(['distance = ', num2str(distance)]);
% Visualize the distance minimization
% plot_distances
clf;
for index=1:size(cb,2)
line([x(1,1) cb(1,index)], [x(2,1) cb(2,index)], ...
  [x(3,1) cb(3,index)]);
end
axis([0 1 0 1 0 1]);grid;
pause(.5);
% Run the MEX function euclidean03_mex
disp('Running MEX function euclidean03_mex');
[y, idx, distance] = euclidean03_mex(x1,cb);
disp(['y = ', num2str(y')]);
disp(['idx = ', num2str(idx)]);
disp(['distance = ', num2str(distance)]);
% Visualize the distance minimization
% plot_distances
clf;
for index=1:size(cb,2)
line([x(1,1) cb(1,index)], [x(2,1) cb(2,index)], ...
  [x(3,1) cb(3,index)]);
end
axis([0 1 0 1 0 1]);grid;
pause(.5);

Выполнение Тестового скрипта.  В подсказке команды MATLAB войдите:

test01

Выполнения тестового файла, строит графики от x1 до каждого вектора в cb и выходные параметры:

Running MATLAB function euclidean03
y = 0.8         0.8         0.4
idx = 171
distance = 0.080374
Running MEX function euclidean03_mex
y = 0.8         0.8         0.4
idx = 171
distance = 0.080374

Вы теперь готовы начать следующую задачу в этом примере, Изменяя Алгоритм, чтобы Принять Вводы Переменного Размера.

Изменение алгоритма, чтобы принять вводы Переменного Размера

Почему Изменяют Алгоритм?.  Алгоритм, который вы использовали до сих пор в этом примере, подходит только для входных параметров процесса, размерности которых совпадают с размерностями входных параметров в качестве примера, обеспеченных с помощью опции -args. В этой части примера вы запускаете euclidean03_mex, чтобы видеть, что это не принимает двумерные входные параметры. Вы затем перекомпилировали свой код с помощью двумерных входных параметров в качестве примера и тестируете получившуюся MEX-функцию с двумерными входными параметрами.

О сборке и тестовых скриптах

 Содержимое test02. m

% Load the test data
load euclidean.mat

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

% Run euclidean03_mex with these 2-D inputs
disp('Attempting to run euclidean03_mex with 2-D inputs');
[y, idx, distance] =  euclidean03_mex(x2d,cb2d);

 Содержимое build02. m

% Load the test data
load euclidean.mat
% Create 2-D versions of x and cb
x2=x(1:2,:);
x2d=x2(:,47);
cb2d=cb(1:2,1:6:216);
% Recompile euclidean03 with 2-D example inputs
% The -o option instructs codegen to name the MEX function euclidean03_2d
disp('Recompiling euclidean03.m with 2-D example inputs');
codegen -o euclidean03_2d -report euclidean03.m -args {x2d, cb2d};

 Содержимое test03. m

% Load input data
load euclidean.mat
% Create 2-D versions of x and cb
x2=x(1:2,:);
x2d=x2(:,47);
cb2d=cb(1:2,1:6:216);
% Run new 2-D version of euclidean03
disp('Running new 2-D version of MEX function');
[y, idx, distance] = euclidean03_2d(x2d, cb2d);
disp(['y = ', num2str(y')]);
disp(['idx = ', num2str(idx)]);
disp(['distance = ', num2str(distance)]);

Выполнение сборки и тестовых скриптов

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

Определение Вводов Переменного Размера.  Исходная функция MATLAB подходит для многих различных входных параметров размера. Чтобы обеспечить эту ту же гибкость в вашем сгенерированном коде C, используйте coder.typeof с параметром командной строки codegen -args.

coder.typeof(a,b,1) задает входной параметр переменного размера с тем же классом и сложностью как a и тот же размер и верхние границы как вектор размера b. Для получения дополнительной информации смотрите, Задают Вводы Переменного Размера в Командной строке.

Определение верхних границ для локальных переменных

В этой части примера вы изменяете алгоритм, чтобы вычислить только расстояние между первыми элементами N данного векторного x и первыми элементами N каждого вектора - столбца в матричном cb.

Чтобы изменить Евклидов минимальный алгоритм расстояния, euclidean03.m, чтобы разместить изменения в размерностях, по которым можно вычислить расстояния:

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