В этом примере показано, как разработать библиотеку замены кода для оптимизации эффективности математических функций путем предоставления информации о том, как задать замену кода для sin
функция. Для разработки библиотеки замещения кода используйте интерактивный или программный подход. Для получения дополнительной информации см. раздел «Разработка библиотеки замещения кода».
Откройте Code Replacement Tool (crtool) из командной строки MATLAB с помощью следующей команды:
>>crtool
Составьте таблицу.
В контекстном меню crtool выберите File > New Table.
На правой панели назовите таблицу crl_table_sin
. Нажмите Apply.
Создайте запись. В контекстном меню crtool выберите File > New entry > Function.
Создайте параметры входа. В раскрывающемся списке Function выберите sin
. Информация об алгоритме появляется в crtool. В данном примере оставьте параметр неустановленным.
Создайте концептуальное представление. Концептуальное представление описывает сигнатуру функции, которую вы хотите заменить. В Conceptual function подразделе crtool задайте возвращаемый аргумент y1 и входного параметра u1 с Data Type double и Argument Type Скаляра.
Создайте представление реализации. Представление реализации описывает сигнатуру оптимизационной функции. В данном примере, чтобы указать, что аргументы реализации имеют тот же порядок и свойства, что и концептуальные аргументы, установите флажок Make conceptual and implementation argument types the same.
Укажите сведения о сборке. Перейдите на вкладку Build Information, чтобы открыть панель Requirements к сборке. Укажите файлы (источник, заголовок, объект), которые требуется генератору кода для замены кода. В данном примере вам не нужно указывать информацию о сборке.
Проверьте и сохраните таблицу. Щелкните вкладку Mapping Information и проверьте заполнение полей как показано на рисунке. Нажмите Validate entry. В контекстном меню crtool выберите File > Save table > Save.
Зарегистрируйте библиотеку замещения кода. Регистрация создает библиотеку, состоящую из заданных таблиц. Выберите File > Generate registration file. В диалоговом окне Сгенерировать файл регистрации заполните следующие поля:
Чтобы использовать библиотеку замены кода, обновите текущий сеанс работы с MATLAB командой:
>>sl_refresh_customizations
Проверьте библиотеку замещения кода. Из командной строки MATLAB откройте библиотеку с помощью Code Replacement Viewer и проверьте, что таблица и запись заданы правильно. Дополнительные сведения см. в разделе Проверка библиотеки замещения кода. Сконфигурируйте модель, чтобы использовать библиотеку замены кода, сгенерировать код и проверить, что замена происходит должным образом. Если происходит непредвиденное поведение, исследуйте журналы попадания и пропуска, чтобы устранить проблемы.
Откройте программный интерфейс из меню MATLAB, выбрав New > Function.
Составьте таблицу.
Создайте функцию с именем таблицы библиотеки замещения кода, которая не имеет аргументов и возвращает объект таблицы. Можно использовать эту функцию для вызова таблицы библиотеки замещения кода.
Создайте объект таблицы путем вызова RTW.TflTable
.
function hTable = crl_table_sin % Create a function to call the code replacement library table %% Create a table object hTable = RTW.TflTable;
Создайте запись. Поскольку этот пример заменяет функцию, создайте запись замены кода в вашей таблице, вызвав функцию entry RTW.TflCFunctionEntry
.
function hTable = crl_table_sin % Create a code replacement library table %% Create a table object hTable = RTW.TflTable; %% Create an entry hEntry = rtw.TflCFunctionEntry;
Создайте параметры входа. Поскольку эти примеры заменяют функцию, создайте параметры входа путем вызова функции setTflCFunctionEntryParameters
.
function hTable = crl_table_sin() % Create a code replacement library table %% Create a table object hTable = RTW.TflTable; %% Create an entry hEntry = RTW.TflCFunctionEntry; %% Create entry parameters hEntry.setTflCFunctionEntryParameters(... 'Key', 'sin', ... 'Priority', 30, ... 'ImplementationName', 'mySin', ... 'ImplementationHeaderFile', 'basicMath.h', ... 'ImplementationSourceFile', 'basicMath.c');
Создайте концептуальное представление. Концептуальное представление описывает сигнатуру функции, которую вы хотите заменить. Чтобы явным образом задать свойства аргумента, вызовите функцию createAndAddConceptualArg
.
function hTable = crl_table_sin() % Create a code replacement library table %% Create a table object hTable = RTW.TflTable; %% Create an entry hEntry = RTW.TflCFunctionEntry; %% Create entry parameters hEntry.setTflCFunctionEntryParameters(... 'Key', 'sin', ... 'Priority', 30, ... 'ImplementationName', 'mySin', ... 'ImplementationHeaderFile', 'basicMath.h', ... 'ImplementationSourceFile', 'basicMath.c'); %% Create the conceptual representation hEntry.createAndAddConceptualArg(... 'RTW.TflArgNumeric', ... 'Name', 'y1',... 'IOType', 'RTW_IO_OUTPUT',... 'DataTypeMode', 'double'); hEntry.createAndAddConceptualArg(... 'RTW.TflArgNumeric', ... 'Name', 'u1', ... 'IOType', 'RTW_IO_INPUT',... 'DataTypeMode', 'double');
Создайте представление реализации. Представление реализации описывает сигнатуру оптимизационной функции. Чтобы указать, что аргументы реализации имеют тот же порядок и свойства, что и концептуальные аргументы, вызовите функцию copyConceptualArgsToImplementation
. Добавьте полную запись в таблицу путем вызова функции addEntry
.
function hTable = crl_table_sin() % Create a code replacement library table %% Create a table object hTable = RTW.TflTable; %% Create an entry hEntry = RTW.TflCFunctionEntry; %% Create entry parameters hEntry.setTflCFunctionEntryParameters(... 'Key', 'sin', ... 'Priority', 30, ... 'ImplementationName', 'mySin', ... 'ImplementationHeaderFile', 'basicMath.h', ... 'ImplementationSourceFile', 'basicMath.c'); %% Create the conceptual representation hEntry.createAndAddConceptualArg(... 'RTW.TflArgNumeric', ... 'Name', 'y1',... 'IOType', 'RTW_IO_OUTPUT',... 'DataTypeMode', 'double'); hEntry.createAndAddConceptualArg(... 'RTW.TflArgNumeric', ... 'Name', 'u1', ... 'IOType', 'RTW_IO_INPUT',... 'DataTypeMode', 'double'); %% Create the Implementation Representation copyConceptualArgsToImplementation(hEntry); %% Add the entry to the table hTable.addEntry(hEntry);
Укажите сведения о сборке. В параметрах входа укажите файлы (заголовок, источник, объект), которые нужны генератору кода для замены кода. В данном примере информация о сборке не требуется.
Проверьте и сохраните файл индивидуальной настройки. В меню MATLAB сохраните этот файл индивидуальной настройки, выбрав File > Save. В командной строке проверьте таблицу библиотеки замещения кода, вызвав ее:
>> hTable = crl_table_sin
Зарегистрируйте библиотеку замещения кода. Регистрация создает библиотеку замещения кода путем определения имени библиотеки, таблиц замещения кода и другой информации. Создайте файл регистрации (новый файл функции) с этими спецификациями:
function rtwTargetInfo(cm) cm.registerTargetInfo(@loc_register_crl); end function this = loc_register_crl this(1) = RTW.TflRegistry; this(1).Name = 'CRL for sin function replacement’; this(1).TableList = {'crl_table_sin.m'}; % table created in this example this(1).TargetHWDeviceType = {'*'}; this(1).Description = 'Example code replacement library'; end
Чтобы использовать библиотеку замены кода, обновите текущий сеанс работы с MATLAB командой:
>>sl_refresh_customizations
Проверьте библиотеку замещения кода. Из командной строки MATLAB откройте библиотеку с помощью Code Replacement Viewer и проверьте, что таблица и запись заданы правильно. Дополнительные сведения см. в разделе Проверка библиотеки замещения кода. Сконфигурируйте модель, чтобы использовать библиотеку замены кода, сгенерировать код и проверить, что замена происходит должным образом. Если происходит непредвиденное поведение, исследуйте журналы попадания и пропуска, чтобы устранить проблемы.
В этом разделе вы генерируете код с помощью библиотеки замены кода, которую вы создали в первых двух разделах этого примера. Математическая функция sin
заменяется вызовом пользовательской функции в сгенерированном коде. Этот пример не предоставляет функцию реализации. Напишите свою собственную реализацию.
Пример модели
Откройте модель crl_mathfunction
для настройки библиотеки замещения кода.
open_system('crl_mathfunction'); copyfile mathFnRtwTargetInfo.txt rtwTargetInfo.m
Запустите файл индивидуальной настройки MATLAB, чтобы создать таблицу замещения кода и зарегистрировать файл. Файл индивидуальной настройки уже выполнен. Запустите функцию sl_refresh_customizations, чтобы зарегистрировать библиотеку.
sl_refresh_customizations;
Включите библиотеку замещения кода
Откройте диалоговое окно Параметры конфигурации.
На панели Интерфейс установите библиотеку замещения кода нажав Выбрать и добавить CRL for sin function replacement
к библиотекам замены выбранного кода - приоритетная панель списка. Также используйте API командной строки, чтобы включить замену кода:
set_param('crl_mathfunction', 'CodeReplacementLibrary', 'CRL for sin function replacement');
Сгенерируйте код из модели:
evalc('rtwbuild(''crl_mathfunction'')');
Просмотрите сгенерированный код. Вот фрагмент crl_mathfunction.c
.
cfile = fullfile('crl_mathfunction_ert_rtw','crl_mathfunction.c'); rtwdemodbtype(cfile,'/* Model step function ','/* Model initialize function',1, 1);
/* Model step function */ void crl_mathfunction_step(void) { /* Outport: '<Root>/Y1' incorporates: * Inport: '<Root>/U1' * Trigonometry: '<Root>/Trigonometric Function' */ crl_mathfunction_Y.Y1 = mySin(crl_mathfunction_U.U1); }
The sin
функция заменена на пользовательскую mysin
функция.
Закройте модель и отчет о генерации кода.
delete ./rtwTargetInfo.m bdclose('crl_mathfunction'); rtwdemoclean;