主要内容

在命令行生成C代码

在本教程中,您将使用MATLAB®编码器™codegen命令生成一个MATLAB函数的静态C库。首先生成C代码,它只能接受具有固定预先分配大小的输入。然后生成可以接受许多不同大小输入的C代码。

也可以使用MATLAB编码器有关这个工作流程的教程,请参阅使用MATLAB Coder App生成C代码

教程文件

从文件夹中复制教程文件matlabroot帮助\ \工具箱\编码器\ \欧几里得例子到本地工作文件夹。在这里,matlabroot是MATLAB安装文件夹,例如,C:\Program Files\MATLAB\R2019a.要将这些文件复制到当前文件夹,运行MATLAB命令:

拷贝文件(fullfile (matlabroot,“帮助”“工具箱”“编码器”“例子”“欧几里得”))
本地工作文件夹不能为私有文件夹或@文件夹。本教程使用euclidean_data.mateuclidean.mtest.mbuild_lib_fixed.m,build_lib_variable.m文件。

  • MATLAB数据文件euclidean_data.mat包含两部分数据:三维欧几里得空间中的一个点和三维欧几里得空间中其他几个点的集合。更具体地说:

    • x是一个3.——- - - - - -1表示三维欧几里得空间中的一点的列向量。

    • cb是一个3.——- - - - - -216数组中。每一列中cb表示三维欧几里得空间中的一点。

  • MATLAB文件euclidean.m包含的功能欧几里得实现核心算法在这个例子中。的函数xcb作为输入。它计算的是欧氏距离x每个点cb然后返回这些量:

    • 列向量y_min,它等于列cb这表示最接近的点x

    • 列向量y_max,它等于列cb这表示距离最远的点x

    • 二维向量idx它包含向量的列指标y_miny_maxcb

    • 二维向量距离包含了计算到的最小距离和最大距离x

    函数[y_min, y_max idx,距离]=欧几里得(x, cb)%初始化最小距离为cb的第一个元素的距离%初始化最大距离为cb的第一个元素的距离idx (1) = 1;idx (2) = 1;距离(1)=规范(x-cb (: 1));距离(2)=规范(x-cb (: 1));求在cb中距离x最小的向量求在cb中距离x最大的向量指数= 2:尺寸(cb, 2) d =规范(x-cb(:,指数));如果距离(1)= D;idx(1) =指数;结束如果D >距离(2)距离(2)= D;idx(2) =指数;结束结束%输出最小和最大距离向量y_min = cb (:, idx (1));y_max = cb (:, idx (2));结束
  • MATLAB脚本test.m加载数据文件euclidean_data.mat进入工作区。然后调用该函数欧几里得计算y_miny_maxidx,距离.然后脚本在命令行显示计算的数量。

    加载euclidean_data.mat是在调用核心算法之前执行的预处理步骤。显示结果是后处理步骤。

    负载试验数据负载euclidean_data.mat%确定最近和最远的点和相应的距离[y_min, y_max idx,距离]=欧几里得(x, cb);%显示最近点的输出disp (最近点的坐标是);disp (num2str (y_min '));disp (['最近点的索引是'num2str (idx (1))));disp ([“到最近点的距离是”num2str(距离(1))));disp(换行符);%显示最远点的输出disp (“最远点的坐标是:”);disp (num2str (y_max '));disp (['最远点的索引是'num2str (idx (2))));disp ([“到最远点的距离是”num2str(距离(2))));
  • 构建脚本build_lib_fixed.mbuild_lib_variable.m包含从MATLAB代码生成静态C库的命令,分别接受固定大小和可变大小的输入。在稍后生成C代码时,将显示这些脚本的内容。

提示

您可以使用MATLAB函数生成代码MATLAB编码器.不支持从MATLAB脚本生成代码。金宝app

使用测试脚本将预处理和后处理步骤从实现核心算法的函数中分离出来。这种做法使您能够轻松地重用算法。您可以为实现核心算法的MATLAB函数生成代码。您不为测试脚本生成代码。

生成C代码MATLAB函数

运行原MATLAB代码

运行测试脚本test.m在MATLAB。输出显示yidx,距离

最近点坐标为:0.8 0.8 0.4最近点指数为171到最近点的距离为0.080374最远点坐标为:0 0 1最远点指数为6到最远点的距离为1.2923

使MATLAB适合代码生成的代码

为了使您的MATLAB代码适合于代码生成,您可以使用代码分析器和代码生成准备工具。当你输入代码时,MATLAB编辑器中的代码分析器会不断地检查你的代码。它报告问题并建议修改,以最大限度地提高性能和可维护性。代码生成准备工具会筛选MATLAB代码中不支持代码生成的特性和函数。金宝app

