codegen

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

全页折叠

语法

codegen options function
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 从 MATLAB® 函数生成 C 或 C++ 代码，并编译生成的代码。如果以下任一条件成立，则此语法适用：

  • 函数没有输入参量。

  • 函数包含一个或多个 arguments 块，用于指定所有输入参量的类型和大小。

使用 options 参量指定代码生成配置对象等设置。配置对象控制编译类型（MEX、lib、dll 或 exe）和代码生成参数。有关创建和使用配置对象的信息，请参阅配置代码生成和编译设置、coder.config，以及配置对象参考页：coder.CodeConfig、coder.MexCodeConfig 和 coder.EmbeddedCodeConfig。

示例

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} 从使用在外部 files 中指定的自定义源代码的 MATLAB 函数生成 C/C++ 代码。有关详细信息，请参阅从生成的代码中调用自定义 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 选项。有关详细信息，请参阅Specify Number of Input or Output Arguments to Entry-Point Functions。

codegen options files function1 -args {func1_inputs} ... functionN -args {funcN_inputs} 从多个 MATLAB 函数生成 C/C++ 代码。请在每个函数名称的后面分别写入函数的输入参量。还可以对每个函数使用 -nargout 选项。从其中生成代码的函数称为入口函数。有关详细信息，请参阅Generate Code for Multiple Entry-Point Functions。

codegen options files function -args {func_inputs1} ... -args {func_inputsN} 生成代码，其生成的代码可接受具有 -args 指定的多个类型签名的输入参量。对于 MEX 目标，会生成接受所有指定签名的单个 MEX 函数。但是，对于独立目标，会为每个签名生成一个 C/C++ 入口函数。使用 options 参量指定代码生成配置对象和参数等设置。有关详细信息，请参阅Generate Code for Functions with Multiple Signatures。

示例

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

示例

全部折叠

编写一个 MATLAB 函数 mcadd，它返回两个输入参量 u 和 v 之和。使用 arguments 块声明 u 是由双精度实数值组成的 1×4 行向量，v 是双精度实数标量。 

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

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

codegen mcadd

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

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

  • 要允许生成具有特定类型的 MEX 或 C/C++ 代码，您必须指定 MATLAB 入口函数的所有输入变量的类和大小。在此示例中，使用 arguments 块声明第一个输入是由 double 实数值组成的 1×4 数组，第二个输入是 double 实数标量。

在命令行中，调用生成的 MEX 函数 mcadd_mex。确保您传递给 mcadd_mex 的值的类型和大小与您在 arguments 块中指定的输入属性匹配。

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

     6     6     6     6

运行具有这些输入值的 MATLAB 函数 mcadd 会产生相同的输出。此测试用例验证 mcadd 和 mcadd_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 函数 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。有关详细信息，请参阅Generate Code for Functions with Multiple Signatures。

编写一个 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 <stdio.h>
#include <stdlib.h>
#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() 的文件。您可以使用源、对象或库文件。

有关更详细的示例，请参阅在应用程序中使用示例 C 主函数。

编写一个接受单个输入的 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 函数 myMult，它返回两个值的乘积。将此函数保存在命名空间 +myNamespace 中。

function out = myMult(a,b)
out = a*b;
end

在命令行中为此函数生成代码。使用圆点表示法指定命名空间 +myNamespace 中的函数 myMult。

codegen myNamespace.myMult -args {0,0}

为了防止不同命名空间中同名入口函数之间的名称冲突，代码生成器生成的文件以命名空间的名称和入口函数的名称开头。例如，使用此命令调用生成的 MEX 函数。

myNamespace_myMult_mex(4,3)

编写一个 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 库和支持文件。

您可以为 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。在报告查看器中，检查文件 foo.cpp 中生成的 C++ 源代码。

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

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

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

此示例要求具有 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

定义一个 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.coderprj 的等效 MATLAB Coder 工程文件。

codegen -config cfg myadd -args {coder.typeof(1,[Inf,Inf]),coder.typeof(1,[Inf,Inf])} -toproject myadd_project.coderprj

