compiler.build.cppSharedLibrary
構文
説明
compiler.build.cppSharedLibrary( は、FunctionFiles)FunctionFiles で指定された MATLAB® ファイルを使用して C++ 共有ライブラリを作成します。この関数を使用する前に、サポートされている C++ コンパイラをインストールしてください。
compiler.build.cppSharedLibrary( は、名前と値の引数を 1 つ以上使用してオプションが指定された C++ 共有ライブラリを作成します。オプションには、インターフェイス API、ライブラリ名、出力ディレクトリなどがあります。FunctionFiles,Name,Value)
compiler.build.cppSharedLibrary( は、opts)compiler.build.CppSharedLibraryOptions オブジェクト opts を使用してオプションが指定された C++ 共有ライブラリを作成します。名前と値の引数を使用して他のオプションを指定することはできません。
例
2 つの行列を追加する関数ファイルを使用して C++ 共有ライブラリを作成します。
MATLAB で、C++ ライブラリとしてデプロイする MATLAB 関数を見つけます。この例では、matlabroot\extern\examples\compilersdk\c_cpp\matrixaddmatrix.m を使用します。
appFile = fullfile(matlabroot,'extern','examples','compilersdk','c_cpp','matrix','addmatrix.m');
compiler.build.cppSharedLibrary コマンドを使用して、C++ ライブラリをビルドします。
compiler.build.cppSharedLibrary(appFile);
ビルド関数により、現在の作業ディレクトリの addmatrixcppSharedLibrary という名前のフォルダー内に以下のファイルが生成されます。
GettingStarted.html— 共有ライブラリの統合に関する情報が含まれる HTML ファイル。includedSupportPackages.txt— ライブラリに含まれるすべてのサポート ファイルをリストしたテキスト ファイル。mccExcludedFiles.log— アプリケーションに含まれていないすべてのツールボックス関数のリストが含まれるログ ファイル。サポートされていない関数の詳細については、MATLAB Compiler の制限を参照してください。readme.txt— デプロイの前提条件に関する情報と、デプロイ用にパッケージ化するファイルのリストが含まれる Readme ファイル。requiredMCRProducts.txt— MATLAB Runtime がアプリケーションを実行するために必要な製品の製品 ID が含まれるテキスト ファイル。unresolvedSymbols.txt— 未解決のシンボルに関する情報が含まれるテキスト ファイル。v2\generic_interface\readme.txt— デプロイの前提条件に関する情報と、デプロイ用にパッケージ化するファイルのリストが含まれる Readme ファイル。v2\generic_interface\magicsquare.ctf— デプロイ可能なアーカイブが含まれるコンポーネント テクノロジー ファイル。
共有ライブラリを実装するには、C++ MATLAB データ API 共有ライブラリをサンプル アプリケーションとともに実装を参照してください。
C++ ライブラリを作成し、名前と値の引数を使用してカスタマイズします。
この例では、matlabroot\extern\examples\compilersdk\c_cpp\matrixaddmatrix.m を使用します。
appFile = fullfile(matlabroot,'extern','examples','compilersdk','c_cpp','matrix','addmatrix.m');
以下のコードを addmatrixSample1.m という名前のサンプル ファイルに保存します。
a1 = [1 4 7; 2 5 8; 3 6 9]; a2 = a1; a = addmatrix(a1, a2);
compiler.build.cppSharedLibrary コマンドを使用して、C++ ライブラリをビルドします。名前と値の引数を使用してライブラリ名を指定し、サンプル ファイルを追加して、mwArray インターフェイスを使用します。
compiler.build.cppSharedLibrary(appFile,'LibraryName','mwa_addmatrix', ... 'SampleGenerationFiles','addmatrixSample1.m', ... 'Interface','mwarray');
ビルド関数により、現在の作業ディレクトリの mwa_addmatrixcppSharedLibrary という名前のフォルダー内に以下のファイルが作成されます。
samples\addmatrixSample1_mwarray.cpp— C++ サンプル アプリケーション。GettingStarted.html— 共有ライブラリの統合に関する情報が含まれるファイル。includedSupportPackages.txt— ライブラリに含まれるすべてのサポート ファイルをリストしたテキスト ファイル。mwa_addmatrix.cpp— C++ ソース コード ファイル。mwa_addmatrix.def— リンカーにモジュール情報を提供するモジュール定義ファイル。mwa_addmatrix.dll— ダイナミックリンク ライブラリ ファイル。mwa_addmatrix.exports— すべての非静的関数名が含まれるエクスポート ファイル。mwa_addmatrix.h— C++ ヘッダー ファイル。mwa_addmatrix.lib— インポート ライブラリ ファイル。mccExcludedFiles.log— アプリケーションに含まれていないすべてのツールボックス関数のリストが含まれるログ ファイル。サポートされていない関数の詳細については、MATLAB Compiler の制限を参照してください。readme.txt— デプロイの前提条件に関する情報と、デプロイ用にパッケージ化するファイルのリストが含まれる Readme ファイル。requiredMCRProducts.txt— MATLAB Runtime がアプリケーションを実行するために必要な製品の製品 ID が含まれるテキスト ファイル。unresolvedSymbols.txt— 未解決のシンボルに関する情報が含まれるテキスト ファイル。
共有ライブラリを実装するには、C++ mwArray API 共有ライブラリを C++ サンプル アプリケーションとともに実装を参照してください。
compiler.build.CppSharedLibraryOptions オブジェクトを使用して、複数の C++ ライブラリを作成します。
この例では、matlabroot\extern\examples\compilersdk\c_cpp\matrixaddmatrix.m を使用します。
appFile = fullfile(matlabroot,'extern','examples','compilersdk','c_cpp','matrix','addmatrix.m');
appFile を使用して CppSharedLibraryOptions オブジェクトを作成します。名前と値の引数を使用して共通の出力ディレクトリを指定し、デバッグ シンボルを有効にして、詳細な出力を有効にします。
opts = compiler.build.CppSharedLibraryOptions(appFile, ... 'OutputDir','D:\Documents\MATLAB\work\CppLibraryBatch', ... 'DebugBuild','on','Verbose','on')
opts =
CppSharedLibraryOptions with properties:
Interface: 'matlab-data'
LibraryVersion: '1.0.0.0'
SampleGenerationFiles: {}
FunctionFiles: {'C:\Program Files\MATLAB\R2025b\extern\examples\compilersdk\c_cpp\addmatrix.m'}
DebugBuild: on
LibraryName: 'magicsquare'
AdditionalFiles: {}
AutoDetectDataFiles: on
ExternalEncryptionKey: [0×0 struct]
ObfuscateArchive: off
SecretsManifest: ''
SupportPackages: {'autodetect'}
Verbose: on
OutputDir: 'D:\Documents\MATLAB\work\CppLibraryBatch'CppSharedLibraryOptions オブジェクトを使用して C++ 共有ライブラリをビルドします。
compiler.build.cppSharedLibrary(opts);
同じオプションをもつ関数ファイル subtractmatrix.m を使用して新しいライブラリを作成するには、ビルド関数を再度実行する前に、ドット表記を使用して既存の CppSharedLibrary オブジェクトの FunctionFiles 引数を変更します。
opts.FunctionFiles = fullfile(matlabroot,'extern','examples','compilersdk','c_cpp','matrix','subtractmatrix.m'); compiler.build.cppSharedLibrary(opts);
FunctionFiles 引数を変更して再コンパイルすることにより、同じオプション オブジェクトを使用して複数のライブラリをコンパイルできます。
C++ ライブラリを作成し、ビルド タイプ、コンパイル済みファイル、サポート パッケージ、およびビルド オプションに関する情報を compiler.build.Results オブジェクトに保存します。
ファイル magicsquare.m を使用してコンパイルします。
results = compiler.build.cppSharedLibrary('magicsquare.m')results =
Results with properties:
BuildType: 'cppSharedLibrary'
Files: {2×1 cell}
IncludedSupportPackages: {}
Options: [1×1 compiler.build.CppSharedLibraryOptions]
RuntimeDependencies: [1×1 compiler.runtime.Dependencies]Files プロパティには、v2 フォルダーおよび GettingStarted.html へのパスが格納されます。
入力引数
MATLAB 関数を実装するファイル。文字ベクトル、string スカラー、string 配列、または文字ベクトルの cell 配列として指定します。ファイル パスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。ファイルの拡張子は .m、.p、.mlx、.mexa64 のいずれかである必要があります。
例: ["myfunc1.m","myfunc2.m"]
データ型: char | string | cell
C++ ライブラリのビルド オプション。compiler.build.CppSharedLibraryOptions オブジェクトとして指定します。
名前と値の引数
オプションの引数のペアを Name1=Value1,...,NameN=ValueN として指定します。ここで、Name は引数名で、Value は対応する値です。名前と値の引数は他の引数の後に指定しなければなりませんが、ペアの順序は重要ではありません。
R2021a より前では、コンマを使用して名前と値をそれぞれ区切り、Name を引用符で囲みます。
例: 'Verbose','on'
C++ 共有ライブラリに含める追加ファイルとフォルダー。文字ベクトル、string スカラー、string 配列、または文字ベクトルの cell 配列として指定します。パスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。
例: 'AdditionalFiles',["myvars.mat","data.txt"]
データ型: char | string | cell
データ ファイルを自動的に含めるためのフラグ。'on' または 'off'、もしくは数値または logical の 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off' の値は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は、matlab.lang.OnOffSwitchState 型の on/off の logical 値として保存されます。
このプロパティを
'on'に設定した場合、特定の関数 (loadやfopenなど) の入力として指定したデータ ファイルは自動的に共有ライブラリに含められます。このプロパティを
'off'に設定した場合、データ ファイルはAdditionalFilesプロパティを使用して共有ライブラリに追加する必要があります。
例: 'AutoDetectDataFiles','off'
データ型: logical
デバッグ シンボルを有効にするためのフラグ。'on' または 'off'、もしくは数値または logical の 1 (true) か 0 (false) として指定します。'on' の値は true と等価であり、'off' の値は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は、matlab.lang.OnOffSwitchState 型の on/off の logical 値として保存されます。
このプロパティを
'on'に設定した場合、コンパイルされたアーティファクトにデバッグ シンボル情報が含まれます。このオプションによって、mbuildからシステム コンパイラに適切なデバッグ フラグも渡されます。このデバッグ オプションを使用すると、MATLAB Runtime の初期化、関数呼び出し、または終了ルーチンのいずれでエラーが発生したかを特定できる箇所まで戻ることができます。このオプションでは、外部デバッガーで MATLAB ファイルをデバッグすることはできません。このプロパティを
'off'に設定した場合、デバッグ シンボルは含まれません。これは既定のオプションです。
例: 'DebugBuild','on'
データ型: logical
R2024b 以降
外部の AES 暗号化キー ファイルおよび MEX キー ローダー ファイルへのパス。char 行ベクトルまたは string スカラーの正確に 2 つのフィールドをもつスカラー struct として指定します。フィールド名はそれぞれ EncryptionKeyFile と RuntimeKeyLoaderFile です。ファイル パスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。
C++ 共有ライブラリについては、コンパイル時にキーと MEX ローダーの両方を指定する代わりに、暗号化キーのみを指定し、RuntimeKeyLoaderFile を空の文字列として設定できます。その後、MATLAB データ API を使用する場合は関数 initMATLABLibrary、MWArray API を使用する場合は関数 <library>InitializeWithKey の引数として、実行時に C++ アプリケーションで 16 進数でエンコードされた 64 バイトの復号化キーを提供します。
たとえば、struct keyValueStruct を使用して暗号化キーを encrypt.key、ローダー ファイルを loader.mexw64 と指定します。
keyValueStruct.EncryptionKeyFile='encrypt.key'; keyValueStruct.RuntimeKeyLoaderFile='loader.mexw64'
暗号化キー ファイルは、サポートされている次のいずれかの形式でなければなりません。
バイナリ 256 ビットの AES キー、32 バイトのファイル サイズ
16 進数でエンコードされた AES キー、64 バイトのファイル サイズ
MEX ファイル ローダーは実行時に復号化キーを取得します。これは次の引数をもつインターフェイスでなければなりません。
prhs[0]— 入力、固定値'get'として指定される char 配列prhs[1]— 入力、CTF コンポーネント UUID として指定される char 配列plhs[0]— 出力、キーの形式に応じて 32 バイトの UINT8 数値配列または 64 バイトの 16 進数でエンコードされた char 配列
複数の CTF で同じキーを共有することは避けてください。
例: 'ExternalEncryptionKey',keyValueStruct
データ型: struct
インターフェイス API。次のいずれかのオプションとして指定します。
'matlab-data'— MATLAB データ API を使用して共有ライブラリを生成します。'mwarray'—mwArrayAPI を使用して共有ライブラリを生成します。
詳細については、Summary of MATLAB Compiler SDK C++ APIsを参照してください。
例: 'Interface','mwarray'
C++ 共有ライブラリの名前。文字ベクトルまたは string スカラーとして指定します。生成されたライブラリの既定の名前は、FunctionFiles 引数の最初のエントリです。
例: 'LibraryName','mymagic'
データ型: char | string
デプロイ可能なアーカイブを難読化するためのフラグ。'on'/1/true または 'off'/0/false として指定します。値は、matlab.lang.onoffSwitchState 型の on/off の logical 値として保存されます。
このプロパティを 'on' に設定した場合、デプロイ可能なアーカイブのフォルダー構造およびファイル名はエンド ユーザーに対して難読化され、.m、.mlapp、.p、.mat、MLX、SFX、および MEX ファイルに含まれているユーザー コードおよびデータはアーカイブ内のユーザー パッケージに配置されます。また、すべての .m ファイルがパッケージ化の前に P ファイルに変換されます。
実行時に、MATLAB コードとデータはファイル システムに抽出されるのではなく、ユーザー パッケージから直接復号化されて読み込まれます。MEX ファイルは、一時的にユーザー パッケージから抽出されてから、読み込まれます。
追加のファイル タイプをユーザー パッケージに手動で含めるには、それぞれのファイル タイプを個別の拡張子タグでファイル matlabroot/toolbox/compiler/advanced_package_supported_files.xml
以下はサポートされて "いません"。
ver関数DLL などの外部ライブラリの呼び出し
アウトプロセスの MATLAB Runtime (MATLAB データ配列の C++ 共有ライブラリ)
アウトプロセスでの MEX ファイルの実行 (
mexhost、feval、matlab.mex.MexHost)R2023b より前: v7.3 以外の
.matファイル
このオプションを有効にすることは、-j および -s を指定して mcc を使用するのと等価です。
このプロパティを 'off' に設定した場合、デプロイ可能なアーカイブは難読化されません。これは既定の動作です。
例: 'ObfuscateArchive','on'
データ型: logical
ビルド ファイルが保存される出力ディレクトリへのパス。文字ベクトルまたは string スカラーとして指定します。このパスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。
ビルド フォルダーの既定の名前は、ライブラリ名に cppSharedLibrary を追加したものです。
例: 'OutputDir','D:\Documents\MATLAB\work\mymagiccppSharedLibrary'
データ型: char | string
ライブラリ内に含まれる関数のサンプル C++ ライブラリ ファイルを生成するために使用する MATLAB サンプル ファイル。文字ベクトル、string スカラー、string 配列、または文字ベクトルの cell 配列として指定します。パスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。ファイルには .m 拡張子が必要です。詳細と制限については、Create Sample Code to Call Exported Functionを参照してください。
例: 'SampleGenerationFiles',["sample1.m","sample2.m"]
データ型: char | string | cell
R2024b 以降
デプロイ可能なアーカイブに組み込む秘密鍵を指定する secret マニフェスト JSON ファイルへのパス。文字ベクトルまたは string スカラーとして指定します。このパスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。
MATLAB コードで関数 getSecret、getSecretMetadata、または isSecret を呼び出す場合、デプロイ可能なアーカイブに組み込む秘密鍵を JSON secret マニフェスト ファイルで指定しなければなりません。コードで getSecret を呼び出す場合に SecretsManifest オプションが指定されていないと、MATLAB Compiler™ は警告を発行し、<component_name>_secrets_manifest.json
関数 setSecret はデプロイ可能ではありません。デプロイ可能なアーカイブに秘密鍵を組み込むには、アーカイブをビルドする前に MATLAB で setSecret を呼び出す必要があります。
シークレットを使用したデプロイの詳細については、Handle Sensitive Information in Deployed Applicationsを参照してください。
例: 'SecretsManifest','D:\Documents\MATLAB\work\mycomponent\mycomponent_secrets_manifest.json'
データ型: char | string
含めるサポート パッケージ。次のオプションのいずれかとして指定します。
'autodetect'(既定) — 依存関係の分析プロセスにより、必要なサポート パッケージが自動的に検出され、含められます。'none'— サポート パッケージは含められません。このオプションを使用すると、ランタイム エラーの原因となる可能性があります。string スカラー、文字ベクトル、または文字ベクトルの cell 配列 — 指定されたサポート パッケージのみが含められます。インストールされている、または特定のファイルで使用されるサポート パッケージのリストを表示するには、
compiler.codetools.deployableSupportPackagesを参照してください。
例: 'SupportPackages',{'Deep Learning Toolbox Converter for TensorFlow Models','Deep Learning Toolbox Model for Places365-GoogLeNet Network'}
データ型: char | string | cell
ビルドの詳細を制御するためのフラグ。'on' または 'off'、もしくは数値または logical 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off' の値は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は、matlab.lang.OnOffSwitchState 型の on/off の logical 値として保存されます。
このプロパティを
'on'に設定した場合、MATLAB コマンド ウィンドウには、ビルド プロセス中のコンパイラ出力を示す進行状況情報が表示されます。このプロパティを
'off'に設定した場合、コマンド ウィンドウには進行状況の情報は表示されません。
例: 'Verbose','on'
データ型: logical
出力引数
ビルド結果。compiler.build.Results オブジェクトとして返されます。Results オブジェクトには以下が含まれています。
'cppSharedLibrary'であるビルド タイプ以下へのパス:
GettingStarted.htmlv2フォルダー (matlab-dataインターフェイスのみ)LibraryName.dllmwArrayインターフェイスのみ)LibraryName.libmwArrayインターフェイスのみ)LibraryName.hmwArrayインターフェイスのみ)
含まれているサポート パッケージのリスト
ビルド オプション。
CppSharedLibraryOptionsオブジェクトとして指定必須およびオプションの依存関係のリスト。
Dependenciesオブジェクトとして指定します。
バージョン履歴
R2021a で導入MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Web サイトの選択
Web サイトを選択すると、翻訳されたコンテンツにアクセスし、地域のイベントやサービスを確認できます。現在の位置情報に基づき、次のサイトの選択を推奨します:
また、以下のリストから Web サイトを選択することもできます。
最適なサイトパフォーマンスの取得方法
中国のサイト (中国語または英語) を選択することで、最適なサイトパフォーマンスが得られます。その他の国の MathWorks のサイトは、お客様の地域からのアクセスが最適化されていません。
南北アメリカ
- América Latina (Español)
- Canada (English)
- United States (English)
ヨーロッパ
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)