C/ c++代码生成支持的某些MATLAB内置函数和工具箱函数、类和System对象具有特定的代码生成限制。金宝app这些限制和相关的使用说明列在扩展功能对应参考页的部分。有关更多信息,请参见C/ c++代码生成支持的函数和对象金宝app

  1. 开放euclidean.m在MATLAB编辑器中。MATLAB Editor右上角的Code Analyzer消息指示器是绿色的。分析器没有检测到代码中的错误、警告或改进机会。

  2. 在函数声明之后,添加% # codegen指令:

    函数[y, idx,距离]=欧几里得(x, cb)% # codegen
    % # codegen指令提示代码分析器识别特定于代码生成的警告和错误。

    Code Analyzer消息指示器变为红色,表明它已检测到代码生成问题。

  3. 若要查看警告消息,请将光标移动到带下划线的代码片段。警告表明代码生成需要这些变量idx距离在下标之前完全定义。出现这些警告是因为代码生成器必须在这些变量第一次出现在代码中时确定它们的大小。要修复此问题,请使用函数同时分配和初始化这些数组。

    %初始化最小距离为cb的第一个元素的距离%初始化最大距离为cb的第一个元素的距离idx = 1(1、2);距离= 1(1、2)*规范(x-cb (: 1));

    Code Analyzer消息指示器再次变为绿色,表明它不再检测到任何代码生成问题。

    有关使用代码分析器的更多信息,请参见使用代码分析器检查代码中的错误和警告

  4. 保存文件。

  5. 要运行代码生成准备工具,请调用coder.screener函数从MATLAB命令行。

    coder.screener (“欧几里得”

    该工具不检测任何代码生成问题欧几里得.有关更多信息,请参见代码生成准备工具

    中不支持代码生成准备工具金宝appMATLAB在线™

    请注意

    代码分析器和代码生成准备工具可能无法检测到所有的代码生成问题。在消除这些工具检测到的错误或警告之后,使用MATLAB编码器以确定您的MATLAB代码是否有其他遵从性问题。

现在可以使用MATLAB编码器应用。在这里,编译指的是从MATLAB代码生成C/ c++代码。

请注意

MATLAB代码的编译是指从MATLAB代码中生成C/ c++代码。在其他情况下,术语编译可以指C/ c++编译器的操作。

定义输入类型

由于C使用静态类型,代码生成器必须在代码生成时确定MATLAB文件中所有变量的类、大小和复杂性,也称为编译时.因此,在为文件生成代码时,必须指定入口点函数的所有输入参数的属性。一个入口点函数是用于生成代码的顶级MATLAB函数。

方法生成代码时codegen命令,可以使用arg游戏选择指定样本输入参数的入口点函数。代码生成器使用此信息来确定输入参数的属性。

在下一步中,您将使用codegen命令从入口点函数生成MEX文件欧几里得

检查运行时问题

从入口点函数生成MEX函数。MEX函数生成的代码可以从MATLAB内部调用。运行MEX函数,检查生成的MEX函数与原始MATLAB函数是否具有相同的功能。

执行此步骤是最佳实践,因为您可以检测和修复生成的C代码中较难诊断的运行时错误。默认情况下,MEX函数包括内存完整性检查。这些检查执行数组边界和维度检查。该检查检测为MATLAB函数生成的代码中内存完整性的违反。有关更多信息,请参见控制运行时检查

为了将MATLAB代码转换为高效的C/ c++源代码,代码生成器引入了优化,在某些情况下,会导致生成的代码的行为与原始源代码不同。看到生成代码与MATLAB代码的区别

  1. 生成一个MEX文件euclidean.m通过使用codegen命令。要验证MEX函数,运行测试脚本测试调用MATLAB函数欧几里得替换为对生成的MEX函数的调用。

    codegeneuclidean.marg游戏{x, cb}以及测试

    • 默认情况下,codegen生成一个名为euclidean_mex在当前文件夹中。

    • 您使用arg游戏选择指定样本输入参数的入口点功能欧几里得.代码生成器使用此信息来确定输入参数的属性。

    • 您使用以及选项以运行测试文件test.m.这个选项替换了对的调用欧几里得在测试文件中调用euclidean_mex

    的输出是:

    运行测试文件:'test'和MEX函数'euclidean_mex'。最近点坐标为:0.8 0.8 0.4最近点指数为171到最近点的距离为0.080374最远点坐标为:0 0 1最远点指数为6到最远点的距离为1.2923
    此输出与原始MATLAB函数生成的输出相匹配,并验证MEX函数。现在,您已经准备好生成独立的C代码欧几里得

请注意

在从MATLAB代码生成独立的C/ c++代码之前,生成一个MEX函数。运行生成的MEX函数,并确保它具有与MATLAB函数相同的运行时行为。如果生成的MEX函数生成的答案与MATLAB不同,或者生成错误,则必须在继续独立代码生成之前修复这些问题。否则,您生成的独立代码可能不可靠,并且具有未定义的行为。

生成C代码

构建脚本build_lib_fixed.m包含用于生成代码的命令euclidean.m

%加载测试数据负载euclidean_data.mat生成欧几里得的代码。与codegen m。使用测试数据作为示例输入。codegen报告配置:自由euclidean.marg游戏{x, cb}
注意:

  • codegen读取文件euclidean.m并将MATLAB代码转换为C代码。

  • 报告选项指示codegen生成代码生成报告,您可以使用该报告调试代码生成问题,并验证您的MATLAB代码是否适合代码生成。

  • 配置:自由选项指示codegen来生成静态C库,而不是生成默认的MEX函数。

  • arg游戏选项指示codegen生成以下代码euclidean.m使用样例输入参数的类、大小和复杂性xcb

不是生成C静态库,您可以选择通过使用适当的选项生成MEX函数或其他C/ c++构建类型codegen命令。有关各种代码生成选项的更多信息,请参见codegen

  1. 运行构建脚本。

    MATLAB处理构建文件并输出消息:

    代码生成成功:查看报告。
    代码生成器生成一个独立的C静态库欧几里得工作\ codegen \ lib \欧几里得.在这里,工作是包含教程文件的文件夹。

  2. 要在报表查看器中查看代码生成报表,请单击查看报告

    如果代码生成器在代码生成期间检测到错误或警告,则报告将描述问题并提供问题MATLAB代码的链接。看到代码生成报告

提示

使用构建脚本在命令行生成代码。构建脚本自动执行一系列MATLAB命令,您可以在命令行重复执行这些命令,节省您的时间并消除输入错误。

比较生成的C代码和原始的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双x [3]对应于输入x在MATLAB代码中。的大小x3.,它对应于您在为MATLAB代码生成代码时使用的示例输入的总大小(3 x 1)。

    const双cb [648]对应于输入cb在MATLAB代码中。的大小cb648,它对应于您在为MATLAB代码生成代码时使用的示例输入的总大小(3 x 216)。在本例中,生成的代码使用一维数组来表示MATLAB代码中的二维数组。

    生成的代码有四个额外的输入参数:数组y_miny_maxidx,距离.这些数组用于返回输出值。它们对应于输出参数y_miny_maxidx,距离在原始的MATLAB代码。

  • 代码生成器保留函数名和注释。如果可能,代码生成器会保留变量名。

    请注意

    如果您的MATLAB代码中的变量被设置为常量值,那么在生成的C代码中它不会以变量的形式出现。相反,生成的C代码包含变量的实际值。

使用嵌入式编码器®,可以交互式地跟踪MATLAB代码与生成的C/ c++代码之间的关系。看到交互式跟踪MATLAB代码和生成的C/ c++代码(嵌入式编码)

为可变大小的输入生成C代码

生成的C函数euclidean.m只能接受与代码生成期间指定的示例输入大小相同的输入。然而,对应MATLAB函数的输入数组可以是任意大小的。在本教程的这一部分中,您将从下面生成C代码euclidean.m它接受可变大小的输入。

假设你想要xcb在生成的C代码中有这些属性:

  • 两者的第一个维度xcb大小可以变化到3.

  • 第二个维度x是固定的,有值吗1

  • 第二个维度cb大小可以变化到216

要指定这些输入属性,请使用coder.typeof函数。coder.typeof (A, B, 1)指定具有相同类和复杂性的可变大小输入一个上界由大小向量的相应元素给出B.使用构建脚本build_lib_variable.m使用coder.typeof来指定生成的C库中大小可变的输入的属性。

%加载测试数据负载euclidean_data.mat%使用编码器。指定可变大小的输入eg_x =编码器。typeof (x, [3 1], 1);eg_cb =编码器。typeof (cb [216], 1);生成欧几里得的代码。使用编码器。typeof指定示例输入的上限值codegen报告配置:自由euclidean.marg游戏{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_datacb_datay_min_data,y_max_data对应于输入参数xcb输出参数y_miny_max在原始MATLAB函数中。C函数现在接受四个额外的输入参数x_sizecb_sizey_min_sizey_max_size的大小x_datacb_datay_min_data,y_max_data在运行时。

下一个步骤

目标 更多的信息

了解对MATLAB内置函数和工具箱函数、类和System金宝app对象的代码生成支持

C/ c++代码生成支持的函数和对象金宝app

生成c++代码

c++代码生成

交互式地创建和编辑输入类型

使用编码器类型编辑器创建和编辑输入类型

生成和修改一个示例C主函数,并使用它来构建一个C可执行程序

在应用程序中使用示例C Main

将生成的文件打包成压缩文件

其他开发环境的包代码

优化生成代码的执行速度或内存使用

优化策略

将您的定制C/ c++代码集成到生成的代码中

从MATLAB代码调用C/ c++代码

了解代码生成报告

代码生成报告

交互式跟踪MATLAB代码和生成的C/ c++代码(嵌入式编码)

另请参阅

|