このページの内容は最新ではありません。最新版の英語を参照するには、ここをクリックします。

MATLAB Function

組み込み C コードを生成する MATLAB コードをモデルに含める

• 

×

ライブラリ:
Simulink / User-Defined Functions
HDL Coder / User-Defined Functions

説明

MATLAB Function ブロックを使用すると、使用する MATLAB^® 関数を Simulink^® モデルで作成できます。MATLAB 関数は、シミュレーションのために実行されて、Simulink Coder™ ターゲット用のコードを生成します。Simulink および MATLAB 製品をはじめて使用する場合は、Simulink での MATLAB Function ブロックを使用した MATLAB 関数の実装の概要を参照してください。

MATLAB Function ブロックをダブルクリックして MATLAB Function ブロック エディターを開き、MATLAB 関数を記述します。Simulink での MATLAB Function ブロックを使用した MATLAB 関数の実装のモデル例 call_stats_block2 では、MATLAB Function ブロック エディターで次の関数を使用します。

function [mean,stdev] = stats(vals)

% Calculates a statistical mean and a standard
% deviation for the values in vals.

len = length(vals);
mean = avg(vals,len);
stdev = sqrt(sum(((vals-avg(vals,len)).^2))/len);
plot(vals,"-+");

function mean = avg(array,size)
mean = sum(array)/size;

この関数は、入力および出力データを関数宣言ステートメントで引数および戻り値として指定します。前のサンプル関数の引数と戻り値は、call_stats_block2 モデルのブロックの入力および出力に相当します。

また、モデル エクスプローラーまたは [シンボル] ペインを使用して、変数の定義、入力トリガーの追加、および関数呼び出し出力の作成も実行できます。詳細については、MATLAB Function ブロックの変数の作成と定義、MATLAB Function ブロックの入力トリガーの管理およびMATLAB Function ブロックの関数呼び出しの出力の管理を参照してください。

MATLAB Function ブロックは、各変数のサイズ、クラスおよび実数/複素数を決定する解析に基づいて、効率の良い組み込み可能なコードを生成します。この分析によって次の制限が適用されます。

• 変数に対する最初の割り当てがサイズ、クラス、および実数/複素数を定義します。

  C/C++ コード生成のための変数定義のベスト プラクティスを参照してください。

• 可変サイズ データを使用する場合またはコード内の変数を別の目的で再使用する場合を除き、初期割り当ての後に変数プロパティを再割り当てすることはできません。

  変数プロパティの再代入を参照してください。

言語の制約に加えて、MATLAB Function ブロックは、MATLAB で使用可能な関数の一部をサポートしています。これらの関数には、次のような一般的カテゴリの関数が含まれます。

• plus、minus、power などの算術演算子。詳細については、配列と行列の演算を参照してください。

• size、length などの行列操作

• lu、inv、svd、chol などの高度な行列操作

• sin、cos、sinh、cosh などの三角関数

詳細については、C/C++ コードの生成でサポートされている関数およびオブジェクトを参照してください。

メモ

このブロックのコードは MATLAB とまったく同じ結果になるように試みますが、丸め誤差のために、結果が異なる場合があります。このような数値の差は、当初はわずかな関数 eps でも、演算を繰り返すことによって拡大することがあります。nan の動作に依存することはお勧めできません。同じ計算でも、異なる C コンパイラを使用すると、異なる結果になることがあります。

メモ

新しい MATLAB Function ブロックには %#codegen 命令は含まれませんが、含まれている場合と同様にエラーがチェックされます。MATLAB Function ブロックに %#codegen 命令を追加しても、エラー チェックには影響しません。詳細については、コンパイル命令 %#codegenを参照してください。

データの可視化をサポートするために、MATLAB Function ブロックは、シミュレーションについてのみ、MATLAB 関数の呼び出しをサポートします。この機能の制約と、このブロックにコード解析とこの機能を組み込む方法については、MATLAB Function ブロックでの MATLAB エンジンを使用した関数呼び出しの実行を参照してください。これらの関数呼び出しは、Simulink の入力または出力に直接影響しない場合、Simulink Coder 生成コードには表示されません。

