MATLAB中codegen的使用

目录

语法

说明

示例

从 MATLAB 函数生成 MEX 函数

从具有多个签名的 MATLAB 函数生成 MEX 函数

在自定义文件夹中生成 C 静态库文件

生成可执行文件

生成使用可变大小输入的代码

使用全局数据生成代码

生成接受枚举类型输入的代码

生成接受定点输入的静态库

生成接受半精度输入的静态 C++ 库

将浮点 MATLAB 代码转换为定点 C 代码

将 codegen 命令转换为等效的 MATLAB Coder 工程

        codegen从 MATLAB 代码生成 C/C++ 代码。

语法

codegen options function -args {func_inputs}
 
codegen options files function -args {func_inputs}
 
codegen options files function -args {func_inputs} -nargout number_args
 
codegen options files function1 -args {func1_inputs} ... functionN -args {funcN_inputs}
 
codegen options files function -args {func_inputs1} ... -args {func_inputsN}
 
codegen project

说明

​codegen options function -args {func_inputs} 

        使用 func_inputs 类型的输入从 MATLAB® 函数生成 C 或 C++ 代码，并编译生成的代码。使用 options 参数指定代码生成配置对象等设置。配置对象控制编译类型（MEX、lib、dll 或 exe）和代码生成参数。有关创建和使用配置对象的信息，可以参考配置编译设置、coder.config，以及配置对象参考页：coder.CodeConfig、coder.MexCodeConfig 和 coder.EmbeddedCodeConfig。

如果函数没有输入，请省略函数特定的 -args {func_inputs} 选项。

​codegen options files function -args {func_inputs} 

        从 MATLAB 函数生成 C/C++ 代码，该函数使用在外部 files 中指定的自定义源代码。具体可以参考从 MATLAB 代码调用 C/C++ 代码和Configure Build for External C/C++ Code。

​codegen options files function -args {func_inputs} -nargout number_args 

        生成 C/C++ 代码，并控制从 MATLAB 函数生成的 C/C++ 函数代码的输出参数的数目。文件和选项参数是可选的。如果并不需要 MATLAB 函数的所有输出，则请使用 -nargout 选项。

​codegen options files function1 -args {func1_inputs} ... functionN -args {funcN_inputs} 

        从多个 MATLAB 函数生成 C/C++ 代码。请在每个函数名称的后面为函数编写输入参数。还可以为每个函数使用 -nargout 选项。从其中生成代码的函数称为入口函数。

​codegen options files function -args {func_inputs1} ... -args {func_inputsN} 

        从 MATLAB 函数生成多签名 MEX 函数。为同一个入口函数的输入参数提供多个 -args 设定。使用 options 参数指定代码生成配置对象和参数等设置。必须将编译类型指定为 MEX 函数。不支持其他编译类型（lib、dll 和 exe）。

​codegen project 从 MATLAB Coder™ 工程文件（例如 test.prj）生成代码。

示例

从 MATLAB 函数生成 MEX 函数

        编写一个 MATLAB 函数 mcadd，它返回两个值的总和。

function y = mcadd(u,v) %#codegen
% The directive %#codegen indicates that the function
% is intended for code generation
y = u + v;
end

        在 MATLAB 命令行中，运行以下 codegen 命令。

codegen mcadd -args {[0 0 0 0],0}

        代码生成器在当前工作文件夹中生成 MEX 文件 mcadd_mex。

• 如果没有指定编译目标，代码生成默认为 MEX 代码生成。默认情况下，代码生成器将生成的 MEX 函数命名为 mcadd_mex。

• 要允许生成具有特定类型的 MEX 或 C/C++ 代码，必须指定 MATLAB 入口函数的所有输入变量的属性（类、大小和复/实性）。在此示例中，使用 -args 选项为输入提供示例值。代码生成器使用这些示例值来确定第一个输入是由实数 double 值组成的 1×4 数组，第二个输入是 double 实数标量。

  ​这些示例输入的实际值与代码生成无关。任何其他具有相同属性（类、大小和复/实性）的值对组都会生成相同的代码。​

        在命令行中，调用生成的 MEX 函数 mcadd_mex。确保传递给 mcadd_mex 的值的类、大小和复/实性与在 codegen 命令中指定的输入属性相匹配。

mcadd_mex([1 1 1 1],5)
 
 
ans =
 
     6     6     6     6

        使用这些输入值运行 MATLAB 函数 mcadd 会产生相同的输出。此测试用例验证 mcadd 和 mcadd_mex 具有相同的行为。

