C++ mwArray API 共有ライブラリの生成と C++ アプリケーションのビルド

サポートされるプラットフォーム: Windows^®、Linux^®、Mac

この例では、MATLAB^® 関数から C++ 共有ライブラリを作成する方法を説明します。生成されたライブラリは、C++ アプリケーションに統合できます。また、この例では、C++ アプリケーションから C++ 共有ライブラリを呼び出す方法も示します。MATLAB のライセンスコピーがターゲットシステムにインストールされている必要はありません。

MATLAB での関数の作成

MATLAB で、パッケージ化する MATLAB コードを調べます。
この例では、MATLAB に付属している matrix フォルダーを作業フォルダーにコピーします。
```
copyfile(fullfile(matlabroot,'extern','examples','compilersdk','c_cpp','matrix'),'matrix')
```
作業フォルダー内の新しい matrix サブフォルダーに移動します。
関数 addmatrix.m、multiplymatrix.m、および eigmatrix.m を確認してテストします。
関数を呼び出す MATLAB サンプルコードを作成します。サンプルファイルを使用して、ターゲット言語のサンプルアプリケーションを生成します。詳細と制限については、サンプルドライバーファイルの作成を参照してください。
以下のコードを libmatrixSample.m という名前のサンプルファイルに保存します。
```
% Sample script to demonstrate execution of functions
% addmatrix, eigmatrix, and multiplymatrix
a1 = [1 4 7; 2 5 8; 3 6 9]; % Initialize a1 here
a2 = a1; % Initialize a2 here
a = addmatrix(a1, a2);
e = eigmatrix(a1);
m = multiplymatrix(a1, a2);
```
パッケージ化手順で、サンプルドライバーファイルをまったく含めないことも選択できます。独自の C++ アプリケーションコードを作成する場合、MATLAB 関数のパッケージ化が完了してから mbuild を使用して適切なディレクトリに移動し、コンパイルできます。

ライブラリコンパイラアプリを使用した C++ 共有ライブラリの作成

[MATLAB アプリ] タブで、[アプリ] セクションの右端にある矢印をクリックします。[アプリケーションのデプロイ] で、[ライブラリコンパイラ] をクリックします。
または、MATLAB コマンドプロンプトで以下を入力して、[ライブラリコンパイラ] アプリを開きます。
```
libraryCompiler
```
ツールストリップの [タイプ] セクションで、[C++ 共有ライブラリ] をクリックします。
ライブラリコンパイラアプリのプロジェクトウィンドウで、デプロイする MATLAB アプリケーションのファイルを指定します。
1. ツールストリップの [エクスポートする関数] セクションで、をクリックします。
2. [ファイルの追加] ウィンドウで、サンプルのフォルダーを参照し、パッケージ化する関数を選択します。[開く] をクリックします。
エクスポートする関数ファイルのリストに関数が追加されます。同じアプリケーションに複数のファイルをパッケージ化するには、この手順を繰り返します。
addmatrix.m、multiplymatrix.m、および eigmatrix.m をメインファイルのリストに追加します。
ツールストリップの [パッケージ化オプション] セクションで次のオプションのいずれかを選択して、生成されるアプリケーションに MATLAB Runtime インストーラーを含めるかどうかを決定します。
- ランタイムを Web からダウンロード — MATLAB Runtime をダウンロードしてデプロイされた MATLAB アプリケーションと共にインストールするインストーラーを生成します。インストーラーのファイル名を指定できます。
- ランタイムをパッケージに含める — MATLAB Runtime インストーラーを含むアプリケーションを生成します。インストーラーのファイル名を指定できます。
  メモ
  このオプションを初めて選択したときに、MATLAB Runtime インストーラーをダウンロードするように求めるメッセージが表示されます。

共有ライブラリ設定の指定

[ライブラリ名] フィールドに、パッケージ化された共有ライブラリの名前として addmatrix が自動的に入力されます。この名前を libmatrix に変更します。同じ名前が、共有ライブラリの実装時にも使用されます。
以前に作成した MATLAB サンプルファイル libmatrixSample.m を追加します。C++ ドライバーファイルは共有ライブラリの作成に必須ではありませんが、C++ mwArray API 共有ライブラリを C++ サンプルアプリケーションとともに実装の方法を示すために使用します。
[サンプル] セクションで、[既存のサンプルの追加] を選択して libmatrixSample.m を選択します。
生成される C++ 共有ライブラリの API の種類を選択します。下部の [API の選択] セクションで、[mwArray API を使用するインターフェイスの作成] を選択します。既定のオプションのままにして両方のインターフェイスを作成することもできます。詳細については、C++ 共有ライブラリの API の選択を参照してください。