MATLAB Function ブロックから、Simulink Function ブロックで定義された関数を呼び出すこともできます。関数 Stateflow^® は、[チャート プロパティ] ダイアログ ボックスで [チャート レベルの関数をエクスポート (グローバル)] および [エクスポートされた関数の Simulink による呼び出しを許可] をオンにして呼び出すことができます。

[シンボル] ペインで、ブロック入力を端子ではなく Simulink パラメーターとして宣言できます。MATLAB Function ブロックは、入力、出力、およびパラメーターについて、タイプとサイズの継承もサポートします。これらのプロパティを明示的に指定することもできます。MATLAB Function ブロックで使用する変数の詳細については、変数のデータ型の定義と変更、MATLAB Function ブロック変数のサイズの指定およびMATLAB Function ブロック パラメーター変数の設定を参照してください。

MATLAB Function では、再帰呼び出しはできません。

既定の設定では、MATLAB Function ブロックで直達が有効になっています。無効にするには、[直達を許可] プロパティをオフにします。非直達セマンティクスにより、出力が現在の状態に確実に依存するようになります。非直達を使用すると、フィードバック ループで MATLAB Function ブロックを使用し、代数ループを回避できます。詳細については、MATLAB Function ブロックでの非直達の使用を参照してください。

例

MATLAB Function ブロックを含むマスク ライブラリ サブシステムを使用したシミュレーションの実行とコードの生成

ライブラリ内のカスタム MATLAB Function ブロックを使用するモデルを使用したシミュレーションの実行とコードの生成。

モデルを開く

MATLAB Function ブロックでの MATLAB 関数ファイルの呼び出し

MATLAB Function ブロックを使用して MATLAB 関数ファイルに記述されたコードを呼び出して実行する。

モデルを開く

MATLAB Function ブロックを使用したレーダー追跡

この例では、Simulink® で拡張カルマン フィルターと MATLAB® Function ブロックを併用し、レーダーの測定値から航空機の位置を推定する方法を示します。フィルター実装は MATLAB Function ブロックにあり、その内容は Simulink モデル自体に保存されています。

モデルを開く

MATLAB Function ブロックを使用したらせん状の銀河形成シミュレーション

この例では、MATLAB Function ブロックを使用して銀河形成をシミュレートする方法について説明します。このモデルは、論文 "Galactic Bridges and Tails" (Toomre & Toomre 1972) の影響を受けて作られました。この論文では、円盤型の銀河に渦巻腕ができる過程が説明されていました。2 つの円盤型の銀河は本来遠く離れていました。しかし、衝突しそうなほど互いに接近しました。銀河が互いに接近すると、相互重力がはたらいて渦巻腕が形成されます。

モデルを開く

端子

入力

u — 入力端子

スカラー | ベクトル | 行列

入力端子。スカラー、ベクトル、または行列として指定します。作成する各入力変数には、対応する入力端子があります。

MATLAB でサポートされていても、Simulink でサポートされないデータ型については、Simulink モデルと MATLAB Function ブロック内の関数との間で受け渡しされない可能性があります。これらの型は MATLAB Function ブロック内で使用される場合があります。

このブロックの固定小数点サポートの詳細は、固定小数点データ型と MATLAB Function ブロック (Fixed-Point Designer)およびMATLAB Function ブロックを使用したデータ型オーバーライド (Fixed-Point Designer)を参照してください。

依存関係

入力端子を作成するには、ブロックを開き、[シンボル] ペインで入力変数を作成します。MATLAB Function ブロックの変数の作成と定義を参照してください。

データ型: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | Boolean | string | fixed point | enumerated | bus

出力

y — 出力端子

スカラー | ベクトル | 行列

出力端子。スカラー、ベクトル、または行列として指定します。作成する各出力変数には、対応する出力端子があります。

依存関係

出力端子を作成するには、ブロックを開き、[シンボル] ペインで出力変数を作成します。MATLAB Function ブロックの変数の作成と定義を参照してください。

データ型: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | Boolean | string | fixed point | enumerated | bus

パラメーター

メイン

