Input Specification

Specify properties of MATLAB^® function input variables to enable code generation

For code generation, you must specify the sizes and types of input variables to the entry-point function. You can specify input types:

In your MATLAB code, by performing function argument validation in the entry-point function using arguments blocks. If you specify input types using arguments blocks, you can also specify other variable attributes, including whether the input data is complex, sparse, or a GPU array, using validators such as coder.mustBeComplex.
Using the MATLAB Coder™ app.
At the command line, using the -args argument to the codegen command. Input types specified at the command line using the -args argument can be pre-configured using the coderTypeEditor or functions such as coder.typeof.
In your MATLAB code, by performing preconditioning using assert statements.

Apps

MATLAB Coder

Generate C code or MEX function from MATLAB code

Functions

expand all

Input Type Specification at the Command Line

`codegen`	Generate C/C++ code from MATLAB code
`coder.getArgTypes`	Determine types of function input arguments by executing test file
`coder.newtype`	Create `coder.Type` object to represent type of an entry-point function input
`coder.resize`	Resize `coder.Type` object
`coder.typeof`	Create `coder.Type` object to represent the type of an entry-point function input
`coderTypeEditor`	Launch the Coder Type Editor dialog box

Input Type Specification in MATLAB Code Using Function Argument Validation

`arguments`	Declare function argument validation
`coder.mustBeComplex`	Validate that value lies on the complex plane (Since R2023b)
`coder.specifyAsGPU`	Specify that value is a GPU input to an entry-point function for GPU code generation (Since R2023b)
`coder.varsize`	Resolve size incompatibility errors and declare upper bounds
`mustBeA`	Validate that value comes from one of specified classes (Since R2020b)
`mustBeNonsparse`	Validate that value is nonsparse
`mustBeReal`	Validate that value is real
`mustBeSparse`	Validate that value is sparse (Since R2023b)

Input Type Specification in MATLAB Code Using Preconditioning

assert Throw error if condition false

Classes

expand all

Classes Used With the `-args` Argument at the Command Line

`coder.ArrayType`	Represent set of MATLAB arrays acceptable for input specification
`coder.CellType`	Represent set of MATLAB cell arrays
`coder.ClassType`	Represent set of MATLAB classes acceptable for input specification
`coder.Constant`	Specification of constant value for code generation
`coder.EnumType`	Represent set of MATLAB enumerations acceptable for input specification
`coder.FiType`	Represent set of MATLAB fixed-point arrays acceptable for input specification
`coder.PrimitiveType`	Represent set of logical, numeric, or character arrays acceptable for input specification
`coder.StructType`	Represent set of MATLAB structure arrays acceptable for input specification
`coder.StringType`	Represent set of MATLAB strings acceptable for input specification (Since R2022b)
`coder.Type`	Represent set of MATLAB values acceptable for input specification

Objects

coder.OutputType Output type from an entry-point function to specify as an input type

Topics

Input Specification Basics

Specify Types of Entry-Point Function Inputs
How and why to perform input-type specification.
Specify Number of Input or Output Arguments to Entry-Point Functions
Control the number of input or output arguments in the generated code.
Specify Value Class Objects as Inputs
Specify that an entry-point input is an object of a value class.

Specify Input Types in MATLAB Code

Use Function Argument Validation to Specify Entry-Point Input Types
Specify the types of the entry-point function inputs using an arguments block.
Specify Input Types Using assert Statements in MATLAB Code
Specify the types of entry-point function inputs by using the assert function.

Specify Input Types Using MATLAB Coder App

Define Types of Entry-Point Inputs by Using the MATLAB Coder App
Specify the types of entry-point function inputs using the MATLAB Coder app.
Define Global Variables in the MATLAB Coder App
Use the MATLAB Coder app to specify the types and initial values of global variables that your MATLAB code uses.

Specify Input Types at the Command Line

Specify Input Types at the Command Line
Specify entry-point function input type by using the -args option.
Create and Edit Input Types by Using the Coder Type Editor
Define and edit coder.Type objects interactively.
Pass an Entry-Point Function Output as an Input
Simplify input type specification for multiple entry-point functions.
Specify Cell Array Inputs at the Command Line
Provide an example cell array, define a cell array type, or specify a cell array constant input.
Specify Global Cell Arrays at the Command Line
Specify global cell array inputs with the -globals option.
Specify String Scalar Inputs at the Command Line
Specify string scalar inputs at the command line.

Troubleshooting

Resolve Issue: Using arguments Blocks to Specify Cell or Structure Entry-Point Input Types is Not Supported
Troubleshoot code generation error if cells or structs are used for input-type specification in the arguments block of an entry-point function.

How useful was this information?

Unrated 1 star 2 stars 3 stars 4 stars 5 stars