アプリケーションとその外観のカスタマイズ

ライブラリコンパイラアプリでは、インストーラーをカスタマイズし、アプリケーションをカスタマイズし、アプリケーションについて情報を追加することができます。

ライブラリ情報 — デプロイされるアプリケーションに関する情報。また、アプリケーションアイコンとスプラッシュスクリーンを変更して、アプリケーションの外観をカスタマイズすることもできます。生成されるインストーラーはこの情報を使用して、インストールされるアプリケーションのメタデータを入力します。インストーラーのカスタマイズを参照してください。
追加インストーラーオプション — 生成されるインストーラーの既定のインストールパスと、カスタムロゴの選択。インストールパスの変更を参照してください。
ライブラリの実行に必要なファイル — 生成されるアプリケーションを実行するために必要な追加ファイル。これらのファイルは、生成されるアプリケーションインストーラーに含められます。コンパイラプロジェクトの必須ファイルの管理を参照してください。
エンドユーザー用にインストールされるファイル — アプリケーションと共にインストールされるファイル。
アプリケーションと共にインストールするファイルの指定を参照してください。

アプリケーションのパッケージ化

パッケージ化オプションの選択が終了したら、ライブラリコンパイラのプロジェクトを保存し、パッケージ化されたアプリケーションを生成します。

[パッケージ化] をクリックします。
[プロジェクトを保存] ダイアログボックスで、プロジェクトを保存する場所を指定します。
[パッケージ] ダイアログボックスで、[プロセスが完了したら出力フォルダーを開く] が選択されていることを確認します。
パッケージ化プロセスが完了したら、ターゲットフォルダー内の生成された出力を調べます。
- 3 つのフォルダー for_redistribution、for_redistribution_files_only、および for_testing が生成されます。
  これらのフォルダーに生成されるファイルの詳細については、MATLAB 関数のパッケージ化後に生成されるファイルを参照してください。
- ログファイル PackagingLog.html にはパッケージ化の結果が含まれています。

`compiler.build.cppSharedLibrary` を使用した C++ 共有ライブラリの作成

ライブラリコンパイラアプリの代わりに、プログラムによる方法を使用して C++ 共有ライブラリを作成できます。ライブラリコンパイラを使用してライブラリを既に作成している場合は、C++ mwArray API 共有ライブラリを C++ サンプルアプリケーションとともに実装を参照してください。

関数ファイルのリストを cell 配列に保存します。

functionfiles = {'addmatrix.m', 'multiplymatrix.m', 'eigmatrix.m'}

関数 compiler.build.cppSharedLibrary を使用して C++ 共有ライブラリをビルドします。名前と値の引数を使用してサンプルファイルを追加し、ライブラリ名とインターフェイス API を指定します。
```
buildResults = compiler.build.cppSharedLibrary(functionfiles,...
'LibraryName','libmatrix',...
'Interface','mwarray',...
'SampleGenerationFiles','libmatrixSample.m');
```
compiler.build コマンドで名前と値の引数を使用して、追加オプションを指定できます。詳細については、compiler.build.cppSharedLibrary を参照してください。
compiler.build.Results オブジェクト buildResults には、ビルドタイプ、生成ファイル、含まれるサポートパッケージ、およびビルドオプションに関する情報が含まれています。
この関数により、現在の作業ディレクトリにある libmatrixcppSharedLibrary という名前のフォルダー内に以下のファイルが生成されます。
- samples\libmatrixSample1_mwarray.cpp — 関数 addmatrix を呼び出す C++ サンプルアプリケーション。
- samples\libmatrixSample2_mwarray.cpp — 関数 eigmatrix を呼び出す C++ サンプルアプリケーション。
- samples\libmatrixSample3_mwarray.cpp — 関数 multiplymatrix を呼び出す C++ サンプルアプリケーション。
- GettingStarted.html — 共有ライブラリの統合に関する情報が含まれる HTML ファイル。
- includedSupportPackages.txt — ライブラリに含まれるすべてのサポートファイルをリストしたテキストファイル。
- libmatrix.cpp — C++ ソースコードファイル。
- libmatrix.def — リンカーにモジュール情報を提供するモジュール定義ファイル。
- libmatrix.dll — ダイナミックリンクライブラリファイル。
- libmatrix.exports — すべての非静的関数名が含まれるエクスポートファイル。
- libmatrix.h — C++ ヘッダーファイル。
- libmatrix.lib — インポートライブラリファイル。
- mccExcludedFiles.log — アプリケーションに含まれていないすべてのツールボックス関数のリストが含まれるログファイル。サポートされていない関数の詳細については、MATLAB Compiler の制限を参照してください。
- readme.txt — パッケージ化情報が含まれるテキストファイル。
- requiredMCRProducts.txt — MATLAB Runtime がアプリケーションを実行するために必要な製品の製品 ID が含まれるテキストファイル。
- unresolvedSymbols.txt — 未解決のシンボルに関する情報が含まれるテキストファイル。
メモ
生成されたライブラリに MATLAB Runtime やインストーラーは含まれていません。buildResults オブジェクトを使用してインストーラーを作成するには、compiler.package.installer を参照してください。

