Main Content

coder.EmbeddedCodeConfig

Configuration parameters for C/C++ code generation from MATLAB code with Embedded Coder

expand all in page

Description

A coder.EmbeddedCodeConfig object contains the configuration parameters that codegen uses for generating a static library, a dynamically linked library, or an executable program with Embedded Coder®. Pass the object to the codegen function by using the -config option.

Creation

Create a coder.EmbeddedCodeConfig object by using the coder.config function.

Once you create a coder.EmbeddedCodeConfig object, you can modify its properties programmatically at the command line or interactively by using the Configuration Parameter Dialog Box. See Specify Configuration Parameters in Command-Line Workflow Interactively.

Properties

expand all

Compiler optimization or debug settings for toolchain, specified as one of the values in this table.

ValueDescription
'Faster Builds'

Optimizes the build for shorter build times.

'Faster Runs'

Optimizes the build for faster running executables.

'Debug'

Optimizes the build for debugging.

'Specify'

Enables the CustomToolchainOptions property for customization of settings for tools in the selected toolchain. If the Toolchain property is set to 'Automatically locate an installed toolchain', then setting BuildConfiguration to 'Specify' changes Toolchain to the located toolchain.

If you set the Toolchain property to one of the available CMake toolchain definitions, the allowed values of this property are 'Release', 'Debug', 'RelWithDebInfo', 'MinSizeRel', and 'Specify'. See Configure CMake Build Process.

Dynamic array optimization, specified as one of the values in this table.

ValueDescription
true

This value is the default value.

The code generator improves the execution time of generated C code by optimizing dynamic array access.

false

The code generator does not optimize dynamic array access.

See Optimize Dynamic Array Access.

Data type casting level for variables in the generated C/C++ code, specified as one of the values in this table.

ValueDescription
'Nominal'

This value is the default value.

Generates C/C++ code that uses default C compiler data type casting. For example:

short addone(short x)
{
  int i;
  i = x + 1;
  if (i > 32767) {
    i = 32767;
  }

  return (short)i;
}

'Standards'

Generates C/C++ code that casts data types to conform to MISRA™ standards. For example:

short addone(short x)
{
  int i;
  i = (int)x + (int)1;
  if (i > (int)32767) {
    i = (int)32767;
  }

  return (short)i;
}

'Explicit'

Generates C/C++ code that casts data type values explicitly. For example:

short addone(short x)
{
  int i;
  i = (int)x + 1;
  if (i > 32767) {
    i = 32767;
  }

  return (short)i;
}

See Control Data Type Casts in Generated Code (Embedded Coder).

Set this option to specify if you want to generate or use an existing clang-format file to format the generated code. Choose the formatting file selection method, specified as one of the values in the table.

ValueDescription
'Generate'

This value is the default value.

Creates a clang-format file for your build based on your configuration settings. The clang-format file is generated in the codegen folder.

'Existing'

Formats the generated code by using a clang-format file of your choice. Using clang-format enables detailed control over the formatting of your generated code.

The code generator searches for an existing clang-format file in the code generation folder and then the folder tree above the code generation folder. The code generator looks for files whose name includes _clang-format or is a .clang-format file that it finds. If it is unable to find the required file, the code generator uses the built-in format specification.

For more information, see https://clang.llvm.org/docs/ClangFormatStyleOptions.html.

clang-format does not have native CUDA® C++ support. When generating CUDA code using GPU Coder™, setting the formatting tool to 'Clang-format' might result in build failures during code compilation.

Coverage analysis of both generated C/C++ code and custom C/C++ during a software-in-the-loop (SIL) or processor-in-the-loop (PIL) execution, specified as one of the values in this table.

ValueDescription
false

This value is the default value.

Disables code coverage analysis during a SIL or PIL execution.

trueInstruments C/C++ code for coverage analysis in the SIL or PIL application.

To use this name-value argument, you must have a MATLAB® Test™ license.

Data Types: logical

Execution-time profiling of entry-point functions during a software-in-the-loop (SIL) or processor-in-the-loop (PIL) execution, specified as one of the values in this table.

ValueDescription
false

This value is the default value.

Disables execution-time profiling during a SIL or PIL execution.

trueCalculates execution times of entry-point functions, using data obtained from instrumentation code in the SIL or PIL application. Use the Code Profile Analyzer (Embedded Coder) to view the call tree and corresponding execution times for the generated code.

See Execution Time Profiling for SIL and PIL (Embedded Coder) and Generate Execution Time Profile (Embedded Coder).

Code formatting options for generated code, specified as one of the values in the table.

ValueDescription
'Clang-format'

The code generator formats the generated code according to a clang-format file.

'Auto'

Uses an internal heuristic to determine if the generated code is formatted by clang-format or a MathWorks® formatting tool.

To determine whether the generated code is formatted by clang-format, in a coder.config object, set the Verbosity option to 'Verbose'.

'MathWorks'

Causes the code generator to revert to the MathWorks formatting tool.

Execution-time profiling of functions that are called within entry-point functions during a software-in-the-loop (SIL) or processor-in-the-loop (PIL) execution, specified as one of the values in this table.

ValueDescription
false

This value is the default value.

Disables execution-time profiling of functions called within entry-point functions during a SIL or PIL execution.

true

Calculates execution times of functions called within entry-point functions, using data obtained from instrumentation code in the SIL or PIL application. Use the Code Profile Analyzer (Embedded Coder) to view the call tree and corresponding execution times for the generated code.

Dependency: CodeExecutionProfiling enables this parameter.

See Execution Time Profiling for SIL and PIL (Embedded Coder) and Generate Execution Time Profile (Embedded Coder).

Options for collection and storage of execution-time measurements, specified as one of the values in this table.

ValueDescription
"AllData"

This value is the default value.

As execution runs, collects and immediately uploads profiling measurement and analysis data from target device to development computer. At the end of execution, saves all data in base workspace.

"SummaryOnly"

As execution runs, evaluates only execution-time metrics required for report and immediately uploads metrics from target device. At the end of execution, saves evaluated metrics in base workspace.

"MetricsOnly"

As execution runs, processes profiling data and stores certain metrics on target device. At the end of execution, uploads the stored metrics from target device.

Data Types: char | string

Stack usage profiling of entry-point functions during a software-in-the-loop (SIL) or processor-in-the-loop (PIL) execution, specified as one of the values in this table.

ValueDescription
false

This value is the default value.

Disables stack usage profiling during a SIL or PIL execution.

trueCalculates stack usage of functions in the generated code, using data obtained from instrumentation code in the SIL or PIL application. Use the Code Profile Analyzer (Embedded Coder) to view the stack usage values for entry-point and internal functions.

See Stack Usage Profiling for Code Generated From MATLAB Code (Embedded Coder).

Code generation template for file and function banners in the generated code. By default, CodeTemplate is empty and the code generator produces default banners. To produce custom banners, set CodeTemplate to a coder.MATLABCodeTemplate object created from a code generation template (CGT) file. See Generate Custom File and Function Banners for C/C++ Code (Embedded Coder).

Code replacement library for generated code, specified as one of the values in this table:

ValueDescription
'None'

This value is the default value.

Does not use a code replacement library.

Named code replacement library

Generates calls to a specific platform, compiler, or standards code replacement library. The list of named libraries depends on:

  • Installed support packages.

  • System target file, language, language standard, and device vendor configuration.

  • Whether you created and registered code replacement libraries, using the Embedded Coder product.

Compatible libraries depend on these parameters:

  • TargetLang

  • TargetLangStandard

  • ProdHWDeviceType in the hardware implementation configuration object.

Embedded Coder offers more libraries and the ability to create and use custom code replacement libraries.

MATLAB Coder™ generates the minimal set of #include statements for header files required by the selected code replacement library.

Before setting this parameter, verify that your compiler supports the library that you want to use. If you select a parameter value that your compiler does not support, compiler errors can occur.

Note

MATLAB Coder software does not support TLC callbacks.

