matlab.codetools.requiredFilesAndProducts

R2026b

MATLAB プログラム ファイルの依存関係のリスト

構文

fList = matlab.codetools.requiredFilesAndProducts(files)

[fList, pList] = matlab.codetools.requiredFilesAndProducts(files)

[fList, pList] = matlab.codetools.requiredFilesAndProducts(___,'toponly')

説明

fList = matlab.codetools.requiredFilesAndProducts(files) は、files で指定されたプログラムを実行するために必要な MATLAB^® プログラム ファイルのリストを返します。

関数 matlab.codetools.requiredFilesAndProducts は、MATLAB プログラム ファイルの利用者に渡す情報を提供するためのものです。

また、[fList, pList] = matlab.codetools.requiredFilesAndProducts(files) は、files で指定されたプログラムを実行するために必要となる可能性のある MathWorks^® 製品のリストを返します。

受け取った MATLAB コードに対して関数 matlab.codetools.requiredFilesAndProducts を使用する場合、plist にはシステムにインストールされている必要なツールボックスのみが含まれます。この場合、plist の結果は不完全な場合があります。

[fList, pList] = matlab.codetools.requiredFilesAndProducts(___,'toponly') は、出力に含めるファイルまたは製品について、files で指定される少なくとも 1 つのファイルによって直接使用されるものでなければならないことを示します。'toponly' 入力オプションでは大文字と小文字が区別されません。

例

MATLAB ツールボックス関数で必要なファイルと製品の特定

Image Processing Toolbox™ の関数 edge に必要なファイルと製品を判別します。

[fList,pList] = matlab.codetools.requiredFilesAndProducts('edge.m')

fList = 

     {}


pList = 

1x2 struct array with fields:

    Name
    Version
    ProductNumber
    Certain

MATLAB ファイルは必要ではありませんが、必要な製品が 2 つあります。

必要な製品のリスト

{pList.Name}'

ans = 

    'MATLAB'
    'Image Processing Toolbox'

MATLAB プログラム ファイルで必要なファイルと製品の特定

現在の作業フォルダーで、getRandomNumber.m ファイルに関数を作成します。

function a = getRandomNumber
    rng shuffle
    a = rand;
end

続いて、コマンド ラインで、getRandomNumber.m に必要なファイルと製品を判別します。

[fList,pList] = matlab.codetools.requiredFilesAndProducts('getRandomNumber.m')

fList = 

    'C:\work\getRandomNumber.m'


pList = 

             Name: 'MATLAB'
          Version: '8.5'
    ProductNumber: 1
          Certain: 1

関数 getRandomNumber を実行する際に必要な唯一のファイルは、その関数ファイル自身です。必要な唯一の MathWorks 製品は MATLAB です。

現在の作業フォルダーで、displayNumber.m ファイルに関数を作成します。

function displayNumber
    a = getRandomNumber;
    disp(['Your number is ' num2str(a)])
end

続いて、コマンド ラインで、displayNumber.m に必要なファイルと製品を判別します。

[fList,pList] = matlab.codetools.requiredFilesAndProducts('displayNumber.m')

fList = 

    'C:\work\displayNumber.m'    'C:\work\getRandomNumber.m'


pList = 

             Name: 'MATLAB'
          Version: '8.5'
    ProductNumber: 1
          Certain: 1

関数 displayNumber は、自身の関数ファイルのほかに、getRandomNumber.m ファイルを必要とします。必要な唯一の MathWorks 製品は MATLAB です。

最上位の依存関係のみを特定

現在の作業フォルダーで、ExampleHandle.m ファイル内にハンドル クラスを作成します。

classdef ExampleHandle < handle
    % class content
end

現在の作業フォルダーで、ファイル AnotherExampleHandle.m に、ExampleHandle から継承されるクラスを 1 つ作成します。

classdef AnotherExampleHandle < ExampleHandle
    % class content
end

現在の作業フォルダーで、getHandles.m ファイル内に AnotherExampleHandle オブジェクトをインスタンス化する関数を作成します。