端子ラベルを表示 — 端子ラベルのオプションを表示

[FromPortIcon] (既定値) | なし | [FromPortBlockName] | [SignalName]

MATLAB Function ブロック アイコンに端子ラベルを表示する方法を選択します。

• なし – 端子ラベルを表示しません。

• FromPortIcon – 入力変数と出力変数の名前を表示します。

• FromPortBlockName – 入力変数と出力変数の名前を表示します。

• SignalName – 端子に接続されている信号に名前が付いている場合、信号名を表示します。それ以外の場合は、変数の名前を表示します。

プログラムでの使用

パラメーター: ShowPortLabels

型: string スカラーまたは文字ベクトル

値: "none" | "FromPortIcon" | "FromPortBlockName" | "SignalName"

既定の設定: "FromPortIcon"

読み取り/書き込み権限 — ブロックの内容へのアクセスのレベル

[ReadWrite] (既定値) | [ReadOnly] | [NoReadOrWrite]

MATLAB Function ブロックの内容へのユーザー アクセスを制御します。

• ReadWrite – MATLAB Function ブロックの内容を開いて修正できます。

• ReadOnly – MATLAB Function ブロックを開くことができます。

• NoReadOrWrite – MATLAB Function ブロックを開くことも修正することもできません。

メモ

[読み取り/書き込みアクセス許可] パラメーターが [NoReadOrWrite] である MATLAB Function ブロックの内容を表示しようとしても、ブロックは応答しません。たとえば、MATLAB Function ブロックをダブルクリックしても、Simulink は table の内容を開いたり、メッセージを表示したりしません。

プログラムでの使用

パラメーター: Permissions

型: string スカラーまたは文字ベクトル

値: "ReadWrite" | "ReadOnly" | "NoReadOrWrite"

既定の設定: "ReadWrite"

代数ループの発生の最小化 — 疑似代数ループを削除するオプション

オフ (既定値) | オン

シミュレーション時にブロックが Atomic サブシステムを含む人為的な代数ループを削除しようとしているかどうか。

• オフ – Atomic サブシステムを含むすべての人為的な代数ループを削除しようとしません。

• オン – Atomic サブシステムを含むすべての人為的な代数ループを削除しようとします。

プログラムでの使用

パラメーター: MinAlgLoopOccurrences

型: string スカラーまたは文字ベクトル

値: "off" | "on"

既定の設定: "off"

サンプル時間 (継承は -1) — 時間間隔の指定

-1 (既定値) | [Ts 0]

このブロックの変数を同じレートで実行すべきか、異なるレートで実行できるかどうかを指定します。

• MATLAB Function ブロック内の変数を異なるレートで実行できる場合、サンプル時間を継承 (-1) に指定します。

• 変数を同じレートで実行しなければならない場合、このレートに相当するサンプル時間 Ts を指定します。

プログラムでの使用

パラメーター: SystemSampleTime

型: string スカラーまたは文字ベクトル

値: "-1" | "[Ts 0]"

既定の設定: "-1"

コード生成

関数のパッケージ化 — コードの形式を選択

自動 (既定値) | インライン | 再利用できない関数 | 再利用可能な関数

ブロックで生成するコードの形式を選択します。

自動

Simulink Coder は、モデル内に存在する MATLAB Function ブロックのインスタンスのタイプと数に基づいてシステムに最適な形式を選択します。

インライン

Simulink Coder は、無条件に MATLAB Function ブロックをインライン化します。

再利用できない関数

Simulink Coder は、個々の関数を個々のファイルに明示的に生成します。このように設定された MATLAB Function ブロックは、コード生成の [関数インターフェイス] パラメーターの設定に応じて引数をもつことがある関数を生成します。生成された関数とファイルは、コード生成からそれぞれ [関数名] パラメーターと [ファイル名 (拡張子なし)] パラメーターを使用して名前を付けることができます。これらの関数は再呼び出し可能ではありません。

再利用可能な関数

Simulink Coder は、モデルに MATLAB Function ブロックの複数のインスタンスが含まれる場合、MATLAB Function ブロックのコードの再利用を可能にする引数をもつ関数を生成します。