Maximum number of columns before a line break in the generated code, specified as a positive integer in the range [45, 65536].

Other rules for placement of the line break can take precedence over the column limit that you specify.

Comment style in the generated code, specified as one of the values in this table.

ValueDescription
'Auto' For C, generate multiline comments. For C++, generate single-line comments.
'Single-line'Generate single-line comments preceded by //.
'Multi-line'Generate single or multiline comments delimited by /* and */.

For C code generation, specify the single-line comment style only if your compiler supports it.

Dependency: GenerateComments enables this parameter.

See Specify Comment Style for C/C++ Code (Embedded Coder).

Maximum number of function specializations for compile-time recursion, specified as a positive integer. To disallow recursion in the MATLAB code, set CompileTimeRecursionLimit to 0. The default compile-time recursion limit is large enough for most recursive functions that require this type of recursion. If code generation fails because of the compile-time recursion limit, and you want compile-time recursion, try to increase the limit. Alternatively, change your MATLAB code so that the code generator uses run-time recursion. See Compile-Time Recursion Limit Reached.

Maximum number of instructions that the constant folder executes. In some situations, code generation requires specific instructions to be constant. If constant folding stops before these instructions are constant-folded, code generation fails. In this case, increase the value of ConstantFoldingTimeout.

See MATLAB Coder Optimizations in Generated Code.

Conversion of if-elseif-else patterns to switch-case statements in the generated code, specified as one of the values in this table.

ValueDescription
false

This value is the default value.

The code generator does not convert if-elseif-else patterns to switch-case statements.

trueThe code generator tries to convert if-elseif-else patterns to switch-case statements. The code generator produces a switch-case statement only if all potential case expressions are scalar integer values.

See Controlling C Code Style (Embedded Coder).

Whether to generate C++11 code that contains enumeration classes or ordinary C enumerations, specified as one of the values in this table.

ValueDescription
true

This value is the default value.

The code generator produces enumeration classes for MATLAB enumerations in the generated C++11 code. See Code Generation for Enumerations.

false

The code generator produces ordinary C enumerations for MATLAB enumerations in the generated C++11 code.

Dependency:

  • Setting TargetLang to 'C++' enables this parameter.

Name of interface class when you generate C++ code with CppInterfaceStyle set to 'Methods'. In this case, the generated code for MATLAB entry-point functions consists of methods contained in a C++ class with name specified by CppInterfaceClassName. This property has no effect when you set CppInterfaceStyle to 'Functions'.

See Generate C++ Code with Class Interface.

Style of interface to the generated C++ code for the MATLAB entry-point functions that you generate code from. By default, entry-point functions become C++ functions. If you choose 'Methods', then entry-point functions become methods in a C++ class. Specify the name of the class by using the property CppInterfaceClassName.

See Generate C++ Code with Class Interface.

Dependency:

  • Setting TargetLang to 'C++' enables this parameter.

Whether to generate C++ namespaces for the packages in your MATLAB code, specified as one of the values in this table.

ValueDescription
true

This value is the default value.

The code generator produces C++ namespaces for the packages in your MATLAB code. See Organize Generated C++ Code into Namespaces.

false

The code generator does not produce C++ namespaces for the packages in your MATLAB code.

Dependency:

  • Setting TargetLang to 'C++' enables this parameter.

Data Types: logical

Namespace for the generated C++ code. The code generator does not produce code in a namespace unless you specify a nonempty character vector.

See Organize Generated C++ Code into Namespaces.

Dependency:

  • Setting TargetLang to 'C++' enables this parameter.

Namespace for the C++ code generated for MathWorks code. The code generator does not produce such a namespace if you specify this property as an empty character vector.

See Organize Generated C++ Code into Namespaces.

Dependency:

  • Setting TargetLang to 'C++' enables this parameter.

Data Types: char

Whether to generate C++ classes or C style structures for MATLAB classes, specified as one of the values in this table.

ValueDescription
true

This value is the default value.

The code generator produces C++ classes for MATLAB classes. See Generate C++ Classes for MATLAB Classes.

false

The code generator produces C style structures for MATLAB classes.

When using GPU Coder, the code generator always disables this parameter.

Dependency:

  • Setting TargetLang to 'C++' enables this parameter.

Data Types: logical

Callback class for BLAS library calls in code generated for certain low-level vector and matrix operations in MATLAB code, specified as a character vector.

If you specify a BLAS callback class, for certain low-level vector and matrix functions, the code generator produces BLAS calls by using the CBLAS C interface to your BLAS library. The callback class provides the name of your CBLAS header file, the names of CBLAS data types, and the information required to link to your BLAS library. If this parameter is empty, the code generator produces code for matrix functions instead of a BLAS call.

See Speed Up Matrix Operations in Generated Standalone Code by Using BLAS Calls.

Macro that specifies the customization of generated file names with additional characters and tokens. For more information, see Customize C/C++ File Names Generated from MATLAB Code (Embedded Coder).

Callback class for FFTW library calls in code generated for FFT functions in MATLAB code, specified as a character vector.

To improve the execution speed of FFT functions, the code generator produces calls to the FFTW library that you specify in the callback class. If this parameter is empty, the code generator uses its own algorithms for FFT functions instead of calling the FFTW library.

UseBuiltinFFTWLibrary takes precedence over CustomFFTCallback if you enable both these properties.

See Speed Up Fast Fourier Transforms in Generated Standalone Code by Using FFTW Library Calls.

Custom code that appears near the top of each C/C++ header file generated from your MATLAB code, except rtwtypes.h and rtwhalf.h, specified as a character vector.

Include folders to add to the include path when compiling the generated code. Specify the list of include folders as a string array, cell array of character vector, or character vector.

Multiple folder names, specified as one of the values in this table.

ValueDescription
String array

A string array in CustomInclude. For example, cfg.CustomInclude = ["C:\Project","C:\Custom Files"];

Cell array of character vectors

A cell array of character vectors in CustomInclude. For example, cfg.CustomInclude = {'C:\Project','C:\Custom Files'};

Character vector

Separate include folders by a pathsep character in CustomInclude. For example, cfg.CustomInclude = ['C:\Project' pathsep 'C:\Custom Files'];

Note

Specifying multiple entries in code configuration objects by using character vectors produces a warning and will be removed in a future release. Use string array and cell array of character vector instead. For more information, see Compatibility Considerations.

Custom code to include in the generated initialize function, specified as a character vector.

Callback class for LAPACK library calls in code generated for certain linear algebra functions in MATLAB code, specified as a character vector.

If you specify a LAPACK callback class, for certain linear algebra functions, the code generator produces LAPACK calls by using the LAPACKE C interface to your LAPACK library. The callback class provides the name of your LAPACKE header file and the information required to link to your LAPACK library. If this parameter is empty, the code generator produces code for linear algebra functions instead of a LAPACK call.

See Speed Up Linear Algebra in Generated Standalone Code by Using LAPACK Calls.

Static library files to link with the generated code, specified as a string array, cell array of character vector, or character vector.

Multiple static library file names, specified as one of the values in this table.

ValueDescription
String array

A string array in CustomLibrary. For example, cfg.CustomLibrary = ["myLib1.lib","myLib2.lib"];

Cell array of character vectors

A cell array of character vectors in CustomLibrary. For example, cfg.CustomLibrary = {'myLib1.lib','myLib2.lib'};

Character vector

Separate static library file names by a pathsep character in CustomLibrary. For example, cfg.CustomLibrary = ['myLib1.lib' pathsep 'myLib2.lib'];

Note

Specifying multiple entries in code configuration objects by using character vectors produces a warning and will be removed in a future release. Use string array and cell array of character vector instead. For more information, see Compatibility Considerations.

Source files to compile and link with the generated code, specified as a string array, cell array of character vector, or character vector.

The build process searches for the source files first in the current folder, and then in the include folders that you specify in CustomInclude. If source files with the same name occur in multiple folders on the search path, the build process might use a different file than the file that you specified.

