Main Content

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

compiler.build.standaloneApplication

MATLAB の外部でデプロイ用のスタンドアロン アプリケーションを作成

説明

compiler.build.standaloneApplication(AppFile) は、MATLAB® 関数、クラス、または AppFile で指定したアプリを使用して、デプロイ可能なスタンドアロン アプリケーションを作成します。実行可能ファイルのタイプは、オペレーティング システムにより決定されます。生成された実行可能ファイルには MATLAB Runtime やインストーラーが含まれていません。

compiler.build.standaloneApplication(AppFile,Name,Value) は、名前と値の引数を 1 つ以上使って指定した追加オプションを用いて、スタンドアロン アプリケーションを作成します。オプションには実行可能ファイルの名前、ヘルプ テキスト、アイコン イメージがあります。

compiler.build.standaloneApplication(opts) は、compiler.build.StandaloneApplicationOptions オブジェクト opts を使って指定した追加オプションを用いて、スタンドアロン アプリケーションを作成します。名前と値の引数を使用して他のオプションを指定することはできません。

results = compiler.build.standaloneApplication(___) は、前述の構文にある引数の任意の組み合わせを使用して、ビルド情報を compiler.build.Results オブジェクトとして返します。ビルド情報は、ビルド タイプ、コンパイル済みファイルへのパス、およびビルド オプションで構成されます。

すべて折りたたむ

魔方陣を生成する関数ファイルを使用してスタンドアロン アプリケーションを作成します。

MATLAB で、スタンドアロン アプリケーションとしてデプロイする MATLAB コードを見つけます。この例では、matlabroot\extern\examples\compiler にあるファイル magicsquare.m を使用してコンパイルします。

appFile = fullfile(matlabroot,'extern','examples','compiler','magicsquare.m');

compiler.build.standaloneApplication コマンドを使用して、スタンドアロン アプリケーションをビルドします。

compiler.build.standaloneApplication(appFile);

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

  • includedSupportPackages.txt — アプリケーションに含まれている、すべてのサポートされるファイルをリストしたテキスト ファイル。

  • magicsquare.exe または magicsquare — Windows® システムでコンパイルされた場合は .exe 拡張子をもつ実行可能ファイル、Linux® システムまたは macOS システムでコンパイルされた場合は拡張子のない実行可能ファイル。

  • run_magicsquare.sh — ライブラリ パスを設定し、アプリケーションを実行するシェル スクリプト ファイル。このファイルは Linux システムおよび macOS システムでのみ生成されます。

  • mccExcludedFiles.log — アプリケーションに含まれていないすべてのツールボックス関数のリストが含まれるログ ファイル。サポートされていない関数の詳細については、MATLAB Compiler の制限を参照してください。

  • readme.txt — デプロイの前提条件に関する情報と、デプロイ用にパッケージ化するファイルのリストが含まれるテキスト ファイル。

  • requiredMCRProducts.txtMATLAB Runtime がアプリケーションを実行するために必要な製品の製品 ID が含まれるテキスト ファイル。

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

入力引数 4 を指定して MATLAB から magicsquare を実行するには、magicsquarestandaloneApplication フォルダーに移動し、オペレーティング システムに基づいて以下のコマンドのいずれかを実行します。

オペレーティング システムMATLAB コマンド ウィンドウでのテスト
Windows!magicsquare 4
macOSsystem(['./run_magicsquare.sh ',matlabroot,' 4']);
Linux!./magicsquare 4

アプリケーションにより 44 列の魔方陣が出力されます。

    16     2     3    13
     5    11    10     8
     9     7     6    12
     4    14    15     1

MATLAB 外でスタンドアロン アプリケーションを実行するには、スタンドアロン アプリケーションの実行を参照してください。

スタンドアロン アプリケーションを作成し、名前と値の引数を使用してカスタマイズします。

サブ関数を使用して魔方陣の対角要素を計算する MATLAB 関数を記述します。これらの関数を mymagicdiag.m および mydiag.m という名前のファイルに保存します。

function out = mymagicdiag(in)
X = magic(in);
out = mydiag(X);
function out = mydiag(in)
out = [diag(in)]';

mymagicdiag.m を使用してスタンドアロン アプリケーションをビルドします。名前と値のペアの引数を使用して実行可能ファイル名を指定し、関数ファイル mydiag.m を追加して、コマンド ライン入力を double の数値として解釈します。

