妈TLAB Function

Include妈TLABcode in models that generate embeddable C code

expand all in page

Library:
Simulink / User-Defined Functions
HDL Coder / User-Defined Functions

Description

With a妈TLAB Functionblock, you can write a MATLAB^®function for use in a Simulink^®model. The MATLAB function you create executes for simulation and generates code for aSimulink Coder™target. If you are new to the Simulink and MATLAB products, seeImplementing MATLAB Functions Using BlocksandCreate Custom Functionality Using MATLAB Function Blockfor an overview.

Double-clicking the MATLAB Function block opens its editor, where you write the MATLAB function, as in this example:

To learn more about this editor, see妈TLAB Function Block Editor.

You specify input and output data to the妈TLAB Functionblock in the function header as arguments and return values. The argument and return values of the preceding example function correspond to the inputs and outputs of the block in themodel:

You can also define data, input triggers, and function call outputs using the Ports and Data Manager, which you access from the MATLAB Function Block Editor by selectingEdit Data. SeePorts and Data Manager.

The妈TLAB Functionblock generates efficient embeddable code based on an analysis that determines the size, class, and complexity of each variable. This analysis imposes the following restrictions:

The first assignment to a variable defines its, size, class, and complexity.
SeeBest Practices for Defining Variables for C/C++ Code Generation.
You cannot reassign variable properties after the initial assignment except when using variable-size data or reusing variables in the code for different purposes.
SeeReassignment of Variable Properties.

In addition to language restrictions, the妈TLAB Function块支持f的一金宝app个子集unctions available in MATLAB. A list of supported functions is given inFunctions and Objects Supported for C/C++ Code Generation. These functions include functions in common categories, such as:

Arithmetic operators likeplus,minus,power. For more information, seeArray vs. Matrix Operations.
Matrix operations likesize,length
Advanced matrix operations likelu,inv,svd,chol
Trigonometric functions likesin,cos,sinh,cosh

Note

Although the code for this block attempts to produce exactly the same results as MATLAB, differences might occur due to rounding errors. These numerical differences, which might be a fewepsinitially, can magnify after repeated operations. Reliance on the behavior ofnanis not recommended. Different C compilers can yield different results for the same computation.

Note

In the妈TLAB Functionblock, the%#codegendirective is included to emphasize that the block’s MATLAB algorithm is always intended for code generation. The%#codegendirective, or the absence of it, does not change the error checking behavior in the context of the妈TLAB Functionblock. For more information seeCompilation Directive %#codegen.

To support visualization of data, the妈TLAB Functionblock supports calls to MATLAB functions for simulation only. SeeUse MATLAB Engine to Execute a Function Call in Generated Codeto understand some of the limitations of this capability, and how it integrates with code analysis for this block. If these function calls do not directly affect any of the Simulink inputs or outputs, the calls do not appear inSimulink Codergenerated code.

From妈TLAB Functionblocks, you can also call functions defined in a金宝app仿真软件的功能block. You can call Stateflow^®functions withExport Chart Level Functions (Make Global)andAllow exported functions to be called by Simulinkchecked in the chart Properties dialog box.

In the Ports and Data Manager, you can declare a block input to be a Simulink parameter instead of a port. The妈TLAB Functionblock also supports inheritance of types and size for inputs, outputs, and parameters. You can also specify these properties explicitly. See函数参数类型,Size Function Arguments,Add Parameter Argumentsfor descriptions of variables that you use in妈TLAB Functionblocks.

Recursive calls are not allowed in妈TLAB Functionblocks.

By default,妈TLAB Functionblocks have direct feedthrough enabled. To disable it, in the Ports and Data Manager, clear theAllow direct feedthroughcheck box. Nondirect feedthrough semantics ensure that outputs rely only on the current state. Using nondirect feedthrough enables you to use妈TLAB Functionblocks in a feedback loop and prevent algebraic loops. For more information, seeUse Nondirect Feedthrough in a MATLAB Function Block.

Ports

Input

expand all

`u`— Input argument`u`
scalar | vector | matrix

Input corresponding to the first input argument of the function inside the妈TLAB Functionblock. If you rename the function argument in the editor, the block renames the port correspondingly.

Data types supported by MATLAB but not supported by Simulink may not be passed between the Simulink model and the function within the妈TLAB Functionblock. These types may be used within the妈TLAB Functionblock.

For more information on fixed-point support for this block, refer toFixed-Point Data Types with MATLAB Function Block(Fixed-Point Designer)and妈TLAB Function Block with Data Type Override(Fixed-Point Designer).

`n`— Input argument`n`
scalar | vector | matrix

nth input argument to the function in the妈TLAB Functionblock. When you add the argument in the editor, the block adds the port correspondingly.

Output

expand all

`y`— Output argument
scalar | vector | matrix

First output argument of the function inside the妈TLAB Functionblock. If you rename the function argument in the editor, the block renames the port correspondingly.