Suppose that you specify foo.cpp as a source file. If foo.c and foo.cpp are both on the search path, you cannot be sure whether the build process uses foo.c or foo.cpp.

Multiple source file names, specified as one of the values in this table.

ValueDescription
String array

A string array in CustomSource. For example, cfg.CustomSource = ["mySrc1.c","mySrc2.c"];

Cell array of character vectors

A cell array of character vectors in CustomSource. For example, cfg.CustomSource = {'mySrc1.c','mySrc2.c'};

Character vector

Separate source file names by a pathsep character in CustomSource. For example, cfg.CustomSource = ['mySrc1.c' pathsep 'mySrc2.c'];

Note

Specifying multiple entries in code configuration objects by using character vectors produces a warning and will be removed in a future release. Use string array and cell array of character vector instead. For more information, see Compatibility Considerations.

Specify code to appear near the top of each generated .c or .cpp file (except rtwhalf.c or rtwhalf.cpp), outside of any function. Specify code as a character vector.

Do not specify a C static function definition.

Custom identifier format for generated EMX Array types (Embeddable mxArray types), specified as a character vector. To specify the format, see Customize Generated Identifiers (Embedded Coder).

Custom identifier format for generated EMX Array (Embeddable mxArrays) utility functions, specified as a character vector. To specify the format, see Customize Generated Identifiers (Embedded Coder).

Custom identifier format for generated local function identifiers, specified as a character vector. To specify the format, see Customize Generated Identifiers (Embedded Coder).

Custom identifier format for generated field names in global type identifiers, specified as a character vector. To specify the format, see Customize Generated Identifiers (Embedded Coder).

Custom identifier format for generated global variable identifiers, specified as a character vector. To specify the format, see Customize Generated Identifiers (Embedded Coder).

Custom identifier format for generated constant macro identifiers, specified as a character vector. To specify the format, see Customize Generated Identifiers (Embedded Coder).

Custom identifier format for generated local temporary variable identifiers, specified as a character vector. To specify the format, see Customize Generated Identifiers (Embedded Coder).

Custom identifier format for generated global type identifiers, specified as a character vector. To specify the format, see Customize Generated Identifiers (Embedded Coder).

Code that appears in the generated terminate function, specified as a character vector.

Custom settings for tools in selected toolchain, specified as a cell array.

Dependencies:

  • The Toolchain property determines which tools and options appear in the cell array.

  • Setting the BuildConfiguration property to Specify enables CustomToolchainOptions.

First, get the current settings. For example:

cfg = coder.config('lib');
cfg.BuildConfiguration='Specify';
opt = cfg.CustomToolchainOptions

Then, edit the values in opt.

These values derive from the toolchain definition file and the third-party compiler options. See Custom Toolchain Registration.

Data type replacement in generated code, specified as one of the values in this table.

ValueDescription
'CBuiltIn'

This value is the default value.

The code generator uses built-in C data types.

'CoderTypeDefs'The code generator uses predefined data types from rtwtypes.h

Configuration object for code generation for deep learning networks, specified as specified as one of the objects in this table.

ObjectRequiresDescription
coder.MklDNNConfig

  • Deep Learning Toolbox™

  • MATLAB Coder Interface for Deep Learning support package

A coder.MklDNNConfig object contains parameters specific to C++ code generation for deep learning using Intel® MKL-DNN. To create a coder.MklDNNConfig object, use coder.DeepLearningConfig. For example: 

cfg = coder.config('mex');
cfg.TargetLang = 'C++';
cfg.DeepLearningConfig = coder.DeepLearningConfig('mkldnn');

See Code Generation for Deep Learning Networks with MKL-DNN.

coder.ARMNEONConfig

  • Deep Learning Toolbox

  • MATLAB Coder Interface for Deep Learning support package

A coder.ARMNEONConfig object contains parameters specific to C++ code generation for deep learning using the ARM® Compute Library. To create a coder.ARMNEONConfig object, use coder.DeepLearningConfig. For example: 

cfg = coder.config('lib');
cfg.TargetLang = 'C++';
cfg.DeepLearningConfig = coder.DeepLearningConfig('arm-compute');

See Code Generation for Deep Learning Networks with ARM Compute Library.

coder.CuDNNConfig (GPU Coder)

  • Deep Learning Toolbox

  • GPU Coder

  • GPU Coder Interface for Deep Learning support package

A coder.CuDNNConfig object contains parameters specific to CUDA code generation for deep learning using the cuDNN library. To create a coder.CuDNNConfig object, use coder.DeepLearningConfig. For example: 

cfg = coder.gpuConfig('lib');
cfg.TargetLang = 'C++';
cfg.DeepLearningConfig = coder.DeepLearningConfig('cudnn');

See Code Generation for Deep Learning Networks by Using cuDNN (GPU Coder).

coder.TensorRTConfig (GPU Coder)

  • Deep Learning Toolbox

  • GPU Coder

  • GPU Coder Interface for Deep Learning support package

A coder.TensorRTConfig object contains parameters specific to CUDA code generation for deep learning using the TensorRT library. To create a coder.TensorRTConfig object, use coder.DeepLearningConfig. For example: 

cfg = coder.gpuConfig('lib');
cfg.TargetLang = 'C++';
cfg.DeepLearningConfig = coder.DeepLearningConfig('tensorrt');

See Code Generation for Deep Learning Networks by Using TensorRT (GPU Coder).

Dependency: If DeepLearningConfig is set, codegen sets TargetLang to C++.

Object description, specified as a character vector.

Dynamic memory allocation mode, specified as one of the values in this table.

ValueDescription
'Threshold'

This value is the default value.

The code generator allocates memory dynamically on the heap for variable-size arrays whose size (in bytes) is greater than or equal to DynamicMemoryAllocationThreshold.

'AllVariableSizeArrays'The code generator dynamically allocates memory for all variable-size arrays on the heap.
'Off'

The code generator statically allocates memory for variable-size arrays on the stack.

Unbounded variable-size arrays require dynamic memory allocation.

Dependencies:

  • EnableVariableSizing enables this parameter.

  • Setting this DynamicMemoryAllocation to 'Threshold' enables the DynamicMemoryAllocationThreshold parameter.

See Generate Code for Variable-Size Data.

Note

DynamicMemoryAllocation configuration option will be removed in a future release. To dynamically allocation memory for variable-sized arrays, use the EnableDynamicMemoryAllocation option. To set the threshold, use the DynamicMemoryAllocationThreshold option.

Dynamic memory allocation for fixed-size arrays, specified as one of the values in this table.

ValueDescription
true

The code generator allocates memory dynamically on the heap for fixed-size arrays whose size (in bytes) is greater than or equal to DynamicMemoryAllocationThreshold.

false

This value is the default value.

The code generator statically allocates memory for fixed-size arrays on the stack.

Dependency:

  • Setting EnableDynamicMemoryAllocation to true enables this option.

See, Control Dynamic Memory Allocation for Fixed-Size Arrays.

Implementation of dynamically allocated array at the interface of the generated C/C++ function, specified as one of the values in this table.

ValueDescription
'Auto'

This is the default value. If you set the TargetLang parameter to 'C++' or 'C', this value correspondingly behaves as the same flag.

'C'

The generated code uses the C style emxArray data structure to implement dynamically allocated arrays. See Use C Arrays in the Generated Function Interfaces.

'C++'

If you set the TargetLang parameter to 'C', this value is disabled.

The generated code uses the coder::array class template to implement dynamically allocated arrays. See Use Dynamically Allocated C++ Arrays in Generated Function Interfaces.

When using GPU Coder, the code generator always uses the C style emxArray data structure.

Dependency:

  • EnableVariableSizing enables this parameter.

Size threshold for dynamic memory allocation of fixed-size and variable-size arrays, specified as a positive integer. The code generator uses dynamic memory allocation for fixed-size and variable-size arrays whose size (in bytes) is greater than or equal to the threshold.