从具有多个签名的 MATLAB 函数生成 MEX 函数

        编写一个 MATLAB 函数 myAdd，它返回两个值的总和。

function y = myAdd(u,v) %#codegen
y = u + v;
end

        在 MATLAB 命令行中，运行以下 codegen 命令。

codegen -config:mex myAdd.m -args {1,2} -args {int8(2),int8(3)} -args {1:10,1:10} -report

        ​代码生成器为 codegen 命令中指定的多个签名创建单一 MEX 函数 myAdd_mex。

在自定义文件夹中生成 C 静态库文件

        编写一个 MATLAB 函数mcadd，它返回两个值的总和。

function y = mcadd(u,v) %#codegen
y = u + v;

        使用 -config:lib 选项在自定义文件夹 mcaddlib 中生成 C 库文件。将第一个输入类型指定为由无符号 16 位整数组成的 1×4 向量。将第二个输入指定为双精度标量。

codegen -d mcaddlib -config:lib  mcadd -args {zeros(1,4,'uint16'),0}

生成可执行文件

        编写一个 MATLAB 函数 coderRand，该函数在开区间 (0,1) 上基于标准均匀分布生成一个随机标量值。

function r = coderRand() %#codegen
r = rand();

        编写一个 C 主函数 c:\myfiles\main.c，它调用 coderRand。

/*
** main.c
*/
#include 
#include 
#include "coderRand.h"
#include "coderRand_initialize.h"
#include "coderRand_terminate.h"
int main()
{
    coderRand_initialize();
    printf("coderRand=%g\n", coderRand());
    coderRand_terminate();
    
    puts("Press enter to quit:");
    getchar();
 
    return 0;
}

        将代码生成参数配置为包含 C 主函数，然后生成 C 可执行文件。

cfg = coder.config('exe')
cfg.CustomSource = 'main.c'
cfg.CustomInclude = 'c:\myfiles'
codegen -config cfg coderRand

        codegen 在当前文件夹中生成 C 可执行文件 coderRand.exe，在默认文件夹 codegen\exe\coderRand 中生成支持文件。此示例说明如何在配置对象 coder.CodeConfig 中将主函数指定为参数。也可以在命令行中单独指定包含 main() 的文件。可以使用源、对象或库文件。

生成使用可变大小输入的代码

        编写一个接受单个输入的 MATLAB 函数。

function y = halfValue(vector) %codegen
    y = 0.5 * vector;
end

        ​使用 coder.typeof 将输入类型定义为由双精度值组成的行向量，其最大大小为 1×16，第二个维度具有可变大小。​

vectorType = coder.typeof(1, [1 16], [false true]);

        生成 C 静态库。

codegen -config:lib halfValue -args {vectorType}

使用全局数据生成代码

        编写一个 MATLAB 函数 use_globals，该函数接受一个输入参数u并使用两个全局变量 AR 和 B。

function y = use_globals(u)
%#codegen
% Turn off inlining to make 
% generated code easier to read
coder.inline('never');
global AR;
global B;
AR(1) = u(1) + B(1);
y = AR * 2;

        生成一个 MEX 函数。默认情况下，codegen 在当前文件夹中生成名为 use_globals_mex 的 MEX 函数。使用 -globals 选项在命令行指定全局变量的属性。通过使用 -args 选项，指定输入u为双精度实数标量。

codegen -globals {'AR', ones(4), 'B', [1 2 3 4]} use_globals -args {0}

        也可以在 MATLAB 工作区中初始化全局数据。在 MATLAB 提示符下，输入：

global AR B;
AR = ones(4);
B = [1 2 3];

        生成 MEX 函数。

codegen use_globals -args {0}

生成接受枚举类型输入的代码

        编写一个函数 displayState，它使用枚举数据根据设备状态激活 LED 显示。绿色 LED 显示亮起指示 ON 状态。红色 LED 显示亮起指示 OFF 状态。

function led = displayState(state)
%#codegen
 
if state == sysMode.ON
    led = LEDcolor.GREEN;
else
    led = LEDcolor.RED;
end

        定义一个枚举 LEDColor。在 MATLAB 路径上，创建一个名为 'LEDColor' 的文件，其中包含：

classdef LEDcolor < int32
    enumeration
        GREEN(1),
        RED(2),
    end