`n`— Output argument`n`
scalar | vector | matrix

nth output argument from the function inside the妈TLAB Functionblock. When you add the argument in the editor, the block adds the port correspondingly.

模型的例子

Radar Tracking Using MATLAB Function Block

Use an extended Kalman filter with the MATLAB® Function block in Simulink® to estimate an aircraft's position from radar measurements. The filter implementation is found in the MATLAB Function block, the contents of which are stored in the Simulink model itself.

Open Model

Spiral Galaxy Formation Simulation Using MATLAB Function Blocks

This model was inspired by the classic paper "Galactic Bridges and Tails" (Toomre & Toomre 1972). The original paper explained how disc shaped galaxies could develop spiral arms. Two disc shape galaxies originally are far apart. They then fly by each other and almost collide. Once the galaxies are close enough, mutual gravitational forces cause spiral arms to form.

Open Script

Block Characteristics

Data Types	`Boolean^[a]`\|`bus^[a]`\|`double^[a]`\|`enumerated^[a]`\|`fixed point^[a]`\|`integer^[a]`\|`single^[a]`\|`string^[a]`
Direct Feedthrough	`no`
Multidimensional Signals	`limited^[a]`
Variable-Size Signals	`limited^[a]`
Zero-Crossing Detection	`no`
^[a]Actual data type or capability support depends on block implementation.

Extended Capabilities

C/C++ Code Generation
Generate C and C++ code using Simulink® Coder™.

Actual data type or capability support depends on block implementation.

HDL Code Generation
Generate Verilog and VHDL code for FPGA and ASIC designs using HDL Coder™.

HDL Coder™ provides additional configuration options that affect HDL implementation and synthesized logic. Actual data type or capability support depends on block implementation. For best practices of using the妈TLAB Functionblock, see:

高密度脂蛋白架构

妈TLAB Function(默认)

This is the default architecture for妈TLAB Functionblocks with fixed-point data types. When you use this architecture, you can use speed and area optimizations for blocks that surround the妈TLAB Functionblock. The code inside the妈TLAB Functionblock is not optimized.

妈TLAB Datapath

This is the default architecture for妈TLAB Functionblocks with floating-point data types. When you use this architecture, the code generator treats the妈TLAB Functionblock like a regularSubsystemblock. By enabling this architecture for fixed-point types, you can use speed and area optimizations for blocks inside the妈TLAB Functionblock and across the妈TLAB Function块与其他年代imulink blocks.

This capability enables you to specify additional properties for the妈TLAB Functionblock that you would specify for aSubsystemsuch asClockRatePipeliningandFlattenHierarchy.

HDL Block Properties

AdaptivePipelining	Automatic pipeline insertion based on the synthesis tool, target frequency, and multiplier word-lengths. The default is`inherit`. To specify this property, set体系结构to`妈TLAB Datapath`. See alsoAdaptivePipelining(HDL Coder).
BalanceDelays	Detects introduction of new delays along one path and inserts matching delays on the other paths. The default is`inherit`. To specify this property, set体系结构to`妈TLAB Datapath`. See alsoBalanceDelays(HDL Coder).
ClockRatePipelining	Insert pipeline registers at a faster clock rate instead of the slower data rate. The default is`inherit`. To specify this property, set体系结构to`妈TLAB Datapath`. See alsoClockRatePipelining(HDL Coder).
ConstMultiplierOptimization	Canonical signed digit (CSD) or factored CSD optimization. The default is`none`. See alsoConstMultiplierOptimization(HDL Coder).
ConstrainedOutputPipeline	Number of registers to place at the outputs by moving existing delays within your design. Distributed pipelining does not redistribute these registers. The default is`0`. For more details, seeConstrainedOutputPipeline(HDL Coder).
DistributedPipelining	Pipeline register distribution, or register retiming. The default is`off`. See alsoDistributedPipelining(HDL Coder).
DSPStyle	Synthesis attributes for multiplier mapping. The default is`none`. To specify this property, set体系结构to`妈TLAB Datapath`. See alsoDSPStyle(HDL Coder).
FlattenHierarchy	Remove subsystem hierarchy from generated HDL code. The default is`inherit`. To specify this property, set体系结构to`妈TLAB Datapath`. See alsoFlattenHierarchy(HDL Coder).
InputPipeline	Number of input pipeline stages to insert in the generated code. Distributed pipelining and constrained output pipelining can move these registers. The default is`0`. For more details, seeInputPipeline(HDL Coder).
InstantiateFunctions	Generate a VHDL^®`entity`or Verilog^®`module`for each function. The default is`off`. See alsoInstantiateFunctions(HDL Coder).
LoopOptimization	Unroll, stream, or do not optimize loops. The default is`none`. If you set体系结构to`妈TLAB Datapath`, you can only unroll loops. If you want to use loop streaming with the`妈TLAB Datapath`architecture, you can use the streaming optimization by specifying aStreamingFactor. See alsoLoopOptimization(HDL Coder).
MapPersistentVarsToRAM	Map persistent arrays to RAM. The default is`off`. See alsoMapPersistentVarsToRAM(HDL Coder).
OutputPipeline	Number of output pipeline stages to insert in the generated code. Distributed pipelining and constrained output pipelining can move these registers. The default is`0`. For more details, seeOutputPipeline(HDL Coder).
ResetType	Suppress reset logic generation. The default is`default`, which generates reset logic. See alsoResetType(HDL Coder).
SharingFactor	Number of functionally equivalent resources to map to a single shared resource. The default is 0. See alsoResource Sharing(HDL Coder).
StreamingFactor	Number of parallel data paths, or vectors, that are time multiplexed to transform into serial, scalar data paths. The default is 0, which implements fully parallel data paths. To specify this property, set体系结构to`妈TLAB Datapath`. See alsoStreaming(HDL Coder).
VariablesToPipeline	Warning `VariablesToPipeline`is not recommended. Use`coder.hdl.pipeline`(HDL Coder)instead. Insert a pipeline register at the output of the specified variable or variables. Specify the list of variables as a character vector, with spaces separating the variables. To specify this property, set体系结构to`妈TLAB Function`.

