Main Content

このページの翻訳は最新ではありません。ここをクリックして、英語の最新版を参照してください。

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

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

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

MATLAB での関数の作成

MATLAB で、パッケージ化する MATLAB コードを調べます。この例では、matlabroot\extern\examples\compilersdk\c_cpp\matrix にある addmatrix.m を開きます。

 addmatrix.m

MATLAB コマンド プロンプトに以下を入力します。

addmatrix([1 4 7; 2 5 8; 3 6 9], [1 4 7; 2 5 8; 3 6 9])

出力は以下のようになります。

 ans =
     2     8    14
     4    10    16
     6    12    18

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

  1. [MATLAB アプリ] タブで、[アプリ] セクションの右端にある矢印をクリックします。[アプリケーションのデプロイ] で、[ライブラリ コンパイラ] をクリックします。

    または、MATLAB コマンド プロンプトで以下を入力して、[ライブラリ コンパイラ] アプリを開きます。

    libraryCompiler

  2. ツールストリップの [タイプ] セクションで、[C++ 共有ライブラリ] をクリックします。

    ライブラリ コンパイラ アプリのプロジェクト ウィンドウで、デプロイする MATLAB アプリケーションのファイルを指定します。

    1. ツールストリップの [エクスポートする関数] セクションで、Add exported function to the project をクリックします。

    2. [ファイルの追加] ウィンドウで、サンプルのフォルダーを参照し、パッケージ化する関数を選択します。[開く] をクリックします。

    エクスポートする関数ファイルのリストに関数が追加されます。同じアプリケーションに複数のファイルをパッケージ化するには、この手順を繰り返します。

    この例では、matlabroot\extern\examples\compilersdk\c_cpp\matrix に移動して addmatrix.m を選択します。

  3. ツールストリップの [パッケージ化オプション] セクションで次のオプションのいずれかを選択して、生成されるアプリケーションに MATLAB Runtime インストーラーを含めるかどうかを決定します。

    • ランタイムを Web からダウンロードMATLAB Runtime をダウンロードしてデプロイされた MATLAB アプリケーションと共にインストールするインストーラーを生成します。インストーラーのファイル名を指定できます。

    • ランタイムをパッケージに含めるMATLAB Runtime インストーラーを含むアプリケーションを生成します。インストーラーのファイル名を指定できます。

      メモ

      このオプションを初めて選択したときに、MATLAB Runtime インストーラーをダウンロードするように求めるメッセージが表示されます。

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

  1. [ライブラリ名] フィールドに、パッケージ化された共有ライブラリの名前として addmatrix が自動的に入力されます。この名前を libmatrix に変更します。同じ名前が、共有ライブラリの実装時にも使用されます。

  2. サンプル C++ ドライバー ファイルを生成するための MATLAB ファイルを追加します。C++ ドライバー ファイルは共有ライブラリの作成に必須ではありませんが、C++ mwArray API 共有ライブラリをドライバー アプリケーションとともに実装の方法を示すために使用します。

    [サンプル] セクションで、[新規サンプルの作成] を選択して addmatrix.m をクリックします。MATLAB ファイルが編集用に開きます。アプリケーションの必要に応じて入力変数を定義し、ファイルを保存して [ライブラリ コンパイラ] アプリに戻ります。詳細と制限については、サンプル ドライバー ファイルの作成を参照してください。

  3. 以下の値を使用して、開いた MATLAB ファイルを編集します。

    % Sample script to demonstrate execution of function a = addmatrix(a1, a2)
    a1 = [1 4 7; 2 5 8; 3 6 9]; % Initialize a1 here
    a2 = a1; % Initialize a2 here
    a = addmatrix(a1, a2);

    ファイルを保存して、ライブラリ コンパイラ アプリに戻ります。詳細と制限については、サンプル ドライバー ファイルの作成を参照してください。

  4. 生成される C++ 共有ライブラリの API の種類を選択します。下部の [API の選択] セクションで、[mwArray API を使用するインターフェイスの作成] を選択します。詳細については、C++ 共有ライブラリの API の選択を参照してください。

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

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

  • ライブラリ情報 — デプロイされるアプリケーションに関する情報。また、アプリケーション アイコンとスプラッシュ スクリーンを変更して、アプリケーションの外観をカスタマイズすることもできます。生成されるインストーラーはこの情報を使用して、インストールされるアプリケーションのメタデータを入力します。インストーラーのカスタマイズを参照してください。

  • 追加インストーラー オプション — 生成されるインストーラーの既定のインストール パスと、カスタム ロゴの選択。インストール パスの変更を参照してください。

  • ライブラリの実行に必要なファイル — 生成されるアプリケーションを実行するために必要な追加ファイル。これらのファイルは、生成されるアプリケーション インストーラーに含められます。コンパイラ プロジェクトの必須ファイルの管理を参照してください。

  • エンド ユーザー用にインストールされるファイル — アプリケーションと共にインストールされるファイル。

    アプリケーションと共にインストールするファイルの指定を参照してください。

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

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

  1. [パッケージ化] をクリックします。

    [プロジェクトを保存] ダイアログ ボックスで、プロジェクトを保存する場所を指定します。

  2. [パッケージ] ダイアログ ボックスで、[プロセスが完了したら出力フォルダーを開く] が選択されていることを確認します。

    パッケージ化プロセスが完了したら、ターゲット フォルダー内の生成された出力を調べます。

    • 3 つのフォルダー for_redistributionfor_redistribution_files_only、および for_testing が生成されます。

      これらのフォルダーに生成されるファイルの詳細については、MATLAB 関数のパッケージ化後に生成されるファイルを参照してください。

    • ログ ファイル PackagingLog.html にはパッケージ化の結果が含まれています。

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

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

  1. matlabroot\extern\examples\compilersdk\c_cpp\matrix にある addmatrix.m ファイルへのパスを保存します。

    appFile = fullfile(matlabroot,'extern','examples','compilersdk','c_cpp','matrix','addmatrix.m');
  2. 以下のコードを addmatrixSample1.m という名前のサンプル ファイルに保存します。

    a1 = [1 4 7; 2 5 8; 3 6 9];
    a2 = a1;
    a = addmatrix(a1, a2);

  3. 関数 compiler.build.cppSharedLibrary を使用して C++ 共有ライブラリをビルドします。名前と値の引数を使用してサンプル ファイルを追加し、ライブラリ名とインターフェイス API を指定します。

    buildResults = compiler.build.cppSharedLibrary(appFile, ...
    'LibraryName','libmatrix', ...
    'Interface','mwarray', ...
    'SampleGenerationFiles','addmatrixSample1.m');

    compiler.build コマンドで名前と値の引数を使用して、追加オプションを指定できます。詳細については、compiler.build.cppSharedLibrary を参照してください。

    compiler.build.Results オブジェクト buildResults には、ビルド タイプ、生成ファイル、含まれるサポート パッケージ、およびビルド オプションに関する情報が含まれています。

    関数により、現在の作業ディレクトリの libmatrixcppSharedLibrary という名前のフォルダーに以下のファイルが生成されます。

    • samples\addmatrixSample1_mwarray.cpp — 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.txtMATLAB Runtime がアプリケーションを実行するために必要な製品の製品 ID が含まれるテキスト ファイル。

    • unresolvedSymbols.txt — 未解決のシンボルに関する情報が含まれるテキスト ファイル。

    メモ

    生成されたライブラリに MATLAB Runtime やインストーラーは含まれていません。buildResults オブジェクトを使用してインストーラーを作成するには、compiler.package.installer を参照してください。

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