代码生成器在当前工作文件夹中创建工程文件 myadd_project.coderprj。使用 -toproject 选项运行 codegen 不会生成代码。它只创建工程文件。

使用另一个 codegen 命令，从 myadd_project.coderprj 生成代码。

codegen myadd_project.coderprj

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

输入参数

全部折叠

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

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

-c

仅生成源代码。不要调用 make 命令或编译目标代码。例如，要为函数 foo 生成静态 C/C++ 库并仅生成源代码，请使用以下命令：

codegen -config:lib -c foo
此命令复制 MATLAB Coder 的默认行为，即生成代码而不编译生成的代码。

-config:dll

使用默认配置参数生成动态 C/C++ 库。

-config:exe

使用默认配置参数生成静态 C/C++ 可执行文件。

-config:lib

使用默认配置参数生成静态 C/C++ 库。

-config:mex

使用默认配置参数生成 MEX 函数。

-config:single

使用默认配置参数生成单精度 MATLAB 代码。

需要 Fixed-Point Designer。

-config config_object

指定包含代码生成参数的配置对象。config_object 是以下配置对象之一：

  • coder.CodeConfig - 用于生成独立 C/C++ 库或可执行文件的参数（如果 Embedded Coder® 不可用）。

    % Configuration object for a dynamic linked library
cfg = coder.config('dll')
% Configuration object for an executable
cfg = coder.config('exe')
% Configuration object for a static standalone library
cfg = coder.config('lib')

  • coder.EmbeddedCodeConfig - 用于生成独立 C/C++ 库或可执行文件的参数（如果 Embedded Coder 可用）。

    % Configuration object for a dynamic linked library
ec_cfg = coder.config('dll')
% Configuration object for an executable
ec_cfg = coder.config('exe')
% Configuration object for a static standalone library
ec_cfg = coder.config('lib')

  • coder.MexCodeConfig - 用于生成 MEX 代码的参数。

    mex_cfg = coder.config
% or 
mex_cfg = coder.config('mex')

有关详细信息，请参阅配置代码生成和编译设置。

-d out_folder

将生成的文件存储在 out_folder 指定的绝对或相对路径中。out_folder 不能包含：

  • 空格，因为在某些操作系统配置中，空格可能导致代码生成失败。

  • 非 7 位 ASCII 字符，如日语字符。

如果 out_folder 指定的文件夹不存在，codegen 会创建它。

如果不指定文件夹位置，codegen 会在默认文件夹中生成文件： 

codegen/target/fcn_name.

target 可以是：

  • mex（对于 MEX 函数）

  • exe（对于可嵌入的 C/C++ 可执行文件）

  • lib（对于可嵌入的 C/C++ 库）

  • dll（对于 C/C++ 动态库）

fcn_name 是命令行中第一个 MATLAB 函数（按字母顺序排列）的名称。