Dependency:

  • Setting DynamicMemoryAllocation to 'Threshold' enables this parameter.

See Generate Code for Variable-Size Data.

Automatic extrinsic function calls, specified as one of the values in this table.

ValueDescription
true

This value is the default value.

The code generator treats some common visualization functions as extrinsic functions. You do not have to declare these functions as extrinsic by using coder.extrinsic. This capability reduces the amount of time that you spend making your code suitable for code generation.

falseThe code generator does not treat common visualization functions as extrinsic functions unless you declare them as extrinsic by using coder.extrinsic

Some common visualization functions are plot, disp, and figure. See Use MATLAB Engine to Execute a Function Call in Generated Code.

Automatic parallelization of for loops, specified as one of the values in this table.

ValueDescription
false

This value is the default value.

Code generator does not automatically parallelize for loops.

true

The code generator automatically parallelizes for loops in the generated code. Automatic parallelization can significantly improve the execution speed of the generated code. See Automatically Parallelize for Loops in Generated Code.

When using GPU Coder, the code generator always enables automatic parallelization of for loops.

Data Types: logical

Reporting for automatic parallelization of for loops, specified as one of the values in this table.

ValueDescription
true

This value is the default value.

If you set EnableAutoParallelization to true, the code generator produces a code generation report for automatic parallelization of for loops

falseThe code generator does not produce a code generation report for automatic parallelization of for loops.

Custom names for MATLAB data types in generated C/C++ code, specified as one of the values in the table.

ValueDescription
false

This value is the default value.

Custom names for the MATLAB data types are not allowed.

true

Custom names for the MATLAB data types are allowed. Specify custom names by using ReplacementTypes. Setting EnableCustomReplacementTypes to true enables the ReplacementTypes parameter.

Dynamic memory allocation for variable-size arrays, specified as one of the values in this table.

ValueDescription
true

This value is the default value.

The code generator allocates memory dynamically on the heap for variable-size arrays whose size (in bytes) is greater than or equal to DynamicMemoryAllocationThreshold.

falseThe code generator statically allocates memory for variable-size arrays on the stack.

Implicit expansion capabilities in the generated code, specified as one of the values listed in this table.

ValueDescription
true

This value is the default value.

The code generator enables implicit expansion in the generated code. The code generator includes modifications in the generated code to apply implicit expansion. See Compatible Array Sizes for Basic Operations.

false

The generated code does not follow the rules of implicit expansion.

Data Types: logical

memcpy optimization, specified as one of the values in this table.

ValueDescription
true

This value is the default value.

If possible, the code generator uses the memcpy optimization. To optimize code that copies consecutive array elements, the memcpy optimization replaces the code with a memcpy call. When the number of elements to copy is known at compile time, the code generator uses the MemcpyThreshold property to determine whether to use the optimization. See memcpy Optimization.

false

The code generator does not use the memcpy optimization.

When using GPU Coder, the code generator always disables Memcpy optimization.

Parallelization of parfor-loops, specified as one of the values in this table.

ValueDescription
true

This value is the default value.

If possible, the code generator uses the OpenMP library to produce loop iterations that run in parallel.

false

The code generator treats parfor-loops as for-loops.

See parfor.

Use of the OpenMP library is not compatible with just-in-time (JIT) compilation. If EnableJIT and EnableOpenMP are true, the code generator uses JIT compilation and treats parfor-loops as for-loops.

When using GPU Coder, the code generator always treats parfor-loops as for-loops.

Run-time recursion support, specified as one of the values in this table.

ValueDescription
true

This value is the default value.

Recursive functions are allowed in the generated code.

false

Recursive functions are not allowed in the generated code.

Some coding standards, such as MISRA, do not allow recursion. To increase the likelihood of generating code that is compliant with MISRA C™, set EnableRuntimeRecursion to false.

If your MATLAB code requires run-time recursion and EnableRuntimeRecursion is false, code generation fails.

See Code Generation for Recursive Functions.

Replacement of multiplications by powers of two with signed left bitwise shifts in the generated C/C++ code, specified as one of the values in this table.

ValueDescription
true

This value is the default value.

The code generator uses signed left shifts for multiplication by powers of two. An example of generated C code that uses signed left shift for multiplication by eight is:

i <<= 3;

false

The code generator does not use signed left shifts for multiplication by powers of two. An example of generated C code that does not use signed left shift for multiplication by eight is:

i = i * 8;

GPU Coder always sets the EnableSignedLeftShifts property to true.

Some coding standards, such as MISRA, do not allow bitwise operations on signed integers. To increase the likelihood of generating MISRA C compliant code, set EnableSignedLeftShifts to false.

See Control Signed Left Shifts in Generated Code (Embedded Coder).

Signed right bitwise shifts in generated code, specified as one of the values in this table.

ValueDescription
true

This value is the default value.

The code generator uses signed right shifts. An example of generated C code that uses a signed right shift is:

i >>= 3

false

The code generator replaces right shifts on signed integers with a function call in the generated code. For example:

i = asr_s32(i, 3U);

GPU Coder always sets the EnableSignedRightShifts property to true.

Some coding standards, such as MISRA, do not allow bitwise operations on signed integers. To increase the likelihood of generating MISRA-C:2004 compliant code, set EnableSignedRightShifts to false.

Strength reduction optimization, specified as one of the values in this table.

ValueDescription
false

This value is the default value.

The code generator does not use the strength reduction optimization.

true

The code generator tries to use the strength reduction optimization to simplify array indexing in loops in the generated code. When possible, for array indices in loops, the code generator replaces multiply operations with add operations. Multiply operations can be expensive. When the C/C++ compiler on the target platform does not optimize the array indexing, the strength reduction optimization is useful. Even when the optimization replaces the multiply operations in the generated code, it is possible that the C/C++ compiler can generate multiply instructions.

Traceability in code generation report, specified as one of the values in this table.

ValueDescription
true

This value is the default value.

The code generation report includes code traceability. See Interactively Trace Between MATLAB Code and Generated C/C++ Code (Embedded Coder).

false

The code generation report does not include code traceability.

Variable-size array support, specified as one of the values in this table.

ValueDescription
true

This value is the default value.

Variable-size arrays are allowed for code generation.

false

Variable-size arrays are not allowed for code generation.

Dependency:

  • Enables Dynamic memory allocation.

See Code Generation for Variable-Size Arrays.

File partitioning mode specified as one of the values in this table.

ValueDescription
'MapMFileToCFile'

This value is the default value.

The code generator produces separate C/C++ files for each MATLAB language file.

'SingleFile'The code generator produces a single file for C/C++ functions that map to your MATLAB entry-point functions. The code generator produces separate C/C++ files for utility functions.

See How MATLAB Coder Partitions Generated Code.

Static code metrics report, specified as one of the values in this table.

ValueDescription
false

This value is the default value.

The code generator does not run static code metrics analysis at code generation time. You can run the analysis and produce the report later by clicking Code Metrics on the Summary tab of the code generation report.

true

The code generator runs static code metrics analysis and produces the report at code generation time.

To open a code metrics report, click the Code Metrics link on the Summary tab of the code generation report.

Dependency:

  • The code generator produces a static code metrics report only if GenerateReport is true or if you specify the -report option of the codegen report.

See Generating a Static Code Metrics Report for Code Generated from MATLAB Code (Embedded Coder).

Generation of only source code, specified as one of the values in this table.

ValueDescription
false

This value is the default value.

The code generator produces C/C++ source code and builds object code.

true

The code generator produces C/C++ source code, but does not invoke the make command or build object code. When you iterate between modifying MATLAB code and generating C/C++ code, generating only code can save time.

Code replacement report, specified as on of the values in this table.

ValueDescription
false

This value is the default value.

The code generator does not produce a code replacements report.

true

The code generator produces a code replacements report that summarizes the replacements from the selected code replacement library. The report provides a mapping between each code replacement instance and the line of MATLAB code that triggered the replacement.