C++ 共有ライブラリのパッケージ化が完了したら、C++ アプリケーションから呼び出すことができます。作成する C++ アプリケーションでは、パッケージ化の際に生成されたサンプル C++ ドライバー コードを使用します。この C++ ドライバー コードは C++ 共有ライブラリを呼び出し、以前のセットアップ手順で選択したサンプル MATLAB ファイルを基にしています。

これらの手順は、for_redistribution_files_only フォルダーの GettingStarted.html ファイルでも説明しています。開始する前に、MATLAB Runtime のインストールと構成が完了していて、C++ コンパイラがインストールされていることを確認してください。

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

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

    /*================================================================= * * ADDMATRIXSAMPLE1 * 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() { 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; try { addmatrix(1, aOut, a1In, a2In); std::cout << aOut << std::endl; } 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); }
  2. システム コマンド プロンプトで、addmatrixSample1_mwarray.cpp のコピー先のフォルダーに移動します。

  3. MATLAB プロンプトまたはシステムのコマンド プロンプトで mbuild を使用して、アプリケーションをコンパイルしてリンクします。

    mbuild addmatrixSample1_mwarray.cpp libmatrix.lib

    メモ

    Windows では .lib 拡張子が使用されます。macOS でのファイル拡張子は .dylib、Linux でのファイル拡張子は .so です。

  4. システムのコマンド プロンプトからアプリケーションを実行します。パッケージ化手順でサンプル MATLAB コードを使用した場合、このアプリケーションはその MATLAB コードと同じ出力を返します。

    addmatrixSample1_mwarray.exe
    2 8 14
    4 10 16
    6 12 18
    

参考

| | |

関連するトピック