function [h1,h2] = getHandles()
    h1 = AnotherExampleHandle;
    h2 = AnotherExampleHandle;
end

続いて、コマンド ラインで、getHandles.m に必要なファイルを判別します。

[fList,~] = matlab.codetools.requiredFilesAndProducts('getHandles.m');
fList'

ans = 

    'C:\work\AnotherExampleHandle.m'
    'C:\work\ExampleHandle.m'
    'C:\work\getHandles.m'

getHandles.m で直接必要なファイルを判別します。

[fList,~] = matlab.codetools.requiredFilesAndProducts('getHandles.m','toponly')

fList = 

    'C:\work\AnotherExampleHandle.m'    'C:\work\getHandles.m'

AnotherExampleHandle.m は ExampleHandle.m を必要としますが、このファイルは、getHandles.m で直接必要とされることはありません。

入力引数

files — 解析するファイルのリスト

文字ベクトル | 文字ベクトルの cell 配列 | string 配列

解析するファイルのリスト。文字ベクトル、文字ベクトルの cell 配列または string 配列として指定します。各要素は 1 つの MATLAB プログラム ファイルの名前です。たとえば、他のユーザーに提供する MATLAB プログラム ファイルのリストを files に指定します。関数 matlab.codetools.requiredFilesAndProducts は、ファイルと一緒に渡す要件情報を提供します。

正確な依存関係の分析を実行するには、files および依存関係が MATLAB パス上になければなりません。matlab.codetools.requiredFilesAndProducts は、パス上にない依存関係ファイルに関する情報は返しません。

例: 'myFile.m' または "C:\Program Files\MATLAB\R2014a\my_work\myFile.m"

例: {'myFile.m','myOtherFile.m'}

例: cellstr(ls('*.m'))

出力引数

fList — ユーザーが作成した MATLAB プログラム ファイルのリスト

文字ベクトルの cell 配列

files が必要とする、ユーザーが作成した MATLAB プログラム ファイルのリスト。文字ベクトルの cell 配列として返されます。各文字ベクトルは必要なファイルの絶対パスを示します。fList には組み込み MATLAB ファイルは含まれません。これらのファイルは pList にリストされる製品と一緒にインストールされるためです。ただし、toolbox/local フォルダーにある userpath.m や restoredefaultpath.m など、構成可能なファイルは fList に含まれます。

fList には標準ファイル形式および低水準 I/O 関数を使用してアクセスされる依存ファイルが含まれています。これらの依存ファイルには、テキスト ファイル、スプレッドシート、イメージ、オーディオ、ビデオ、XML ファイルが含まれます。たとえば、コード load('mydata.mat') を含むファイルを解析する場合、関数 matlab.codetools.requiredFilesAndProducts は fList の mydata.mat を含みます。

依存ファイルの自動検出をサポートする関数には、以下が含まれます。

audioinfo	audioread	csvread	daqread
dlmread	fileread	fopen	imfinfo
importdata	imread	load	matfile
mmfileinfo	open	readcell	readmatrix
readtable	readtimetable	readvars	type
VideoReader	xlsfinfo	xlsread	xmlread
xslt

.

pList — MathWorks 製品のリスト

構造体または構造体の配列

files が必要とする可能性のある MathWorks 製品のリスト。構造体または構造体の配列として返されます。各製品は名前 (Name フィールド)、バージョン (Version フィールド)、製品番号 (ProductNumber フィールド)、確実性のインジケーター (Certain フィールド) によって記述されます。Certain フィールドの値は、matlab.codetools.requiredFilesAndProducts によって指定のプログラム ファイル files にその製品が必要であると判断された場合は 1、製品が必要となる可能性がある場合には 0 になります。

関数 matlab.codetools.requiredFilesAndProducts は、MATLAB プログラム ファイルの利用者に渡す情報を提供するためのものです。バージョン番号は、関数を実行する時点でのインストール済み製品のバージョンを示します。Version は下位互換性のインジケーターではありません。

バージョン履歴

R2014a で導入

参考

トピック

• プログラムの依存関係の特定