このオプションは、参照モデル全体にわたり MATLAB Function ブロックの複数のインスタンスを含むモデル参照階層の生成コードで、MATLAB Function ブロック コードの再利用を可能とする引数をもつ関数を生成します。この場合、MATLAB Function ブロックはライブラリに含まれていなければなりません。

ヒント

• MATLAB Function ブロックの複数のインスタンスを 1 つの再利用可能な関数として表す場合、それぞれのインスタンスを [自動] または [再利用可能な関数] として指定できます。それらのどちらか一方を使用するのが最適です。両方を使用すると、各指定につき 1 つずつ、2 つの再利用可能な関数が作成されます。これらの選択の結果は、再利用が不可能な場合にのみ異なります。[自動] を選択しても、MATLAB Function ブロック コードの関数やファイル名は制御できません。

• [再利用可能な関数] と [自動] のオプションは両方とも、MATLAB Function ブロックのインスタンスが複数存在するかどうかとコードが再利用可能かどうかを判定します。コードの再利用が不可能な場合、オプションの動作はそれぞれ異なります。この場合、[自動] はインライン化されたコードを生成し、インライン化が禁止されている場合はブロックのインスタンスごとに別の関数を生成します。

• 生成コードがソース管理下にある場合に [再利用可能な関数] を選択する場合は、[ファイル名オプション] を サブシステム名を使用、[関数名を使用]、ユーザー指定 のいずれかに設定してください。この設定を行わないと、モデルの変更時にコード ファイルの名前が変更され、ファイルのソース管理ができません。

依存関係

• このパラメーターには Simulink Coder が必要です。

• このパラメーターを [再利用できない関数] または [再利用可能な関数] に設定すると、次のパラメーターが有効になります。

  • 関数名オプション

  • ファイル名オプション

  • 初期化/終了関数のメモリ セクション (Embedded Coder^® と ERT ベースのシステム ターゲット ファイルが必要)

  • 実行関数のメモリ セクション (Embedded Coder と ERT ベースのシステム ターゲット ファイルが必要)

• このパラメーターを [再利用できない関数] に設定すると、[別々のデータをもつ関数] が有効になります (Embedded Coder のライセンスと ERT ベースのシステム ターゲット ファイルが必要)。

プログラムでの使用

パラメーター: RTWSystemCode

型: string スカラーまたは文字ベクトル

値: "Auto" | "Inline" | "Nonreusable function" | "Reusable function"

既定の設定: "Auto"

ブロックの特性

データ型	Booleana | busa | doublea | enumerateda | fixed pointa | halfa | integera | singlea | stringa
直達	はいa
多次元信号	はいa
可変サイズの信号	はいa
ゼロクロッシング検出	いいえ
a 実際のデータ型または機能のサポートは、ブロックの実装に依存します。

拡張機能

C/C++ コード生成

Simulink® Coder™ を使用して C および C++ コードを生成します。

実際のデータ型、または機能のサポートは、ブロックの実装に依存します。

HDL コード生成

HDL Coder™ を使用して FPGA 設計および ASIC 設計のための VHDL、Verilog および SystemVerilog のコードを生成します。

HDL Coder™ には、HDL の実装および合成されたロジックに影響する追加のコンフィギュレーション オプションがあります。実際のデータ型、または機能のサポートは、ブロックの実装に依存します。MATLAB Function ブロックの使用のベスト プラクティスについては、次を参照してください。

• MATLAB Function ブロックの設計ガイドライン (HDL Coder)

• 関数のインスタンス化可能なコードの生成 (HDL Coder)

• MATLAB ループの最適化 (HDL Coder)

• MATLAB 式のパイプライン (HDL Coder)

HDL アーキテクチャ