end

        使用现有 MATLAB 枚举中的值创建一个 coder.EnumType 对象。定义一个枚举 sysMode。在 MATLAB 路径上，创建一个名为 'sysMode' 的文件，其中包含：

classdef sysMode < int32
  enumeration
    OFF(0)
    ON(1)
  end
end

        从这个枚举创建一个 coder.EnumType 对象。

t = coder.typeof(sysMode.OFF);

        为 displayState 生成一个 MEX 函数。

codegen  displayState -args {t}

生成接受定点输入的静态库

        编写一个 MATLAB 语言函数 mcsqrtfi，它计算定点输入的平方根。

function y = mcsqrtfi(x) %#codegen
y = sqrt(x);

        为定点输入 x 定义 numerictype 和 fimath 属性，并使用 -config:lib 选项为 mcsqrtfi 生成 C 库代码。

T = numerictype('WordLength',32, ...
                'FractionLength',23, ...
                'Signed',true)
F = fimath('SumMode','SpecifyPrecision', ...
           'SumWordLength',32, ...
           'SumFractionLength',23, ...
           'ProductMode','SpecifyPrecision', ...
           'ProductWordLength',32, ...
           'ProductFractionLength',23)
% Define a fixed-point variable with these
%  numerictype and fimath properties
myfiprops = {fi(4.0,T,F)}
codegen -config:lib mcsqrtfi -args myfiprops

        codegen 在默认文件夹 codegen/lib/mcsqrtfi 中生成 C 库和支持文件。

生成接受半精度输入的静态 C++ 库

        ​可以为 MATLAB 代码生成接受半精度输入的代码。有关详细信息，可以参考 half。编写一个 MATLAB 函数 foo，它返回两个值的总和。​

function y = foo(a,b)
y = a + b;
end

        在 MATLAB 命令行中，运行以下 codegen 命令。

codegen -lang:c++ -config:lib foo -args {half(0),half(0)} -report
 
Code generation successful: View report

        代码生成器在 work\codegen\lib\foo 中生成静态 C++ 库，其中 work 是当前工作文件夹。要查看代码生成报告，请点击 View report。在 Report Viewer 中，检查文件 foo.cpp 中生成的 C++ 源代码。

real16_T foo(real16_T a, real16_T b)
{
  return a + b;
}

        生成的函数 foo 接受并返回半精度值。C++ 半精度类型 real16_T 在生成的头文件 rtwhalf.h 中定义。检查 real16_T 类的 + 运算符的定义。

        此示例中生成的代码将半精度输入转换为单精度，以单精度执行加法运算，并将结果转换回半精度。

将浮点 MATLAB 代码转换为定点 C 代码

        此示例要求具有 Fixed-Point Designer™。编写一个 MATLAB 函数 myadd，它返回两个值的总和。

function y = myadd(u,v) %#codegen
    y = u + v;
end

        编写一个 MATLAB 函数 myadd_test 以测试 myadd。

function y = myadd_test %#codegen
    y = myadd(10,20);
end

        使用默认设置创建一个 coder.FixptConfig 对象 fixptcfg。

fixptcfg = coder.config('fixpt');

        设置测试平台名称。

fixptcfg.TestBenchName = 'myadd_test';

        创建一个代码生成配置对象来生成独立的 C 静态库。

cfg = coder.config('lib');

        使用 -float2fixed 选项生成代码。

codegen -float2fixed fixptcfg -config cfg myadd

将 codegen 命令转换为等效的 MATLAB Coder 工程

        定义一个 MATLAB 函数 myadd，它返回两个值的总和。

function y = myadd(u,v) %#codegen
y = u + v;
end

        创建用于生成静态库的 coder.CodeConfig 对象。将 TargetLang 设置为 'C++'。

cfg = coder.config('lib');
cfg.TargetLang = 'C++';

        在 MATLAB 命令行中，创建并运行 codegen 命令。将 myadd 指定为入口函数。将 myadd 的输入指定为维度无界的 double 类型可变大小矩阵。将 cfg 指定为代码配置对象。包括 -toproject 选项，以将 codegen 命令转换为名称为 myadd_project.prj 的等效 MATLAB Coder 工程文件。

codegen -config cfg myadd -args {coder.typeof(1,[Inf,Inf]),coder.typeof(1,[Inf,Inf])} -toproject myadd_project.prj
 
 
Project file 'myadd_project.prj' was successfully created.
Open Project

        代码生成器在当前工作文件夹中创建工程文件 myadd_project.prj。使用 -toproject 选项运行 codegen 不会生成代码。它只创建工程文件。使用另一个 codegen 命令，从 myadd_project.prj 生成代码。