compiler.build.standaloneApplication('mymagicdiag.m',...
    'ExecutableName','MagicDiagApp',...
    'AdditionalFiles','mydiag.m',...
    'TreatInputsAsNumeric','On')

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

  • includedSupportPackages.txt

  • MagicDiagApp.exe または MagicDiagApp

  • run_MagicDiagApp.sh (Linux システムおよび macOS システムの場合のみ)

  • mccExcludedFiles.log

  • readme.txt

  • requiredMCRProducts.txt

入力引数 4 を指定して MATLAB から MagicDiagApp を実行するには、MagicDiagAppstandaloneApplication フォルダーに移動し、オペレーティング システムに基づいて以下のコマンドのいずれかを実行します。

オペレーティング システムMATLAB コマンド ウィンドウでのテスト
Windows!MagicDiagApp 4
macOSsystem(['./run_MagicDiagApp.sh ',matlabroot,' 4']);
Linux!./MagicDiagApp 4

アプリケーションにより、44 列の魔方陣の対角要素が出力されます。

    16     11     6    1

compiler.build.StandaloneApplicationOptions オブジェクトを使用して、Windows システム上で複数のスタンドアロン アプリケーションを作成します。

この例では、matlabroot\extern\examples\compiler にあるファイル magicsquare.m を使用します。

appFile = fullfile(matlabroot,'extern','examples','compiler','magicsquare.m');

appFile を使用して StandaloneApplicationOptions オブジェクトを作成します。名前と値の引数を使用して共通の出力ディレクトリを指定し、コマンド ライン入力を double の数値として解釈し、ビルド プロセス中に進行状況の情報を表示します。

opts = compiler.build.StandaloneApplicationOptions(appFile,...
    'OutputDir','D:\Documents\MATLAB\work\MagicBatch',...
    'TreatInputsAsNumeric','On',...
    'Verbose','On')
opts =

  StandaloneApplicationOptions with properties:

            CustomHelpTextFile: ''
              EmbedArchive: on
            ExecutableIcon: 'C:\Program Files\MATLAB\R2022a\toolbox\compiler\packagingResources\default_icon_48.png'
            ExecutableName: 'magicsquare'
    ExecutableSplashScreen: 'C:\Program Files\MATLAB\R2022a\toolbox\compiler\packagingResources\default_splash.png'
         ExecutableVersion: '1.0.0.0'
                   AppFile: 'C:\Program Files\MATLAB\R2022a\extern\examples\compiler\magicsquare.m'
      TreatInputsAsNumeric: on
           AdditionalFiles: {}
       AutoDetectDataFiles: on
           SupportPackages: {'autodetect'}
                   Verbose: on
                 OutputDir: 'D:\Documents\MATLAB\work\MagicBatch'

StandaloneApplicationOptions オブジェクトを入力としてビルド関数に渡すことで、スタンドアロン アプリケーションをビルドします。

compiler.build.standaloneApplication(opts);

同じオプションをもつ関数ファイル example2.m を使用して新しいスタンドアロン アプリケーションを作成するには、ビルド関数を再度実行する前に、ドット表記を使用して既存の StandaloneApplicationOptions オブジェクトの AppFile を変更します。

opts.AppFile = 'example2.m';
compiler.build.standaloneApplication(opts);

AppFile 引数を変更して再コンパイルすることにより、同じオプション オブジェクトを使用して複数のアプリケーションを作成できます。

スタンドアロン アプリケーションを作成し、ビルド タイプ、生成ファイル、含まれるサポート パッケージ、およびビルド オプションに関する情報を compiler.build.Results オブジェクトに保存します。

matlabroot\extern\examples\compiler にあるファイル magicsquare.m を使用してコンパイルします。

results = compiler.build.standaloneApplication('magicsquare.m')
results = 

              BuildType: 'standaloneApplication'
                  Files: {2×1 cell}
IncludedSupportPackages: {}
                Options: [1×1 compiler.build.StandaloneApplicationOptions]

Files プロパティには、magicsquare スタンドアロン実行可能ファイルと readme.txt ファイルへのパスが格納されます。

入力引数

すべて折りたたむ

アプリケーションのビルドに使用するメイン ファイルへのパス。行の文字ベクトルまたは string スカラーとして指定します。このファイルは、MATLAB 関数、クラス、またはアプリで、タイプは .m.p.mlx.mlapp、あるいは有効な MEX ファイルでなければなりません。

例: 'mymagic.m'

データ型: char | string

スタンドアロン アプリケーションのビルド オプション。compiler.build.StandaloneApplicationOptions オブジェクトとして指定します。

名前と値の引数

オプションのペアの引数を Name1=Value1,...,NameN=ValueN として指定します。ここで、Name は引数名で、Value は対応する値です。名前と値の引数は他の引数の後に指定する必要がありますが、ペアの順序は考慮されません。