MATLAB Function (既定)	これは固定小数点データ型をもつ MATLAB Function ブロックの既定のアーキテクチャです。このアーキテクチャを使用する場合、MATLAB Function ブロックを囲むブロックについて、速度と面積の最適化を使用できます。MATLAB Function ブロック内のコードは最適化されません。
MATLAB Datapath	これは浮動小数点データ型をもつ MATLAB Function の既定のアーキテクチャです。このアーキテクチャを使用する場合、コード ジェネレーターは MATLAB Function ブロックを通常の Subsystem ブロックのように取り扱います。固定小数点型についてこのアーキテクチャを有効にすることで、MATLAB Function ブロック内のブロックに対して、および、他の Simulink ブロックを使用する MATLAB Function ブロックにわたって、速度と面積の最適化を使用できます。 この機能により、[ClockRatePipelining] や [FlattenHierarchy] のような Subsystem に対して指定する追加のプロパティを MATLAB Function ブロックに対して指定できます。

HDL ブロック プロパティ

AdaptivePipelining	合成ツール、ターゲット周波数、乗算器の語長に基づくパイプラインの自動挿入。既定の設定は [inherit] です。このプロパティを指定するには、[アーキテクチャ] を MATLAB Datapath に設定します。AdaptivePipelining (HDL Coder)も参照してください。
BalanceDelays	あるパスに新しい遅延が導入されたことを検出し、それに一致する遅延を他のパスに挿入します。既定の設定は [inherit] です。このプロパティを指定するには、[アーキテクチャ] を MATLAB Datapath に設定します。BalanceDelays (HDL Coder)も参照してください。
ClockRatePipelining	パイプライン レジスタを低速のデータ レートではなく高速のクロック レートで挿入します。既定の設定は [inherit] です。このプロパティを指定するには、[アーキテクチャ] を MATLAB Datapath に設定します。ClockRatePipelining (HDL Coder)も参照してください。
ConstMultiplierOptimization	正準符号付き桁数 (CSD) または因数分解された CSD による最適化。既定の設定は [なし] です。ConstMultiplierOptimization (HDL Coder)も参照してください。
ConstrainedOutputPipeline	既存の遅延を設計内で移動することによって出力に配置するレジスタの数。分散型パイプラインではこれらのレジスタは再分散されません。既定の設定は 0 です。詳細については、ConstrainedOutputPipeline (HDL Coder)を参照してください。
DistributedPipelining	パイプライン レジスタの分散、またはレジスタのリタイミング。既定の設定は [inherit] です。DistributedPipelining (HDL Coder)も参照してください。
DSPStyle	乗算器のマッピングの合成属性。既定の設定は [なし] です。このプロパティを指定するには、[アーキテクチャ] を MATLAB Datapath に設定します。DSPStyle (HDL Coder)も参照してください。
FlattenHierarchy	生成された HDL コードから MATLAB Function ブロック階層を削除します。既定の設定は [inherit] です。このプロパティを指定するには、[アーキテクチャ] を MATLAB Datapath に設定します。FlattenHierarchy (HDL Coder)も参照してください。
InputPipeline	生成されたコードに挿入する入力パイプライン ステージ数。分散型パイプラインと制約付き出力パイプラインでは、これらのレジスタを移動できます。既定の設定は 0 です。詳細については、InputPipeline (HDL Coder)を参照してください。
InstantiateFunctions	各関数について VHDL® entity または Verilog® module を生成します。既定の設定は [オフ] です。InstantiateFunctions (HDL Coder)も参照してください。
LoopOptimization	ループを展開、またはストリームするか、最適化しません。既定の設定は [なし] です。[アーキテクチャ] を MATLAB Datapath に設定した場合、ループを展開することのみが可能です。MATLAB Datapath アーキテクチャを使用してループをストリームする場合は、[StreamingFactor] を指定することでストリーミングの最適化を使用できます。LoopOptimization (HDL Coder)も参照してください。
MapPersistentVarsToRAM	永続配列を RAM にマッピングします。既定の設定は [オフ] です。MapPersistentVarsToRAM (HDL Coder)も参照してください。
OutputPipeline	生成されたコードに挿入する出力パイプライン ステージ数。分散型パイプラインと制約付き出力パイプラインでは、これらのレジスタを移動できます。既定の設定は 0 です。詳細については、OutputPipeline (HDL Coder)を参照してください。
ResetType	リセット ロジックの生成を抑制。既定値は [既定の設定] で、リセット ロジックを生成します。ResetType (HDL Coder)も参照してください。
SharingFactor	単一の共有リソースにマッピングされる、機能的に等価なリソースの数。既定の設定は 0 です。リソース共有 (HDL Coder)も参照してください。
StreamingFactor	時間多重化されてシリアルのスカラー データ パスに変換される、パラレル データ パスの数、またはベクトルの数。既定値は 0 であり、パラレル データ パスがそのまま実装されます。このプロパティを指定するには、[アーキテクチャ] を MATLAB Datapath に設定します。ストリーミング (HDL Coder)も参照してください。
VariablesToPipeline	警告 VariablesToPipeline は推奨されません。代わりに coder.hdl.pipeline (HDL Coder) を使用してください。 1 つ以上の指定された変数の出力でパイプライン レジスタを挿入します。変数のリストを、変数をスペースで区切った文字ベクトルとして指定します。このプロパティを指定するには、[アーキテクチャ] を MATLAB Function に設定します。

