coder.write

実行時に生成コードで読み取るデータファイルを作成

R2023a 以降

構文

coder.write(fileName,data)

coder.write(fileName,data,Name=Value)

説明

coder.write(fileName,data) は、引数 data を現在のディレクトリにある名前 fileName.coderdata のファイルに格納します。この関数は、MATLAB^® の実行でのみ使用し、C/C++ コード生成に使用する MATLAB コードでは使用しません。

MATLAB および生成コードで .coderdata ファイルからデータを読み取るには、関数 coder.read (MATLAB Coder) を使用します。

.coderdata ファイルには、そのファイルに格納されているデータの型とサイズを指定する "タイプヘッダー" が含まれています。関数 coder.read の生成コードでは、実行時に任意の .coderdata ファイルを読み取ることができ、その型とサイズは、コード生成時に coder.read に提供する型とサイズの情報と一致したものになります。

coder.write(fileName,data,Name=Value) は、"タイプヘッダーファイル" を作成します。これは、関数 coder.read にデータの型とサイズを指定するために使用する .coderdata ファイルです。名前と値の引数は次の目的に使用します。

変数 data と一致する .coderdata ファイルのカスタムタイプヘッダーを指定する。
実際のデータを省略し、タイプヘッダーのみを含む .coderdata ファイルを作成する。

例

すべて折りたたむ

`.coderdata` ファイルへの変数の格納

この例では、単一の変数用のストレージファイルを作成する方法を示します。このストレージファイルは、関数 coder.read (MATLAB Coder) を使用して実行時に読み取ることができます。

ワークスペースに 20 行 20 列の double 型の配列を作成します。

c = rand(20);

この変数を現在のディレクトリ内の storageFile.coderdata という名前のファイルに格納します。

coder.write("storageFile.coderdata",c);

`.coderdata` ファイルへの複数の変数の格納

この例では、複数の変数用のストレージファイルを作成する方法を示します。

ワークスペースに 2 つの double 型の配列を作成します。配列 a のサイズは 10 行 10 列で、配列 b は 20 行 20 列です。

a = rand(10);
b = rand(20);

配列 a と b をフィールドに格納する構造体 s を作成します。

s = struct('a',a,'b',b);

構造体 s を .coderdata ファイルに格納します。

coder.write("storageFile.coderdata",s);

あるいは、cell 配列を使用して複数の変数を .coderdata ファイルに格納できます。

複数のデータファイルと互換性があるタイプヘッダーファイルの作成

この例では、実行時に複数の .coderdata ファイルを読み取ることができる coder.read コマンドのコードを生成します。これらのファイルには、型は同じですがサイズが異なる配列データが含まれています。コードを生成するには、個々のすべてのデータファイルと一致するタイプヘッダーファイルを関数 coder.read の呼び出しに渡す必要があります。

double 型の配列データをもつ 2 つの変数を格納するストレージファイル file_a.coderdata を作成します。変数 a と b はサイズが異なります。

a = rand(10,20);
b = rand(5,30);
coder.write("file_a.coderdata",a);

a および b の両方の変数と一致する coder.Type オブジェクトでは、次元を可変サイズにする必要があります。2 つの配列次元の上限は、それぞれ少なくとも 10 と 30 でなければなりません。これらの範囲をもつ可変サイズの double 型を表す coder.Type オブジェクトを作成します。

t = coder.typeof(a,[10 30],[1 1])

t = 

coder.PrimitiveType
   :10×:30 double

file_a.coderdata のヘッダー情報を変更し、変更したファイルをタイプヘッダー情報のソースとして使用できます。

coder.write("file_a.coderdata",a,TypeHeader=t);

次のコマンドを実行して、必要なタイプヘッダー情報をもつ file_b.coderdata ファイルを作成することもできます。

coder.write("file_b.coderdata",b,TypeHeader=t);

あるいは、実際のデータは含めずに、既存のすべてのストレージファイルと互換性があるタイプヘッダーのみを含む独立したタイプヘッダーファイル myTypeHeader.coderdata を作成できます。

coder.write("file_b.coderdata",b,TypeHeader=t,TypeHeaderOnly=true);

このようなタイプヘッダーファイルは、大きなデータファイルを扱う場合に、生成されたファイルをタイプヘッダーファイルとしてのみ使用するのに便利です。

入力引数

すべて折りたたむ

`fileName` — 新規または既存のストレージファイルの名前または絶対ファイルパス
string スカラー | 文字ベクトル

新規または既存のストレージファイルの名前または絶対ファイルパス。string スカラーまたは文字ベクトルとして指定します。生成されるストレージファイルの名前は fileName.coderdata になります。提供した値に既に拡張子がある場合は、そのまま fileName になります。

`data` — ストレージファイルに保存するデータソース
配列 | 構造体 | cell 配列 | 列挙 | categorical | スパース配列

ストレージファイルに保存するデータソース。単一の配列か、構造体または cell 配列内に格納された複数の配列として指定します。

名前と値の引数

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

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

例: coder.write('example.coderdata',rand(1000),TypeHeader=coder.typeof(1,[1000 1000],1 1]),TypeHeaderOnly=true)

`TypeHeader` — ストレージデータの型情報
`coder.typeof(data)` (既定値) | `coder.Type` オブジェクト

ストレージデータの型情報。coder.Type オブジェクトとして指定します。この型オブジェクトは、入力引数 data と互換性がなければなりません。

型オブジェクトを作成するには、関数 coder.typeof (MATLAB Coder) または coder.newtype (MATLAB Coder) を使用します。coder.Type オブジェクトの作成と編集は、コード生成の型エディターを使用して対話形式で行うこともできます。コード生成の型エディターを使用した入力の型の作成と編集 (MATLAB Coder)を参照してください。

例: coder.write('example.coderdata',rand(10),TypeHeader=coder.typeof(1,[10 10],1 1]))

`TypeHeaderOnly` — タイプヘッダーのみを含む `.coderdata` ファイルを作成するかどうか
`false` (既定値) | `true`

データを省略してタイプヘッダーのみを含む .coderdata ファイルを作成するかどうかを指定するオプション。true または false として指定します。data が大きな配列の場合に .coderdata ファイルをタイプヘッダーファイルとしてのみ使用するには、この引数を true に設定します。

例: coder.write('example.coderdata',rand(1000),TypeHeaderOnly=true)

`Verbose` — ファイルへの書き込み時にレポートするかどうか
`true` (既定値) | `false`

.coderdata ファイルへの書き込み時に MATLAB コマンドラインでレポートするかどうかを指定するオプション。true または false として指定します。

バージョン履歴

R2023a で導入

参考

トピック

Data Read and Write Considerations (MATLAB Coder)

coder.write

構文

説明

例

.coderdata ファイルへの変数の格納

.coderdata ファイルへの複数の変数の格納

複数のデータ ファイルと互換性があるタイプ ヘッダー ファイルの作成