Comments in generated code, specified as one of the values in this table.

ValueDescription
true

This value is the default value.

The code generator places comments in the generated code.

falseThe code generator does not place comments in the generated code.

Default case for all switch statements, specified as one of the values in this table.

ValueDescription
false

This value is the default value.

The code generator might not generate a default case for some switch statements.

trueThe code generator produces a default case for all switch statements in the generated code.

Some coding standards, such as MISRA, require the default case for switch statements.

Example C/C++ main file generation, specified as one of the values in this table.

ValueDescription
'GenerateCodeOnly'

This value is the default value.

The code generator generates an example C/C++ main function but does not compile it.

'DoNotGenerate'

The code generator does not generate an example C/C++ main function.

'GenerateCodeAndCompile'

The code generator generates an example C/C++ main function and compiles it to create a test executable. This executable does not return output.

If the GenCodeOnly parameter is true, the code generator does not compile the C/C++ main function.

An example main function is a template to help you to write a C/C++ main function that calls generated C/C++ code. See Incorporate Generated Code Using an Example Main Function.

Makefile generation during the build process, specified as one of the values in this table.

ValueDescription
true

This value is the default value.

The code generator generates a makefile during the build process.

falseThe code generator does not generate a makefile during the build process. Specify instructions for post-code-generation processing, including compilation and linking, in a post-code-generation command. See Build Process Customization.

Generation of support files for nonfinite data, specified as one of the values in this table.

ValueDescription
true

This value is the default value.

The code generator produces the support files for nonfinite data (Inf and NaN) only if the generated code uses nonfinite data.

false

The code generator always produces the support files for nonfinite data (Inf and NaN).

Dependency:

  • Setting SupportNonFinite to true enables this parameter.

Code generation report, specified as one of the values in this table.

ValueDescription
false

This value is the default value.

The code generator produces a report only if error or warning messages occur, or if you set LaunchReport to true.

trueThe code generator produces a code generation report.

Configuration object for generating CUDA GPU code using GPU Coder. A GpuCodeConfig object contains parameters specific to CUDA GPU code generation. To create a GpuCodeConfig object, use coder.gpuConfig (GPU Coder). For example: 

cfg = coder.gpuConfig('lib');
cfg.GpuConfig

ans = 

  GpuCodeConfig with properties:

                    Enabled: 1
                 MallocMode: 'discrete'
           KernelNamePrefix: ''
               EnableCUBLAS: 1
             EnableCUSOLVER: 1
                EnableCUFFT: 1
               Benchmarking: 0
                  SafeBuild: 0
          ComputeCapability: '3.5'
    CustomComputeCapability: ''
              CompilerFlags: ''
        StackLimitPerThread: 1024
            MallocThreshold: 200
     MaximumBlocksPerKernel: 0
        EnableMemoryManager: 0
             BlockAlignment: 256
                   FreeMode: 'Never'
                MinPoolSize: 8
                MaxPoolSize: 2048
           SelectCudaDevice: -1

For more information, see Code Generation Using the Command Line Interface (GPU Coder).

Dependencies: If GpuConfig is set, codegen modifies the coder.EmbeddedCodeConfig properties to values in this table.

PropertyValue
CppPreserveClassesfalse
DynamicMemoryAllocationInterface'C' when MallocMode property of GpuCodeConfig is set to 'unified'
EnableAutoParallelizationtrue
EnableMemcpyfalse
EnableOpenMPfalse
EnableSignedLeftShiftstrue
EnableSignedRightShiftstrue
IncludeInitializeFcntrue
IncludeTerminateFcntrue
InstructionSetExtensions'None'
MultiInstanceCodefalse
TargetLang'C++'

Object that specifies a hardware board. To create the coder.Hardware object, use coder.hardware. For example:

cfg = coder.config('lib');
hw = coder.hardware('Raspberry Pi');
cfg.Hardware = hw;

Before you use coder.hardware, you must install the support package for the hardware board.

Dependencies:

  • Setting Hardware customizes the hardware implementation object and other configuration parameters for a particular hardware board.

  • If DeepLearningConfig is set to a coder.ARMNEONConfig object and Hardware is empty, then codegen sets the GenCodeOnly property to true.

Note:

  • Suppose that you create a coder.CodeConfig object cfg in a MATLAB session and use it in another MATLAB session. If the MATLAB host computer for the second session does not have the hardware board specified in the cfg.Hardware property installed on it, this parameter reverts to its default value. The default value is []. Setting the Hardware Board option to MATLAB Host Computer in the app is equivalent to using cfg.Hardware and cfg.HardwareImplementation.ProdHWDeviceType with their default value.

To specify a hardware board for PIL execution, see PIL Execution with ARM Cortex-A at the Command Line (Embedded Coder).

Hardware implementation object that specifies hardware-specific configuration parameters for C/C++ code generation. coder.config creates a coder.EmbeddedCodeConfig object with the HardwareImplementation property set to a coder.HardwareImplementation object with default parameter values for the MATLAB host computer.

To prevent compilation errors due to multiple inclusion of header files, the code generator produces either #ifndef or #pragma once constructs in generated header files. If your project uses distinct files that use the same preprocessor macros, then generate code with the #pragma once construct. The compilation behavior of #pragma once is not standardized.

Specify HeaderGuardStyle as one of the values in this table.

ValueDescription
UseIncludeGuard

The code generator produces #ifndef style #include guards.

UsePragmaOnceThe code generator produces #pragma once style #include guards.

Highlighting of potential data type issues in the code generation report, specified as one of the values in this table.

ValueDescription
false

This value is the default value.

This code generation report does not highlight potential data type issues.

true

The code generation report highlights MATLAB code that results in single-precision or double-precision operations in the generated C/C++ code. If you have Fixed-Point Designer™, the report also highlights expressions in the MATLAB code that result in expensive fixed-point operations in the generated code.

Display of potential row-major layout efficiency issues, specified as one of the values in this table.

ValueDescription
true

The code generation report displays potential efficiency issues due to row-major layout. (This value is the default value.)

falseThe code generation report does not display issues related to array layout.

See Code Design for Row-Major Array Layout.

Initialize function generation, specified as one of the values in this table.

ValueDescription
true

This value is the default value.

The code generator produces an initialize function.

false

The code generator does not produce an initialize function. If you set IncludeInitializeFcn to false and an initialize function is required, for example, to call supporting code for nonfinite data (Inf or NaN), the code generator produces an error message.

See MATLAB Code Patterns That Require a Nonempty Initialize Function in Generated Code (Embedded Coder).

When using GPU Coder, the code generator always produces an initialize function.

Terminate function generation, specified as one of the values in this table.

ValueDescription
true

This value is the default value.

The code generator produces a terminate function.

false

The code generator does not produce a terminate function. If you set IncludeTerminateFcn to false and a terminate function is required, for example, to free memory, the code generator issues a warning.

When using GPU Coder, the code generator always produces an terminate function.

Number of characters per indentation level, specified as a positive integer in the range [2,8].

Style for placement of braces in the generated code, specified as one of the values in this table.

ValueDescription
'K&R'

This value is the default value.

For blocks within a function, an opening brace is on the same line as its control statement. For example:

void addone(const double x[6], double z[6])
{
  int i0;
  for (i0 = 0; i0 < 6; i0++) {
    z[i0] = x[i0] + 1.0;
  }
}

'Allman'

For blocks within a function, an opening brace is on its own line at the same indentation level as its control statement. For example:

void addone(const double x[6], double z[6])
{
  int i0;
  for (i0 = 0; i0 < 6; i0++)
  {
    z[i0] = x[i0] + 1.0;
  }
}

Assignment of float and double zero with memset, specified as one of the values in this table.

ValueDescription
true

This value is the default value.

If possible, the code generator uses the memset optimization for assignment of floating-point zero to consecutive array elements. To assign consecutive array elements, the memset optimization uses a memset call. When the number of elements to assign is known at compile time, the code generator uses the MemcpyThreshold property to determine whether to use the optimization. See memset Optimization.

