コマンドラインでの C コードの生成

このチュートリアルでは、MATLAB^® Coder™ codegen コマンドを使用して、MATLAB 関数の静的な C ライブラリを生成します。最初に、固定の既定サイズの入力のみを受け入れる C コードを生成します。その後、複数の異なるサイズの入力を受け入れる C コードを生成します。

コードは MATLAB Coder アプリを使用して生成することもできます。このワークフローのチュートリアルについては、MATLAB Coder アプリを使用した C コードの生成を参照してください。

チュートリアルファイル: ユークリッド距離

ライブスクリプトを開く

この例を開いて、このチュートリアルのファイルを取得します。

チュートリアルファイルの説明

このチュートリアルで使用するファイルは、euclidean_data.mat、euclidean.m、test.m、build_lib_fixed.m、および build_lib_variable.m です。

MATLAB データファイル euclidean_data.mat には、3 次元ユークリッド空間の単一の点と 3 次元ユークリッド空間の他の複数の点の 2 つのデータが格納されています。具体的には次のとおりです。
- x は、3 次元ユークリッド空間の点を表す 3 行 1 列の列ベクトルです。
- cb は、3 行 216 列の配列です。cb の各列が 3 次元ユークリッド空間の点を表します。

MATLAB ファイル euclidean.m には、この例の "コアアルゴリズム" を実装する関数 euclidean が含まれています。この関数は x と cb を入力として受け取ります。x と cb の各点の間のユークリッド距離を計算して次の量を返します。

列ベクトル y_min。x に最も近い点を表す cb の列と等しくなります。
列ベクトル y_max。x から最も遠い点を表す cb の列と等しくなります。
2 次元のベクトル idx。ベクトル y_min と y_max の cb における列インデックスが格納されます。
2 次元のベクトル distance。x との間の計算された最短距離と最長距離が格納されます。

function [y_min,y_max,idx,distance] = euclidean(x,cb)
% Initialize minimum distance as distance to first element of cb
% Initialize maximum distance as distance to first element of cb
idx(1)=1;
idx(2)=1;

distance(1)=norm(x-cb(:,1));
distance(2)=norm(x-cb(:,1));

% Find the vector in cb with minimum distance to x
% Find the vector in cb with maximum distance to x
for index=2:size(cb,2)
    d=norm(x-cb(:,index));
    if d < distance(1)
        distance(1)=d;
        idx(1)=index;
    end
    if d > distance(2)
        distance(2)=d;
        idx(2)=index;
    end
end

% Output the minimum and maximum distance vectors
y_min=cb(:,idx(1));
y_max=cb(:,idx(2));

end

MATLAB スクリプト test.m は、データファイル euclidean_data.mat をワークスペースに読み込みます。その後、関数 euclidean を呼び出して y_min、y_max、idx、および distance を計算します。このスクリプトで計算された量がコマンドラインに表示されます。

euclidean_data.mat の読み込みは、コアアルゴリズムを呼び出す前に実行される事前処理のステップです。結果の表示は事後処理のステップとなります。

% Load test data 
load euclidean_data.mat

% Determine closest and farthest points and corresponding distances
[y_min,y_max,idx,distance] = euclidean(x,cb);