Complex Data Support

This block supports code generation for complex signals.

See alsoComplex Data Type Support(HDL Coder).

Tunable Parameter Support

HDL Coder supports both tunable and non-tunable parameters with the following data types:

Scalar
Vector
Complex
Structure
Enumeration

For details, seeGenerate DUT Ports for Tunable Parameters(HDL Coder)and .Design Guidelines for the MATLAB Function Block(HDL Coder)

Restrictions

If the block contains a System object™, block inputs cannot have non-discrete (constant orInf) sample time.
HDL Coder does not support a妈TLAB Functionthat contains the same variable as the input and output of the function. For example, this MATLAB code is not supported.
```
functiony = myFun(y)%#codegeny = 3 * y;
```

For the MATLAB language subset supported for HDL code generation from a妈TLAB Functionblock, seeSupported MATLAB Data Types, Operators, and Control Flow Statements(HDL Coder).

PLC Code Generation
Generate Structured Text code using Simulink® PLC Coder™.

Fixed-Point Conversion
Design and simulate fixed-point systems using Fixed-Point Designer™.

Actual data type or capability support depends on block implementation.

妈TLAB Function

Description

Ports

Input

`u`— Input argument`u`
scalar | vector | matrix

`n`— Input argument`n`
scalar | vector | matrix

Output

`y`— Output argument
scalar | vector | matrix

`n`— Output argument`n`
scalar | vector | matrix

模型的例子

Radar Tracking Using MATLAB Function Block

Spiral Galaxy Formation Simulation Using MATLAB Function Blocks

Block Characteristics

Extended Capabilities

C/C++ Code Generation
Generate C and C++ code using Simulink® Coder™.

HDL Code Generation
Generate Verilog and VHDL code for FPGA and ASIC designs using HDL Coder™.

PLC Code Generation
Generate Structured Text code using Simulink® PLC Coder™.

Fixed-Point Conversion
Design and simulate fixed-point systems using Fixed-Point Designer™.

See Also

Topics

Simulink Documentation

金宝app

Model-Based Design for Embedded Control Systems

妈TLAB Function

Description

Ports

Input

u— Input argumentuscalar | vector | matrix

n— Input argumentnscalar | vector | matrix

Output

y— Output argumentscalar | vector | matrix

n— Output argumentnscalar | vector | matrix

模型的例子

Radar Tracking Using MATLAB Function Block

Spiral Galaxy Formation Simulation Using MATLAB Function Blocks

Block Characteristics

Extended Capabilities

C/C++ Code GenerationGenerate C and C++ code using Simulink® Coder™.

HDL Code GenerationGenerate Verilog and VHDL code for FPGA and ASIC designs using HDL Coder™.

PLC Code GenerationGenerate Structured Text code using Simulink® PLC Coder™.

Fixed-Point ConversionDesign and simulate fixed-point systems using Fixed-Point Designer™.

See Also

Topics

Simulink Documentation

金宝app

Model-Based Design for Embedded Control Systems

`u`— Input argument`u`
scalar | vector | matrix

`n`— Input argument`n`
scalar | vector | matrix

`y`— Output argument
scalar | vector | matrix

`n`— Output argument`n`
scalar | vector | matrix

C/C++ Code Generation
Generate C and C++ code using Simulink® Coder™.

HDL Code Generation
Generate Verilog and VHDL code for FPGA and ASIC designs using HDL Coder™.

PLC Code Generation
Generate Structured Text code using Simulink® PLC Coder™.

Fixed-Point Conversion
Design and simulate fixed-point systems using Fixed-Point Designer™.