该函数不支持在文件夹名称中使用以下字符：星号 (*)、问号 (?)、美元符号 ($) 和镑符号 (#)。

注意

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

-double2single double2single_cfg_name

使用 coder.SingleConfig 对象 double2single_cfg_name 指定的设置生成单精度 MATLAB 代码。codegen 在文件夹 codegen/fcn_name/single 中生成文件。

fcn_name 是入口函数的名称。

当与 -config 选项结合使用时，还可生成单精度 C/C++ 代码。codegen 在文件夹 codegen/target/folder_name 中生成单精度文件。

target 可以是：

  • mex（对于 MEX 函数）

  • exe（对于可嵌入的 C/C++ 可执行文件）

  • lib（对于可嵌入的 C/C++ 库）

  • dll（对于 C/C++ 动态库）

folder_name 是 fcn_name 和 singlesuffix 的串联。

singlesuffix 是 coder.SingleConfig 属性 OutputFileNameSuffix 指定的后缀。此文件夹中的单精度文件也有此后缀。

有关详细信息，请参阅Generate Single-Precision MATLAB Code。命名空间中的入口函数不支持此选项。您必须有 Fixed-Point Designer 才能使用此选项。

-float2fixed float2fixed_cfg_name

当与 -config 选项结合使用时，将使用浮点到定点转换配置对象 float2fixed_cfg_name 指定的设置生成定点 C/C++ 代码。

codegen 在文件夹 codegen/target/fcn_name_fixpt 中生成文件。target 可以是：

  • mex（对于 MEX 函数）

  • exe（对于可嵌入的 C/C++ 可执行文件）

  • lib（对于可嵌入的 C/C++ 库）

  • dll（对于 C/C++ 动态库）

fcn_name 是入口函数的名称。

如果不使用 -config 选项，则使用浮点到定点转换配置对象 float2fixed_cfg_name 指定的设置生成定点 MATLAB 代码。codegen 在文件夹 codegen/fcn_name/fixpt 中生成文件。

您必须将 TestBenchName 属性设置为 float2fixed_cfg_name。例如：

fixptcfg.TestBenchName = 'myadd_test';
此命令指定 myadd_test 是浮点到定点配置对象 fixptcfg 的测试文件。

有关详细信息，请参阅Convert MATLAB Code to Fixed-Point C Code。命名空间中的入口函数不支持此选项。您必须有 Fixed-Point Designer 才能使用此选项。

-g

指定是否对 C 编译器使用调试选项。如果启用调试模式，C 编译器会禁用一些优化。编译速度会更快，但执行速度会变慢。

-globals global_values

在 MATLAB 文件中指定全局变量的名称和初始值。

global_values 是全局变量名称和初始值组成的元胞数组。global_values 的格式是：

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

gn 是指定为字符向量的全局变量的名称。initn 是初始值。例如：

-globals {'g', 5}

也可以使用以下格式：

-globals {global_var, {type, initial_value}}

type 是类型对象。要创建类型对象，请使用 coder.typeof。对于全局元胞数组变量，必须使用此格式。

在使用 codegen 生成代码之前，需要初始化全局变量。如果您没有使用 -globals 选项为全局变量提供初始值，codegen 会检查 MATLAB 全局工作区中的变量。如果不提供初始值，codegen 会产生错误。

MATLAB Coder 和 MATLAB 各有自己的全局数据副本。为了保持一致性，只要两者有交互，就请同步其全局数据。如果不同步数据，其全局变量可能会不同。

要为全局变量指定常量值，请使用 coder.Constant。例如： 

-globals {'g', coder.Constant(v)}
指定 g 为具有常量值 v 的全局变量。

有关详细信息，请参阅Generate Code for Global Variables。

-gpuprofile

使用 GPU 性能分析器启用生成代码的 GPU 探查。

GPU 性能分析器运行 MEX 函数或软件在环 (SIL) 执行，收集生成代码中 CPU 和 GPU 活动的度量。GPU 性能分析器提供一份报告，其中包含按时间顺序排列的时间轴图，您可以使用它来可视化、识别和缓解生成的 CUDA® 代码中的性能瓶颈。

要使用单个命令生成和探查 CUDA 代码，请运行带 -gpuprofile 和 -test 选项的 codegen。

GPU 探查需要 GPU Coder™ 产品。要探查非 MEX 目标，您还需要 Embedded Coder 产品。

有关详细信息，请参阅 GPU Performance Analyzer (GPU Coder)。

-I include_path

将 include_path 添加到代码生成路径的开头。当 codegen 搜索 MATLAB 函数和自定义 C/C++ 文件时，它首先搜索代码生成路径。它不会搜索代码生成路径上的类。类必须位于 MATLAB 搜索路径上。有关详细信息，请参阅路径和文件基础架构设置。

如果路径包含非 7 位 ASCII 字符（如日语字符），则 codegen 可能在此路径上找不到文件。

要包含多条路径，请在每个要包含的路径前使用 -I。用单引号将包含空格的路径引起来。例如： 

-I C:\Project -I 'C:\Custom Files'
-jit

使用即时 (JIT) 编译来生成 MEX 函数。JIT 编译可以加速 MEX 函数的生成。此选项仅适用于 MEX 函数生成。此选项与某些代码生成功能或选项不兼容，例如自定义代码或使用 OpenMP 库。

-lang:c

将生成代码中要使用的语言指定为 C。

如果没有指定任何目标语言，代码生成器将生成 C 代码。

-lang:c++

将生成代码中要使用的语言指定为 C++。

-launchreport

生成并打开一个代码生成报告。如果未指定此选项，则仅当出现错误或警告消息或者您指定了 -report 选项时，codegen 才会生成报告。

-o output_file_name

使用基本名称 output_file_name 和以下扩展名之一生成 MEX 函数、C/C++ 库或 C/C++ 可执行文件：

  • .a 或 .lib（适用于 C/C++ 静态库）

  • .exe 或无扩展名（适用于 C/C++ 可执行文件）

  • .dll（适用于 Microsoft® Windows® 系统上的 C/C++ 动态库）

  • .so（适用于 Linux® 系统上的 C/C++ 动态库）

  • .dylib（适用于 Mac 系统上的 C/C++ 动态库）

  • 生成的 MEX 函数的与平台相关的扩展名

output_file_name 可以是文件名，也可以包含现有路径。output_file_name 不能包含空格，因为在某些操作系统配置中空格可能导致代码生成失败。

对于 MEX 函数，output_file_name 必须为有效的 MATLAB 函数名称。

如果没有为库和可执行文件指定输出文件名，则基本名称是 fcn_1。fcn_1 是命令行中指定的第一个 MATLAB 函数的名称。对于 MEX 函数，基本名称是 fcn_1_mex。您可以运行原始 MATLAB 函数和 MEX 函数，并比较结果。

-O optimization_option

根据 optimization_option 的值优化生成的代码：

  • enable:inline - 启用函数内联。

  • disable:inline - 禁用函数内联。要了解有关函数内联的详细信息，请参阅Control Inlining to Fine-Tune Performance and Readability of Generated Code。

  • enable:openmp - 使用 OpenMP 库（如果可用）。使用 codegen 为 parfor 循环生成的 OpenMP 库、MEX 函数或 C/C++ 代码可以在多个线程上运行。

  • disable:openmp - 禁用 OpenMP 库。禁用 OpenMP 后，codegen 将 parfor 循环视为 for 循环，并生成在单线程上运行的 MEX 函数或 C/C++ 代码。请参阅Control Compilation of parfor-Loops。

在命令行上为每次优化指定一次 -O。

如果没有指定，则 codegen 使用内联和 OpenMP 进行优化。

-package zip_file_name

将生成的独立代码及其依赖关系打包到名为 zip_file_name 的压缩 ZIP 文件中。然后，您可以使用该 ZIP 文件以转移到另一个开发环境中进行解包并重新编译代码文件。

packNGo 函数也提供此打包功能。

-preservearraydims

生成使用 N 维索引的代码。有关详细信息，请参阅Generate Code That Uses N-Dimensional Indexing。

-profile

使用 MATLAB 探查器启用对生成的 MEX 函数的探查。有关详细信息，请参阅使用 MATLAB 探查器探查 MEX 函数。

使用 GPU Coder 生成 CUDA 代码时不支持此选项。要探查生成的 CUDA 代码，请使用 -gpuprofile 选项。

-report

生成代码生成报告。如果未指定此选项，则仅当出现错误或警告消息或者您指定了 -launchreport 选项时，codegen 才会生成报告。

如果您有 Embedded Coder，则此选项还支持生成代码替换报告。

-reportinfo info

将有关代码生成的信息导出到 MATLAB 基础工作区的变量 info 中。请参阅Access Code Generation Report Information Programmatically。

-rowmajor

生成使用行优先数组布局的代码。默认为列优先布局。有关详细信息，请参阅Generate Code That Uses Row-Major Array Layout。

-silent

如果代码生成成功且没有警告，则隐藏所有消息，包括生成报告时。

将显示警告和错误消息。

-singleC

生成单精度 C/C++ 代码。有关详细信息，请参阅Generate Single-Precision C Code at the Command Line。

命名空间中的入口函数不支持此选项。您必须有 Fixed-Point Designer 才能使用此选项。

-std:language_standard

生成与指定的语言标准兼容的 C/C++ 代码。仅当目标语言是 C++ 时，才支持 C++ 语言标准。

language_standard 是以下值之一：

  • c89/c90，适用于 C89/90 (ANSI)

  • c99，适用于 C99 (ISO)

  • c++03，适用于 C++03 (ISO)

  • c++11，适用于 C++11 (ISO)

  • c++14，适用于 C++14 (ISO)

  • c++17，适用于 C++17 (ISO)

  • c++20，适用于 C++20 (ISO)

例如，要生成与 C++14 (ISO) 语言标准兼容的代码，请使用此选项：

-std:c++14

有关支持的语言标准的详细信息，请参阅更改用于代码生成的语言标准。

-test test_file

运行 test_file，将调用原始 MATLAB 函数替换为调用 MEX 函数。使用此选项等效于运行 coder.runTest。

仅当生成 MEX 函数或使用将 VerificationMode 设置为 'SIL' 或 'PIL' 的配置对象时，才支持此选项。创建具有 VerificationMode 参数的配置对象需要 Embedded Coder 产品。

-toproject project_file_name

将 codegen 命令转换为名为 project_file_name 的等效 MATLAB Coder 工程文件。然后，您可以使用另一个 codegen 命令或 MATLAB Coder 从工程文件中生成代码。

您还可以使用 -toproject 选项将不完整的 codegen 命令转换为工程文件。例如，要创建仅包含配置对象 cfg 中存储的代码生成参数的工程文件 myProjectTemplate.coderprj，请运行以下命令：

codegen -config cfg -toproject myProjectTemplate.coderprj
在本例中，myProjectTemplate.coderprj 不包含入口函数或输入类型的设定。因此，您无法从这个工程文件生成代码。您可以在 MATLAB Coder 中打开 myProjectTemplate.coderprj，并将其作为模板来创建可用于生成代码的完整工程文件。

使用 -toproject project_file_name 选项运行 codegen 不会生成代码。它只创建工程文件。

请参阅Convert codegen Command to Equivalent MATLAB Coder Project。

-v

启用详尽模式以显示代码生成状态和目标编译日志消息。

-?

显示 codegen 命令的帮助。

指定为当前工作文件夹中或路径上存在的函数。要在存在于当前工作文件夹或路径中的 MATLAB 命名空间中指定函数，请将命名空间名称添加到函数名称的开头，后跟一个句点。如果 MATLAB 文件位于包含非 7 位 ASCII 字符（如日语字符）的路径上，则 codegen 命令可能找不到该文件。

示例: codegen myAddFunction

示例: codegen myNamespace.myAddFunction

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

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

有关详细信息，请参阅指定入口函数输入的类型。

示例: codegen foo -args {1}

示例: codegen foo2 -args {1, ones(3,5)}

示例: codegen foo3 -args {1, ones(3,5), coder.typeof("hello")}

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

  • C 文件 (.c)

  • C++ 文件 (.cpp)

  • 头文件 (.h)

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

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

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

示例: codegen foo myLib.lib

为前面的 MATLAB 函数生成的 C/C++ 入口函数中的输出参量个数。代码生成器按照输出参量在 MATLAB 函数定义中出现的顺序生成指定数量的输出参量。

示例: codegen myMLfnWithThreeOuts -nargout 2

从 MATLAB Coder 创建的工程文件。代码生成器使用该工程文件来设置入口函数、输入类型定义和其他选项。要打开 App 并创建或修改工程文件，请使用 coder 函数。

示例: codegen foo.coderprj

限制

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

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

  • 为命名空间中的入口函数生成代码时，codegen 命令不支持选项 -double2single、-float2fixed 和 -singleC。

提示

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

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

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

  • 使用 coder 函数打开 MATLAB Coder，并创建一个 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{:})

版本历史记录

在 R2011a 中推出

另请参阅

| | (Fixed-Point Designer) | (Fixed-Point Designer) | | (Fixed-Point Designer) | | | | | |

主题