サポートするデータ型

HDL コード生成では、MATLAB Function ブロックの次の関数に対して半精度データ型がサポートされます。

all	and, &	any	cast	conj	ctranspose
end	=	eq	==	ge, >=	gt, >
half	inf	int8	int16	int32	int64
isa	iscolumn	isempty	isequal	isfinite	isfloat
isinf	isinteger	islogical	isnan	isnumeric	isreal
isrow	isscalar	isvector	le, <=	length	logical
lt, <	max	min	minus, -	NaN	ndims
ne, ~=	not	numel	or, |	plus, +	prod
reshape	single	size	sqrt	sum	times, .*
transpose	uint8	uint16	uint32	uint64	uminus
uplus	vertconcat	-	-	-	-

複素数データのサポート

このブロックは、複素信号のコード生成をサポートしています。

複素数データ型のサポート (HDL Coder)も参照してください。

調整可能なパラメーターのサポート

HDL Coder では、次のデータ型をもつ調整可能なパラメーターと調整不可のパラメーターの両方がサポートされます。

• スカラー

• ベクトル

• 複素数

• 構造体

• 列挙型

詳細については、調整可能なパラメーターの DUT 端子を生成する (HDL Coder)とMATLAB Function ブロックの設計ガイドライン (HDL Coder)を参照してください。

制限

• ブロックに System object™ が含まれている場合、ブロック入力は非離散 (定数または Inf) サンプル時間をもつことはできません。

• HDL Coder は、関数の入力と出力として同じ変数を含む MATLAB Function をサポートしていません。たとえば、次の MATLAB コードはサポートされません。

  function y = myFun(y)
  %#codegen
  
  y = 3 * y;

• ブロックは、ネイティブ浮動小数点モードでのみ浮動小数点データ型をサポートします。

MATLAB Function ブロックからの HDL コード生成でサポートされる MATLAB 言語のサブセットについては、サポートされている MATLAB データ型、演算子、制御フロー ステートメント (HDL Coder)を参照してください。

PLC コード生成
Simulink® PLC Coder™ を使用して構造化テキスト コードを生成します。

固定小数点の変換

Fixed-Point Designer™ を使用して固定小数点システムの設計とシミュレーションを行います。

実際のデータ型、または機能のサポートは、ブロックの実装に依存します。

バージョン履歴

R2011a で導入

R2020a: MATLAB Function ブロックに対する 64 ビット整数型のサポート

MATLAB Function ブロックで 64 ビット整数データがサポートされるようになりました。int64 と uint64 のデータ型が、語長 64 ビット、小数部の長さ 0 の固定小数点数として実装されます。

R2019b: MATLAB Function ブロックに対する string のサポート

MATLAB Function ブロックで Simulink の string がサポートされるようになりました。

参考

Subsystem, Atomic Subsystem, Nonvirtual Subsystem, CodeReuse Subsystem

トピック

• MATLAB Function ブロックの変数の作成と定義
• Simulink での MATLAB Function ブロックを使用した MATLAB 関数の実装
• MATLAB Function ブロック プロパティの指定
• MATLAB Function ブロックでの非直達の使用
• プログラムによる MATLAB Function ブロックの設定