codegen myadd_project.prj

        代码生成器在 work\codegen\lib\myadd 文件夹中生成 C++ 静态库函数 myadd，其中 work 是当前工作目录。

        在使用 codegen 命令时，单个命令行选项的优先级高于配置对象指定的选项。如果各命令行选项之间发生冲突，则最右边的选项优先。选项和其他语法元素的顺序是可互换的。

        指定为以下一个或多个值：

codegen/target/fcn_name. 

fixptcfg.TestBenchName = 'myadd_test';

{g1, init1, g2, init2, ..., gn, initn}

-globals {'g', 5}

-globals {global_var, {type, initial_value}}

-globals {'g', coder.Constant(v)}

'C:\Project "C:\Custom Files"'

codegen -config cfg -toproject myProjectTemplate.prj

        指定为当前工作文件夹中或路径上存在的函数。如果 MATLAB 文件位于包含非 7 位 ASCII 字符（如日语字符）的路径上，codegen 命令可能找不到该文件。

        如果正在使用 LCC 编译器，请不要将入口函数命名为 main。

        定义前面 MATLAB 函数输入的大小、类和复/实性的示例值。元胞数组中输入的位置必须对应于 MATLAB 函数定义中输入参数的位置。也可以提供 coder.Type 对象，而不是示例值。要创建 coder.Type 对象，请使用 coder.typeof。

        要生成一个函数且使其输入参数个数少于函数定义的参数个数，请省略不需要的参数示例值。

        要包含在生成的代码中的自定义文件的空格分隔列表。选项、外部文件和函数设定的顺序可以互换。可以包括以下类型的文件：

• C 文件 (.c)

• C++ 文件 (.cpp)

• 头文件 (.h)

• 目标文件（.o 或 .obj）

• 库（.a、.so、.dylib 或 .lib）

• 模板联编文件 (.tmf)

  注意：在以后的版本中将删除对模板联编文件 (TMF) 的支持。请改用工具链方法来编译生成的代码。

        如果这些文件位于包含非 7 位 ASCII 字符（如日语字符）的路径上，codegen 命令可能找不到这些文件。

        为前面 MATLAB 函数生成的 C/C++ 入口函数中的输出参数个数。代码生成器按照输出参数在 MATLAB 函数定义中出现的顺序生成指定数量的输出参数。​
        从 MATLAB Coder App 创建的工程文件。代码生成器使用该工程文件来设置入口函数、输入类型定义和其他选项。要打开 App 并创建或修改工程文件，请使用 coder 函数。

限制

• 不能为 MATLAB 脚本生成代码。请将脚本重写为函数来生成代码。

• 不支持在当前文件夹是私有文件夹或 @ 文件夹时生成代码，因为这些文件夹在 MATLAB 中有特殊含义。可以生成代码来调用 @ 文件夹中的方法和私有文件夹中的函数。

提示

• 默认情况下，在文件夹 codegen/target/function 中生成代码。MEX 函数和可执行文件被复制到当前工作文件夹。

• 为了简化代码生成过程，可以在单独的脚本中编写代码生成命令。在该脚本中定义您的函数输入类型和代码生成选项。要生成代码，请调用该脚本。

• 每次 codegen 为相同的代码或工程生成相同类型的输出时，都会删除上一次编译生成的文件。如果要保留以前的某次编译生成的文件，请在开始新的编译之前将这些文件复制到其他位置。

• ​使用 coder 函数打开 MATLAB Coder App，并创建一个 MATLAB Coder 工程。该 App 提供用户界面，便于添加 MATLAB 文件、定义输入参数和指定编译参数。​

• 可以使用函数语法调用 codegen。将 codegen 参数指定为字符向量或字符串标量。例如：

codegen('myfunction','-args',{2 3},'-report')

• 要提供字符串标量作为输入或将 codegen 参数指定为字符串标量，请使用函数语法。例如：

codegen('myfunction','-args',"mystring",'-report')
codegen("myfunction","-args","mystring","-report")

        ​向 codegen 的命令形式提供字符串标量输入可能会产生意外的结果。可以参考命令与函数语法。​

• 要以编程方式调用 codegen，请使用函数语法。例如：

  A = {'myfunction','-args',{2 3}};
  codegen(A{:})