false

The code generator does not use the memset optimization for assignment of float and double zero to consecutive array elements.

Inlining behavior at all call sites where a MathWorks calls another MathWorks function, specified as one of the values in this table.

ValueDescription
'Speed'

This value is the default value.

Uses internal heuristics to determine whether to perform inlining at a call site. This setting usually leads to highly optimized code.

'Always'

Always performs inlining at a call site.

'Readability'

Almost never inlines function calls, except for calls to very small functions. Preserves modularity of code without sacrificing too much speed, whenever possible. Results in highly readable code.

'Never'

Never inlines function calls. Results in maximum readability. This setting might significantly reduce the performance of the generated code.

Even if you select the 'Always' or the 'Never' option for a setting, in certain cases, the code generator might not strictly follow that instruction. For example, if there is a conflict, the coder.inline('always') or coder.inline('never') directive placed inside a function body overrides this option. For more information, see Interaction Between Different Inlining Controls.

See Control Inlining to Fine-Tune Performance and Readability of Generated Code.

Inlining behavior at all call sites where a function that you wrote calls a MathWorks function, or a MathWorks function calls a function that you wrote. Specified as one of the values in this table.

ValueDescription
'Speed'

This value is the default value.

Uses internal heuristics to determine whether to perform inlining at a call site. This setting usually leads to highly optimized code.

'Always'

Always performs inlining at a call site.

'Readability'

Almost never inlines function calls, except for calls to very small functions. Preserves modularity of code without sacrificing too much speed, whenever possible. Results in highly readable code.

'Never'

Never inlines function calls. Results in maximum readability. This setting might significantly reduce the performance of the generated code.

Even if you select the 'Always' or the 'Never' option for a setting, in certain cases, the code generator might not strictly follow that instruction. For example, if there is a conflict, the coder.inline('always') or coder.inline('never') directive placed inside a function body overrides this option. For more information, see Interaction Between Different Inlining Controls.

See Control Inlining to Fine-Tune Performance and Readability of Generated Code.

Inlining behavior at all call sites where a function that you wrote calls another function that you wrote, specified as one of the values in this table.

ValueDescription
'Speed'

This value is the default value.

Uses internal heuristics to determine whether to perform inlining at a call site. This setting usually leads to highly optimized code.

'Always'

Always performs inlining at a call site.

'Readability'

Almost never inlines function calls, except for calls to very small functions. Preserves modularity of code without sacrificing too much speed, whenever possible. Results in highly readable code.

'Never'

Never inlines function calls. Results in maximum readability. This setting might significantly reduce the performance of the generated code.

Even if you select the 'Always' or the 'Never' option for a setting, in certain cases, the code generator might not strictly follow that instruction. For example, if there is a conflict, the coder.inline('always') or coder.inline('never') directive placed inside a function body overrides this option. For more information, see Interaction Between Different Inlining Controls.

See Control Inlining to Fine-Tune Performance and Readability of Generated Code.

Instruction sets to generate single instruction, multiple data (SIMD) code for target hardware. This list shows the dependency of the instruction sets, where each instruction set depends on the instruction sets that precede it. The code generator loads the selected instruction set and the instruction sets that it depends on. For example, if you select AVX, the code generator loads AVX, SSE4.1, SSE2, and SSE.

See Generate SIMD Code for MATLAB Functions.

When using GPU Coder, the code generator always disables InstructionSetExtensions.

Annotates the generated C/C++ code to suppress known MISRA and AUTOSAR violations, specified as one of the values in this table.

ValueDescription
false

This value is the default value.

The code generator does not add annotations to the generated C/C++ code.

trueThe code generator adds annotations to the generated C/C++ code only if GenerateComments is also true.

Automatic open of code generation report, specified as one of the values in this table.

ValueDescription
false

This value is the default value.

If errors or warnings occur, or if GenerateReport is true, the code generator produces a report, but does not open the report.

trueThe code generator produces and opens a code generation report.

Loops with fewer iterations than this threshold are candidates for automatic unrolling by the code generator. This threshold applies to all for-loops and parfor-loops in your MATLAB code. For an individual for-loop, a coder.unroll directive placed immediately before the loop takes precedence over the loop unrolling optimization. The threshold can also apply to some for-loops produced during code generation.

See Unroll for-Loops and parfor-Loops.

MATLAB function help text in function banner in generated code specified as one of the values in this table.

ValueDescription
true

This value is the default value.

The code generator includes MATLAB function help text in the function banner in the generated code.

false

The code generator treats the help text as a user comment.

If not selected, MATLAB Coder treats the help text as a user comment.

Dependencies:

  • GenerateComments enables this parameter.

Inclusion of MATLAB source code as comments in generated code, specified as one of the values in this table.

ValueDescription
false

This value is the default value.

The code generator does not insert MATLAB source code as comments in the generated code. The code generator does not include the MATLAB function signature in the function banner.

true

The code generator inserts MATLAB source code as comments in the generated code. A traceability tag immediately precedes each line of source code. The traceability tag helps you to locate the corresponding MATLAB source code. See Tracing Generated C/C++ Code to MATLAB Source Code.

If you have Embedded Coder, in the code generation report, the traceability tag links to the source code.

The code generator also includes the MATLAB function signature in the function banner.

Dependency:

  • GenerateComments enables this parameter.

See Tracing Generated C/C++ Code to MATLAB Source Code.

Whether to include line numbers of MATLAB source code as comments in the generated code, specified as true or false. Setting this property to false removes traceability tags from the code generation report.

Dependency:

  • Setting GenerateComments to true enables this parameter.

Maximum number of characters in generated identifiers, specified as a positive integer in the range [31, 2048]. This property applies to generated function, type definition, and variable names. To avoid truncation of identifiers by the target C/C++ compiler, specify a value that matches the maximum identifier length of the target C/C++ compiler.

This property does not apply to exported identifiers, such as the generated names for entry-point functions or emxArray API functions. If the length of an exported identifier exceeds the maximum identifier length of the target C/C++ compiler, the target C/C++ compiler truncates the exported identifier.

Default values:

  • If TargetLang is set to 'C', the default value of MaxIdLength is 31.

  • If TargetLang is set to 'C++', the default value of MaxIdLength is 1024.

Minimum size, in bytes, for memcpy or memset optimization, specified as a positive integer.

To optimize generated code that copies consecutive array elements, the code generator tries to replace the code with a memcpy call. To optimize generated code that assigns a literal constant to consecutive array elements, the code generator tries to replace the code with a memset call.

The number of bytes is the number of array elements to copy or assign multiplied by the number of bytes required for the C/C++ data type.

If the number of elements to copy or assign is variable (not known at compile time), the code generator ignores the MemcpyThreshold property.

See memcpy Optimization and memset Optimization.

Multi-instance, reentrant code, specified as one of the values in this table.

ValueDescription
false

This value is the default value.

The code generator does not produce multi-instance, reentrant code.

true

The code generator produces reusable, multi-instance code that is reentrant.

See Reentrant Code.

This option is not supported by the GPU Coder product.

Object name, specified as a character vector.

Maximum number of CPU threads to run parallel for-loops in the generated C/C++ code, specified as a positive integer.

See Specify Maximum Number of Threads to Run Parallel for-Loops in the Generated Code.

To generate SIMD code for reduction operations, use one of the values as specified in this table.

ValueDescription
false

This value is the default value.

Code generator does not generate SIMD code for reduction operations.

true

To use this parameter, you must select an instruction set for the InstructionSetExtensions parameter. The code generator uses the specified instruction set to generate SIMD code for reduction operations.

See Generate SIMD Code for MATLAB Functions.

To generate parallel for-loops performing reduction operations, use one of the values as specified in this table.

ValueDescription
false

This value is the default value.

Code generator does not automatically parallelize for-loops performing reduction operations.

true

The code generator automatically parallelizes for-loops performing reduction operations in the generated code, only if you set EnableAutoParallelization to true.