% Display output for the closest point
disp('Coordinates of the closest point are: ');
disp(num2str(y_min'));
disp(['Index of the closest point is ', num2str(idx(1))]);
disp(['Distance to the closest point is ', num2str(distance(1))]);

disp(newline);

% Display output for the farthest point
disp('Coordinates of the farthest point are: ');
disp(num2str(y_max'));
disp(['Index of the farthest point is ', num2str(idx(2))]);
disp(['Distance to the farthest point is ', num2str(distance(2))]);

ビルドスクリプト build_lib_fixed.m と build_lib_variable.m には、MATLAB コードから静的な C ライブラリを生成するためのコマンドが固定サイズの入力を受け入れるものと可変サイズの入力を受け入れるものに分けて格納されています。これらのスクリプトの内容については、このチュートリアルの後半で C コードを生成するときに説明します。

ヒント

MATLAB 関数からのコードの生成には、MATLAB Coder を使用します。MATLAB スクリプトからのコード生成はサポートされていません。

テストスクリプトを使用して、コアアルゴリズムを実装する関数から事前処理と事後処理のステップを分割します。こうすることで、アルゴリズムを簡単に再利用できます。ここでは、コアアルゴリズムを実装する MATLAB 関数のコードを生成します。テストスクリプトのコードは生成しません。

MATLAB 関数の C コードの生成

元の MATLAB コードの実行

MATLAB でテストスクリプト test.m を実行します。y、idx、および distance が出力に表示されます。

Coordinates of the closest point are: 
0.8         0.8         0.4
Index of the closest point is 171
Distance to the closest point is 0.080374


Coordinates of the farthest point are: 
0  0  1
Index of the farthest point is 6
Distance to the farthest point is 1.2923

MATLAB コードをコード生成に適したものにする

MATLAB コードをコード生成に適したものにするには、コードアナライザーとコード生成の準備状態ツールを使用します。MATLAB エディターのコードアナライザーは、コードの入力時にそれを常にチェックします。コードアナライザーは、コードの問題を報告し、パフォーマンスと保守性を最大化するための修正方法を提案します。コード生成の準備状態ツールでは、MATLAB コード内にコード生成でサポートされない機能や関数がないかどうかを調べることができます。

C/C++ コード生成でサポートされる MATLAB の一部の組み込み関数とツールボックス関数、クラス、および System object には、特定のコード生成の制限があります。それらの制限と関連する使用上の注意事項については、該当するリファレンスページの拡張機能のセクションに記載されています。詳細については、C/C++ コードの生成でサポートされている関数およびオブジェクトを参照してください。

MATLAB エディターで、euclidean.m を開きます。MATLAB エディターの右上隅にあるコードアナライザーメッセージインジケーターは緑色になります。アナライザーは、コード内にエラー、警告または改善すべき点を検出しませんでした。
関数宣言の後に、%#codegen 命令を追加します。
```
function [y,idx,distance] = euclidean(x,cb) %#codegen
```
%#codegen 命令により、コード生成に固有の警告やエラーがコードアナライザーで特定されます。
コードアナライザーメッセージインジケーターが赤色になり、コード生成の問題が検出されたことが示されます。
警告メッセージを表示するには、下線が引かれているコード部分にカーソルを移動します。この警告は、コードを生成するには、変数 idx と distance を完全に定義してから添字を付けなければならないことを示しています。これらの警告が発生するのは、コードジェネレーターがそれらの変数のサイズをコードにおける最初の出現箇所で決定しなければならないためです。この問題を修正するには、関数 ones を使用して、それらの配列の割り当てと初期化を同時に行います。
```
% Initialize minimum distance as distance to first element of cb
% Initialize maximum distance as distance to first element of cb
idx = ones(1,2);

distance = ones(1,2)*norm(x-cb(:,1));
```
コードアナライザーメッセージインジケーターが再び緑色になり、コード生成に関する問題がほかに検出されていないことが示されます。
コードアナライザーの使用の詳細については、コードアナライザーを使用したエラーと警告についてのコードのチェックを参照してください。
ファイルを保存します。
コード生成の準備状態ツールを実行するには、MATLAB コマンドラインから関数 coder.screener を呼び出します。
```
coder.screener('euclidean')
```
euclidean については、ツールでコード生成に関する問題は検出されません。詳細については、コード生成の準備状態ツールを参照してください。
メモ
コードアナライザーとコード生成の準備状態ツールで、コード生成に関するすべての問題を検出できるわけではありません。これらのツールで検出されたエラーや警告を解決したら、MATLAB Coder を使用してコードを生成し、MATLAB コードに準拠違反の問題がほかにないかどうかを調べてください。

これで、MATLAB Coder アプリを使用してコードをコンパイルする準備ができました。"コンパイル" とは、ここでは MATLAB コードから C/C++ コードを生成することを指しています。

メモ

MATLAB コードのコンパイルとは、MATLAB コードから C/C++ コードを生成することを指します。他のコンテキストでは、コンパイルという用語が C/C++ コンパイラのアクションを指す場合もあります。

入力の型の定義

C では静的なデータ型が使用されるため、コードジェネレーターは MATLAB ファイル内のすべての変数のクラス、サイズ、実数/複素数をコード生成時 ("コンパイル時") に判別しなければなりません。したがって、ファイルのコードを生成するときに、エントリポイント関数に対するすべての入力引数のプロパティを指定しなければなりません。"エントリポイント関数" は、コードを生成する最上位の MATLAB 関数です。

codegen コマンドを使用してコードを生成する場合は、-args オプションを使用してエントリポイント関数に対するサンプル入力パラメーターを指定します。コードジェネレーターは、この情報を使用して入力引数のプロパティを決定します。

次のステップでは、codegen コマンドを使用して、エントリポイント関数 euclidean から MEX ファイルを生成します。

実行時の問題の確認

エントリポイント関数から MEX 関数を生成します。MEX 関数は MATLAB 内から呼び出すことができる生成コードです。MEX 関数を実行し、生成された MEX 関数と元の MATLAB 関数が同じように機能するかどうかを確認します。

生成された C コードでの診断が難しいランタイムエラーを検出して修正することができるため、このステップを実行することをお勧めします。既定では、MEX 関数にはメモリ整合性チェックが含まれます。このチェックにより、配列の範囲と次元のチェックが実行されます。このチェックを実行することにより、MATLAB 関数に対して生成されたコード内のメモリ整合性の違反が検出されます。詳細は、実行時チェックの制御を参照してください。

MATLAB コードを効率良く動作する C/C++ ソースコードに変換するためにコードジェネレーターによって行われる最適化により、特定の状況において、元のソースコードと生成後のコードで異なる動作になることがあります。生成されたコードと MATLAB コードの相違点を参照してください。

codegen コマンドを使用して euclidean.m の MEX ファイルを生成します。MEX 関数を検証するには、MATLAB 関数 euclidean の呼び出しを生成された MEX 関数の呼び出しに置き換えてテストスクリプト test を実行します。
```
% Load the test data
load euclidean_data.mat
% Generate code for euclidean.m with codegen. Use the test data as example input.
codegen euclidean.m -args {x,cb} -test test
```
- 既定で、codegen は、現在のフォルダーに euclidean_mex という名前の MEX 関数を生成します。
- -args オプションを使用して、エントリポイント関数 euclidean に対するサンプル入力パラメーターを指定します。コードジェネレーターは、この情報を使用して入力引数のプロパティを決定します。
- -test オプションを使用して、テストファイル test.m を実行します。このオプションにより、テストファイルの euclidean の呼び出しが euclidean_mex の呼び出しに置き換えられます。
出力は、次のようになります。
```
Running test file: 'test' with MEX function 'euclidean_mex'.
Coordinates of the closest point are: 
0.8         0.8         0.4
Index of the closest point is 171
Distance to the closest point is 0.080374


Coordinates of the farthest point are: 
0  0  1
Index of the farthest point is 6
Distance to the farthest point is 1.2923
```
この出力が元の MATLAB 関数で生成された出力と一致することから、MEX 関数を確認できます。これで、euclidean のスタンドアロンの C コードを生成する準備ができました。

メモ

MATLAB コードからスタンドアロン C/C++ コードを生成する前に、MEX 関数を生成します。生成された MEX 関数を実行して、実行時の動作が MATLAB 関数と同じであることを確認します。生成された MEX 関数の応答が MATLAB とは異なる場合、またはエラーが発生する場合は、スタンドアロンコード生成に進む前にこれらの問題を解決しなければなりません。そうしないと、生成するスタンドアロンコードの信頼性が低くなり、未定義の動作が発生する可能性があります。

C コードの生成

ビルドスクリプト build_lib_fixed.m に euclidean.m のコードの生成に使用するコマンドが含まれています。

% Load the test data
load euclidean_data.mat
% Generate code for euclidean.m with codegen. Use the test data as example input.
codegen -report -config:lib euclidean.m -args {x, cb}

次の点に注意してください。

codegen は、ファイル euclidean.m を読み取り、MATLAB コードを C コードに変換します。
-report オプションは codegen に対して、コード生成の問題をデバッグしたり MATLAB コードがコード生成に適していることを確認したりするために使用できるコード生成レポートを生成するよう指示します。
-config:lib オプションは codegen に対して、既定の MEX 関数を生成するのではなく静的な C ライブラリを生成するよう指示します。
-args オプションは codegen に対して、サンプル入力パラメーター x と cb のクラス、サイズ、実数/複素数を使用して euclidean.m のコードを生成するよう指示します。

codegen コマンドで適切なオプションを使用することで、C スタティックライブラリを生成する代わりに、MEX 関数や他の C/C++ ビルドタイプを生成するように選択することもできます。各種のコード生成オプションの詳細については、codegen を参照してください。

ビルドスクリプトを実行します。
MATLAB はビルドファイルを処理し、メッセージを出力します。
```
Code generation successful: View report.
```
コードジェネレーターにより、スタンドアロンの C スタティックライブラリ euclidean が work\codegen\lib\euclidean に生成されます。ここで、work はチュートリアルファイルが含まれているフォルダーです。
レポートビューアーでコード生成レポートを表示するには、[レポートの表示] をクリックします。
コード生成中にコードジェネレーターでエラーや警告が検出された場合は、レポートに問題の説明と問題がある MATLAB コードへのリンクが表示されます。コード生成レポートを参照してください。

ヒント

コマンドラインでのコードの生成にはビルドスクリプトを使用します。ビルドスクリプトでは、コマンドラインで繰り返し実行する一連の MATLAB コマンドを自動化できるため、時間の節約となり、入力エラーをなくすことができます。

生成された C コードと元の MATLAB コードとの比較

生成された C コードと元の MATLAB コードを比較するには、C ファイル euclidean.c と euclidean.m ファイルを MATLAB エディターで開きます。

生成された C コードに関する重要な情報を次に示します。

関数シグネチャは次のようになります。
```
void euclidean(const double x[3], const double cb[648], double y_min[3], double
               y_max[3], double idx[2], double distance[2])
```
const double x[3] は MATLAB コード内の入力 x に対応します。x のサイズは 3 で、これは MATLAB コードのコードを生成したときに使用したサンプル入力の合計サイズ (3 行 1 列) に対応します。
const double cb[648] は MATLAB コード内の入力 cb に対応します。cb のサイズは 648 で、これは MATLAB コードをコンパイルしたときに使用したサンプル入力の合計サイズ (3 行 216 列) に対応します。この例の生成されたコードでは、1 次元配列を使用して MATLAB コードの 2 次元配列を表します。
生成されたコードには、4 つの追加の入力引数があります。配列 y_min、y_max、idx、および distance です。これらの配列は出力値を返すために使用されます。これらは、元の MATLAB コードの出力引数 y_min、y_max、idx、および distance に対応します。
コードジェネレーターでは関数名とコメントが保持されます。変数名については、可能であればコードジェネレーターで保持されます。
メモ
MATLAB コード内の変数が定数値に設定された場合、生成された C コード内では変数としては表れません。生成された C コード内では、変数の実際の値が含まれています。

Embedded Coder^® では、MATLAB コードと生成された C/C++ コードを対話形式でトレースできます。Interactively Trace Between MATLAB Code and Generated C/C++ Code (Embedded Coder)を参照してください。

可変サイズ入力の C コードの生成

生成した euclidean.m の C 関数は、コード生成時に指定したサンプル入力と同じサイズの入力のみを受け入れます。ただし、対応する MATLAB 関数への入力配列は任意のサイズにすることができます。チュートリアルのこのパートでは、可変サイズの入力を受け入れる C コードを euclidean.m から生成します。

ここでは、生成される C コードの x と cb の次元について、プロパティを次のように設定するとします。

x と cb の両方の最初の次元を最大サイズ 3 の可変にします。
x の 2 番目の次元を値 1 の固定にします。
cb の 2 番目の次元を最大サイズ 216 の可変にします。

これらの入力プロパティを指定するには、関数 coder.typeof を使用します。coder.typeof(A,B,1) は、クラスと実数/複素数が A と同じで、上限がサイズベクトル B の対応する要素で与えられる可変サイズの入力を指定します。coder.typeof を使用するビルドスクリプト build_lib_variable.m を使用して、生成される C ライブラリの可変サイズ入力のプロパティを指定します。

% Load the test data
load euclidean_data.mat

% Use coder.typeof to specify variable-size inputs
eg_x=coder.typeof(x,[3 1],1);
eg_cb=coder.typeof(cb,[3 216],1);

% Generate code for euclidean.m using coder.typeof to specify
% upper bounds for the example inputs
codegen -report -config:lib euclidean.m -args {eg_x,eg_cb}

次に、前と同じ手順でコードを生成できます。euclidean.c の生成された C コードの関数シグネチャは次のようになります。

void euclidean(const double x_data[], const int x_size[1], const double cb_data[],
               const int cb_size[2], double y_min_data[], int y_min_size[1],
               double y_max_data[], int y_max_size[1], double idx[2], double
               distance[2])

引数 x_data、cb_data、y_min_data、および y_max_data は、元の MATLAB 関数の入力引数 x と cb および出力引数 y_min と y_max に対応します。これで、x_data、cb_data、y_min_data、および y_max_data のサイズを実行時に指定する 4 つの追加の入力引数 x_size、cb_size、y_min_size、および y_max_size を C 関数が受け入れるようになります。

次のステップ

目的	詳細
コード生成でサポートされる MATLAB の組み込み関数とツールボックス関数、クラス、および System object について学習する	C/C++ コードの生成でサポートされている関数およびオブジェクト
C++ コードを生成する	C++ コード生成
入力の型を対話形式で作成および編集する	コード生成の型エディターを使用した入力の型の作成と編集
C main 関数の例を生成および変更して C 実行可能プログラムのビルドに使用する	アプリケーションにおける C の main の例の使用
生成されたファイルを圧縮ファイルにパッケージ化する	他の開発環境向けのコードのパッケージ化
生成されたコードの実行速度またはメモリ使用量を最適化する	最適化手法
カスタムの C/C++ コードを生成コードに統合する	生成コードからのカスタム C/C++ コードの呼び出し
コード生成レポートについて学習する	コード生成レポート Interactively Trace Between MATLAB Code and Generated C/C++ Code (Embedded Coder)