R2021a より前では、コンマを使用してそれぞれの名前と値を区切り、Name を引用符で囲みます。

例: 'EmbedArchive','on'

スタンドアロン アプリケーションに含める追加のファイルとフォルダー。文字ベクトル、string スカラー、string 配列、または文字ベクトルの cell 配列として指定します。パスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。

例: 'AdditionalFiles',["myvars.mat","myfunc.m"]

データ型: char | string | cell

データ ファイルを自動的に含めるためのフラグ。'on' または 'off'、もしくは数値または logical の 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off'false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState 型の on/off logical 値として格納されます。

  • このプロパティを 'on' に設定した場合、特定の関数 (loadfopen など) の入力として指定されるデータ ファイルは自動的にスタンドアロン アプリケーションに含められます。

  • このプロパティを 'off' に設定した場合、データ ファイルは AdditionalFiles プロパティを使用してアプリケーションに追加しなければなりません。

例: 'AutoDetectDataFiles','Off'

データ型: logical

アプリケーションのエンド ユーザー向けヘルプ テキストが含まれるヘルプ ファイルへのパス。文字ベクトルまたは string スカラーとして指定します。このパスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。

例: 'CustomHelpTextFile','D:\Documents\MATLAB\work\help.txt'

データ型: char | string

スタンドアロン アーカイブを組み込むためのフラグ。'on' または 'off'、もしくは数値または logical の 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off'false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState 型の on/off logical 値として格納されます。

  • このプロパティを 'on' に設定した場合、関数はアーカイブをスタンドアロン実行可能ファイルに組み込みます。

  • このプロパティを 'off' に設定した場合、関数はスタンドアロン アーカイブを別個のファイルとして生成します。

例: 'EmbedArchive','Off'

データ型: logical

アイコン イメージへのパス。文字ベクトルまたは string スカラーとして指定します。イメージは、スタンドアロン実行可能ファイルのアイコンとして使用されます。このパスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。使用可能なイメージのタイプは .jpg.jpeg.png.bmp.gif です。

既定のパスは次のとおりです。

'matlabroot\toolbox\compiler\packagingResources\default_icon_48.png'

例: 'ExecutableIcon','D:\Documents\MATLAB\work\images\myIcon.png'

データ型: char | string

生成されるアプリケーションの名前。文字ベクトルまたは string スカラーとして指定します。既定値は AppFile のファイル名です。ターゲットの出力名は英字またはアンダースコアで始まっていなければならず、また英数字とアンダースコアのみ使用できます。

例: 'ExecutableName','MagicSquare'

データ型: char | string

スプラッシュ スクリーン イメージへのパス。文字ベクトルまたは string スカラーとして指定します。このパスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。使用可能なイメージのタイプは .jpg.jpeg.png.bmp.gif です。イメージのサイズは 400 x 400 ピクセルに変更されます。

既定のパスは次のとおりです。

'matlabroot\toolbox\toolbox\compiler\packagingResources\default_splash.png'

メモ

これは、compiler.build.standaloneWindowsApplication を使用してビルドされた Windows アプリケーションでのみ使用されます。

例: 'ExecutableSplashScreen','D:\Documents\MATLAB\work\images\mySplash.png'

データ型: char | string

実行可能ファイルのバージョン。文字ベクトルまたは string スカラーとして指定します。

メモ

これは Windows オペレーティング システムでのみ使用されます。

例: 'ExecutableVersion','4.0'

データ型: char | string

ビルド ファイルが保存される出力ディレクトリへのパス。文字ベクトルまたは string スカラーとして指定します。このパスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。

ビルド フォルダーの既定の名前は、実行可能ファイル名に standaloneApplication を追加したものです。

例: 'OutputDir','D:\Documents\MATLAB\work\MagicSquarestandaloneApplication'

データ型: 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 double の数値として扱われます。

  • このプロパティを 'off' に設定した場合、コマンド ライン入力は MATLAB 文字ベクトルとして扱われます。

例: 'TreatInputsAsNumeric','On'

データ型: logical

ビルドの詳細を制御するためのフラグ。'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 オブジェクトには以下が含まれています。

  • 'standaloneApplication' であるビルド タイプ

  • コンパイル済みファイルへのパス

  • 含まれているサポート パッケージのリスト

  • ビルド オプション。StandaloneApplicationOptions オブジェクトとして指定

ヒント

  • この関数を使用してシステム コマンド プロンプトからスタンドアロン アプリケーションを作成するには、関数 matlab-batch オプションと共に使用します。以下に例を示します。

    matlab -batch compiler.build.standaloneApplication('mymagic.m')

バージョン履歴

R2020b で導入