See Reduction Operations Supported for Automatic Parallelization of for-loops.

Note

Vectorizing and parallelizing reduction operations might introduce slight numerical deviations. For more information, see Handling Overflow in Automatic Parallelization of for-loops.

Output to build from generated C/C++ code, specified as one of the values in this table.

ValueDescription
'LIB'Static library
'DLL'Dynamically linked library
'EXE'Executable program

Parenthesization level in the generated code, specified as one of the values in this table.

ValueDescription
'Nominal'

This value is the default value.

The code generator inserts parentheses to balance readability and visual complexity. For example:

Out = ((In2 - In1 > 1.0) && (In2 > 2.0));

'Maximum'

The code generator includes parentheses to specify meaning without relying on operator precedence. Code generated with this setting conforms to MISRA requirements. For example:

 Out = (((In2 - In1) > 1.0) && (In2 > 2.0));

'Minimum'

The code generator inserts parentheses where required by ANSI® C or C++, or to override default precedence. For example: 

Out = In2 - In1 > 1.0 && In2 > 2.0;

If you generate C/C++ code that uses the minimum level, for certain settings in some compilers, you can receive compiler warnings. To eliminate these warnings, try the nominal level.

Pass structures by reference to entry-point functions, specified as one of the values in this table.

ValueDescription
true

This value is the default value.

The generated code passes structures by reference, which reduces memory usage and execution time by minimizing the number of copies of parameters at entry-point function boundaries.

Note

An entry-point function that writes to a field of a structure parameter overwrites the input value.

falseThe generated code passes structures by value.

This parameter applies only to entry-point functions.

See Pass Structure Arguments by Reference or by Value in Generated Code.

Command to customize build processing after MEX function generation with codegen, specified as a character vector.

See Build Process Customization.

Preservation of the extern keyword in function declarations in the generated code, specified as one of the values in this table.

ValueDescription
true

This value is the default value.

The code generator includes the extern keyword in declarations for external functions.

false

The code generator removes the extern keyword from function declarations.

Generation of code that uses N-dimensional indexing, specified as one of the values in this table.

ValueDescription
false

Generate code that uses one-dimensional indexing. (This value is the default value.)

trueGenerate code that uses N-dimensional indexing.

See Generate Code That Uses N-Dimensional Indexing.

Preserve unused class properties or structure fields in the generated C/C++ code, specified as one of the values in this table.

ValueDescription
false

This value is the default value.

The code generator produces the C/C++ code by removing the unused properties and fields in the generated code.

true

The code generator produces the C/C++ code by preserving the unused properties and fields in the generated code.

See Removal of Unused Class Properties in Generated C/C++ Code (Embedded Coder).

Variable names to preserve in the generated code, specified as one of the values in this table.

ValueDescription
'None'

This value is the default value.

The code generator does not have to preserve any variable names. It can reuse any variables that meet the requirements for variable reuse.

If your code uses large structures or arrays, setting PreserveVariableNames to 'None' can reduce memory usage or improve execution speed.

'UserNames'

The code generator preserves names that correspond to variables that you define in the MATLAB code. It does not replace your variable name with another name and does not use your name for another variable. To improve readability, set PreserveVariableNames to 'UserNames'. Then, you can more easily trace the variables in the generated code back to the variables in your MATLAB code.

Setting PreserveVariableNames to 'UserNames' does not prevent an optimization from removing your variables from the generated code or prevent the C/C++ compiler from reusing the variables in the generated binary code.

'All'

Preserve all variable names. This parameter value disables variable reuse. Use it only for testing or debugging, not for production code.

See Preserve Variable Names in Generated Code.

Detection of floating-point code, specified as one of the values in this table.

ValueDescription
false

This value is the default value.

The code generator allows floating-point data and operations.

true

The code generator does not allow floating-point data or operations. If the code generator detects floating-point data or operations, code generation ends with an error.

Dependency:

  • Setting PurelyIntegerCode to true disables the SupportNonFinite parameter. Setting PurelyIntegerCode to false enables the SupportNonFinite parameter.

Specify custom names for these MATLAB built-in data types: double, single, uint8, uint16, uint32, uint64, int8, int16, int32, int64, char, and logical that are in the generated C/C++ code.

Dependency:

Name of variable to which you export information about code generation, specified as a character vector. The code generator creates this variable in the base MATLAB workspace. This variable contains information about code generation settings, input files, generated files, and code generation messages.

See Access Code Generation Report Information Programmatically and coder.ReportInfo Properties.

Potential difference reporting, specified as one of the values in this table:

ValueDescription
trueThe code generator reports potential behavior differences between generated code and MATLAB code. The potential differences are listed on a tab of the code generation report. A potential difference is a difference that occurs at run time only under certain conditions.
falseThe code generator does not report potential differences.

See Potential Differences Reporting.

Option to include requirement links (Requirements Toolbox™) as comments, specified as true or false.

The comments appear as hyperlinks in the code generation report that navigate to the requirement and linked MATLAB code range. See Requirements Traceability for Code Generated from MATLAB Code (Requirements Toolbox).

List of names that the code generator must not use for functions or variables, specified as a string arrays, cell array of character vectors, or character vector.

Multiple reserved names, specified as one of the values in this table.

ValueDescription
String arrays

A string array in ReservedNameArray. For example, cfg.ReservedNameArray = ["reserve1","reserve2","reserve3"].

Cell array of character vectors

A cell array of character vectors in ReservedNameArray. For example, cfg.ReservedNameArray = {'reserve1','reserve2','reserve3'}.

Character vectors

A semicolon-separated list of reserved names in ReservedNameArray. For example, cfg.ReservedNameArray = 'reserve1;reserve2;reserve3'.

Note

Specifying multiple entries in code configuration objects by using character vectors will be removed in a future release. Use string array and cell array of character vector instead. For more information, see Compatibility Considerations.

Generation of code that uses row-major array layout, specified as one of the values in this table.

ValueDescription
false

Generate code that uses column-major array layout. (This value is the default value.)

trueGenerate code that uses row-major array layout.

See Generate Code That Uses Row-Major Array Layout.

Generation of a call to the initialize function at the beginning of the generated entry-point functions, specified as one of the values in this table.

ValueDescription
true

This value is the default value.

A call to the initialize function is included at the beginning of the generated entry-point functions. The generated code includes checks to make sure that the initialize function is called only once, even if there are multiple entry-point functions.

false

The generated entry-point functions do not include calls to the initialize function.

Dependency:

  • Setting IncludeInitializeFcn and IncludeTerminateFcn to true enables this parameter.

  • Setting MultiInstanceCode to true disables this parameter.

See Use Generated Initialize and Terminate Functions.

Run-time error detection and reporting in generated code, specified as one of the values in this table.

ValueDescription
false

This value is the default value.

The generated code does not check for errors such as out-of-bounds array indexing.

true

The generated code checks for errors such as out-of-bounds array indexing.

The error-reporting software uses fprintf to write error messages to stderr. It uses abort to terminate the application. If fprintf and abort are not available, you must provide them. The abort function abruptly terminates the program. If your system supports signals, you can catch the abort signal (SIGABRT) so that you can control the program termination.

Error messages are in English.

See Generate Standalone C/C++ Code That Detects and Reports Run-Time Errors.

Integer overflow support, specified as one of the values in this table.

ValueDescription
true

This value is the default value.

The code generator produces code to handle integer overflow. Overflows saturate to either the minimum or maximum value that the data type can represent.

false

The code generator does not produce code to handle integer overflow. Do not set SaturateOnIntegerOverflow to false unless you are sure that your code does not depend on integer overflow support. If you disable integer overflow support and run-time error checking is enabled, the generated code produces an error for overflows. If you disable integer overflow support and you disable run-time error checking, the overflow behavior depends on your target C compiler. In the C standard, the behavior for integer overflow is undefined. However, most C compilers wrap on overflow.