C++ mwArray API 共有ライブラリを C++ サンプルアプリケーションとともに実装

メモ

3 つすべての関数を呼び出してエラーを処理する、より高度なアプリケーションを使用してライブラリを呼び出すには、次のフォルダーに配置されている C++ アプリケーション matrix_mwarray.cpp を使用します。

matlabroot\extern\examples\compilersdk\c_cpp\matrix

詳細については、Integrate C++ Shared Libraries with mwArrayを参照してください。

開始する前に、MATLAB Runtime のインストールと構成が完了していて、C++ コンパイラがインストールされていることを確認してください。

C++ 共有ライブラリをパッケージ化した後、C++ アプリケーションから呼び出すことができます。samples フォルダーで生成された C++ アプリケーションは、作成したサンプル MATLAB ファイルを基にしています。

生成された C++ コードファイル libmatrixSample1_mwarray.cpp を samples フォルダーからコピーして、libmatrix.lib を含むフォルダーに貼り付けます。

libmatrixSample1_mwarray.cpp のプログラムコードを以下に示します。

/*================================================================= * * LIBMATRIXSAMPLE1 * CPP Sample driver code for libmatrix that calls a shared library * created using MATLAB Compiler SDK. * Refer to the MATLAB Compiler SDK documentation for more information. * *=================================================================*/ // Include the library specific header file as generated by the // MATLAB Compiler #include <iostream> #include "libmatrix.h" void addmatrixSample() { try { mxDouble a1InData[] = {1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0}; mwArray a1In(3, 3, mxDOUBLE_CLASS); a1In.SetData(a1InData, 9); mxDouble a2InData[] = {1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0}; mwArray a2In(3, 3, mxDOUBLE_CLASS); a2In.SetData(a2InData, 9); mwArray aOut; addmatrix(1, aOut, a1In, a2In); std::cout << aOut << '\n'; } catch (const mwException& e) { std::cerr << e.what() << std::endl; } catch (...) { std::cerr << "Unexpected error thrown" << std::endl; } } int run_main(int argc, const char** argv) { if (!libmatrixInitialize()) { std::cerr << "Could not initialize the library properly" << std::endl; return 2; } else { addmatrixSample(); // Call the application and library termination routine libmatrixTerminate(); } // Note that you should call mclTerminateApplication at the end of // your application to shut down all MATLAB Runtime instances. mclTerminateApplication(); return 0; } // The main routine. On macOS, the main thread runs the system code, and // user code must be processed by a secondary thread. On other platforms, // the main thread runs both the system code and the user code. int main(int argc, const char** argv) { /* Call the mclInitializeApplication routine. Make sure that the application * was initialized properly by checking the return status. This initialization * has to be done before calling any MATLAB APIs or MATLAB Compiler SDK * generated shared library functions. */ if (!mclInitializeApplication(nullptr, 0)) { std::cerr << "Could not initialize the application." << std::endl; return 1; } return mclRunMain(static_cast<mclMainFcnType>(run_main), argc, argv); }

システムコマンドプロンプトで、libmatrixSample1_mwarray.cpp のコピー先のフォルダーに移動します。
MATLAB プロンプトまたはシステムのコマンドプロンプトで mbuild を使用して、アプリケーションをコンパイルしてリンクします。
```
mbuild libmatrixSample1_mwarray.cpp libmatrix.lib
```
メモ
Windows では .lib 拡張子が使用されます。macOS でのファイル拡張子は .dylib、Linux でのファイル拡張子は .so です。
システムのコマンドプロンプトからアプリケーションを実行します。パッケージ化手順でサンプル MATLAB コードを使用した場合、サンプル C++ アプリケーションはその MATLAB コードと同じ出力を返します。
```
libmatrixSample1_mwarray.exe
```
```
2 8 14
4 10 16
6 12 18
```
(オプション) mbuild を使用して、その他のサンプル C++ アプリケーションをコンパイルしてリンクします。生成された C++ コードは、独自のアプリケーションを作成するためのガイドとしても使用できます。
詳細については、Integrate C++ Shared Libraries with mwArrayを参照してください。

参考

compiler.build.cppSharedLibrary | ライブラリコンパイラ | mcc | deploytool