This parameter applies only to MATLAB built-in integer types. It does not apply to doubles, singles, or fixed-point data types.

See Disable Support for Integer Overflow or Nonfinites.

Debugging of generated code during a software-in-the-loop (SIL) or processor-in-the-loop (PIL) execution, specified as one of the values in this table.

ValueDescription
false

This value is the default value.

Disables debugging of generated code during a SIL or PIL execution.

true

Enables the debugger to observe code behavior during a software-in-the-loop (SIL) or processor-in-the-loop (PIL) execution.

Supported debuggers for SIL execution:

  • On Windows®:

    • Microsoft® Visual Studio® IDE.

    • Visual Studio Code with MinGW® GDB. Requires installation of MATLAB Coder Interface for Visual Studio Code Debugging support package.

  • On macOS, Visual Studio Code with LLDB. Requires installation of MATLAB Coder Interface for Visual Studio Code Debugging support package.

  • On Linux®:

    • GNU® Data Display Debugger (DDD).

    • Visual Studio Code with GDB. Requires installation of MATLAB Coder Interface for Visual Studio Code Debugging support package.

For information about installing the support package, see https://www.mathworks.com/matlabcentral/fileexchange/103555-matlab-coder-interface-for-visual-studio-code-debugging.

For information about setting up debuggers for PIL execution, see Set Up PIL Connectivity by Using target Package (Embedded Coder).

See Debug Generated Code During SIL or PIL Execution (Embedded Coder).

Constant input checking mode for a SIL or PIL execution, specified as one of the values in this table.

ValueDescription
true

This value is the default value.

The SIL or PIL execution compares the value that a test file provides for a constant input argument with the value specified at code generation time. If the values do not match, an error occurs.

false

The SIL or PIL execution does not compare the value that a test file provides for a constant input argument with the value specified at code generation time. The SIL or PIL execution uses the value specified at code generation time. If the test file uses a different value, then the results in MATLAB might differ from the results in the SIL or PIL execution.

It is possible to speed up a SIL or PIL execution by setting SILPILCheckConstantInputs to false.

See Speed Up SIL/PIL Execution by Disabling Constant Input Checking and Global Data Synchronization (Embedded Coder)

Global data synchronization mode for a SIL or PIL execution, specified as one of the values in this table.

ValueDescription
true

This value is the default value.

A SIL or PIL execution synchronizes the values of global variables in the SIL or PIL execution environment with the values in the MATLAB workspace. If a global variable is constant and its value in the SIL or PIL execution environment differs from its value in the MATLAB workspace, an error occurs.

false

The SIL or PIL execution does not synchronize the values of global variables in the SIL or PIL execution environment with the values in the MATLAB workspace. If the values are not synchronized, the results in MATLAB might differ from the results in the SIL or PIL execution.

It is possible to speed up a SIL or PIL execution by setting SILPILSyncGlobalData to false.

See Speed Up SIL/PIL Execution by Disabling Constant Input Checking and Global Data Synchronization (Embedded Coder)

Display of communication I/O information during software-in-the-loop (SIL) or processor-in-the-loop (PIL) execution, specified as one of the values in this table.

ValueDescription
'off'

This value is the default value.

The code generator does not display communication I/O information during SIL or PIL execution.

'on'

The code generator displays communication I/O information during SIL or PIL execution.

See Troubleshooting Host-Target Communication (Embedded Coder).

Maximum stack usage per application, in bytes, specified as a positive integer. Set a limit that is lower than the available stack size. Otherwise, a run-time stack overflow might occur. The C compiler detects and reports stack overflows.

See Disable Support for Integer Overflow or Nonfinites.

Support for nonfinite values, specified as one of the values in this table.

ValueDescription
true

This value is the default value.

If GenerateNonFiniteFilesIfUsed is set to true, the code generator produces code to support nonfinite values (Inf and NaN) only if they are used.

If GenerateNonFiniteFilesIfUsed is set to false, the code generator always produces code to support nonfinite values (Inf and NaN).

false

The code generator does not produce code to support nonfinite values.

See Disable Support for Integer Overflow or Nonfinites.

Language to use in generated code, specified as 'C' or 'C++'.

When using GPU Coder, the code generator sets TargetLang to C++.

Dependency: If DeepLearningConfig is set, codegen sets TargetLang to C++.

Language standard to use for the generated code, specified as one of these character vectors:

  • 'Auto'

  • 'C89/C90 (ANSI)'

  • 'C99 (ISO)'

  • 'C++03 (ISO)'

  • 'C++11 (ISO)'

Selecting the 'Auto' option sets the TargetLangStandard based on the TargetLang setting. For C, the default standard is 'C99 (ISO)'. For C++, the default standard is 'C++11 (ISO)'. The code generator uses the language features and the math libraries available in the selected C/C++ standard. See Change the Language Standard.

Toolchain to use for building a C/C++ library or executable program, specified as a character vector. The list of available toolchains depends on the host computer platform, and can include custom toolchains that you added. If you do not specify a toolchain, the code generator locates an installed toolchain.

Note:

  • Suppose that you create a coder.CodeConfig object cfg in a MATLAB session and use it in another MATLAB session. If the MATLAB host computer for the second session does not have the toolchain specified in the cfg.Toolchain property installed on it, this parameter reverts to its default value. The default value is 'Automatically locate an installed toolchain'.

Whether to generate code that produces calls to the FFTW library shipped with MATLAB for fast Fourier transform (FFT) functions in your MATLAB code, specified as one of the values in this table.

ValueDescription
false

This value is the default value.

The code generator does not produce calls to the built-in FFTW library for FFT functions in your MATLAB code.

true

The code generator produces calls to the built-in FFTW library for FFT functions in your MATLAB code.

UseBuiltinFFTWLibrary takes precedence over CustomFFTCallback if you enable both these properties.

Data Types: logical

Code generation progress display, specified as one of the values in this table.

ValueDescription
false

This value is the default value.

The code generator does not display code generation progress.

true

The code generator displays code generation progress, including code generation stages and compiler output.

Whether to display the status of the code generation progress at the MATLAB command line, specified as one of the values in this table.

ValueDescription
'Silent'

If code generation succeeds without warning, all messages are suppressed, including when you generate a report.

Warning and error messages are displayed.

'Info'

This value is the default value.

Compared to the 'Silent' mode, if code generation succeeds, these additional messages are displayed:

  • Code generation successful

  • Link to the generated report, if one has been generated

'Verbose'

In addition to the messages shown in the 'Info' mode, code generation status and target build log messages are displayed.

Code verification mode, specified as one of the values in this table.

ValueDescription
'None'Normal execution
'SIL'Software-in-the-loop (SIL) execution
'PIL'Processor-in-the-loop (PIL) execution

See Code Verification Through Software-in-the-Loop and Processor-in-the-Loop Execution (Embedded Coder).

Examples

collapse all

Write a MATLAB function from which you can generate code. This example uses the function myadd that returns the sum of its inputs.

function c = myadd(a,b)
c = a + b;
end

Create a configuration object for generation of standalone C/C++ code (a static library, a dynamically linked library, or an executable program). For example, create a configuration object for generation of a static library.

cfg = coder.config('lib');

If Embedded Coder is installed, coder.config creates a coder.EmbeddedCodeConfig object.

Change the values of the properties for which you do not want to use the default values. For example,change the comment style in the generated code to single-line comments preceded by //.

cfg.CommentStyle = 'Single-line';

The CommentStyle property is available only in an Embedded Coder configuration object.

Generate code by using codegen. Pass the configuration object to codegen by using the -config option. Specify that the input arguments are scalar double.

codegen myadd -config cfg -args {1 1} -report

Alternative Functionality

To use default configuration parameters for build types 'LIB', 'DLL', or 'EXE', use the codegen option -config:lib, -config:dll, or -config:exe, respectively. Then, you do not have to create and pass a configuration object to codegen.

Version History

Introduced in R2011a

expand all

See Also

Functions

Objects

Topics