struct

構造体配列

説明

"構造体配列" は、"フィールド" と呼ばれるデータ コンテナーを使って、関連するデータをグループ化するデータ型です。各フィールドには任意のデータ型を含めることができます。structName.fieldName の形式のドット表記を使用して、フィールド内のデータにアクセスします。

作成

新しい構造体に入れるデータがある場合、ドット表記を使用して一度に 1 フィールドずつ名前を付けて構造体を作成します。

s.a = 1;
s.b = {'A','B','C'}

s = struct with fields:
    a: 1
    b: {'A'  'B'  'C'}

フィールド名には、ASCII 文字 (A ～ Z、a ～ z)、数字 (0 ～ 9) およびアンダースコアを使用でき、文字で始める必要があります。フィールド名の最大長は namelengthmax です。

また、以下に説明するように関数 struct を使用して構造体配列を作成することもできます。多数のフィールドを同時に指定する、または非スカラー構造体配列を作成することができます。

構文

s = struct

s = struct(field,value)

s = struct(field1,value1,...,fieldN,valueN)

s = struct([])

s = struct(obj)

説明

s = struct は、フィールドなしのスカラー (1 行 1 列) 構造体を作成します。

s = struct(field,value) は、指定したフィールドと値をもつ構造体配列を作成します。入力引数 value は、数値、論理値、文字、cell 配列などの任意のデータ型を使用できます。

• value が "cell 配列ではない" 場合、または value がスカラー cell 配列である場合、s はスカラー構造体です。たとえば、s = struct('a',[1 2 3]) は 1 行 1 列の構造体を作成し、s.a = [1 2 3] となります。

• value が非スカラー cell 配列の場合、s は value と同じ次元の構造体配列です。s の各要素は、対応する value の要素を含みます。たとえば、s = struct('x',{'a','b'}) は s(1).x = 'a' および s(2).x = 'b' を返します。

• value が空の cell 配列 {} である場合、s は空 (0 行 0 列) の構造体です。

s = struct(field1,value1,...,fieldN,valueN) は、複数のフィールドをもつ構造体配列を作成します。

• 入力 value がいずれも cell 配列でない場合、あるいは cell 配列である入力 value のすべてがスカラーである場合、s はスカラー構造体です。

• 入力 value のいずれかが非スカラー cell 配列である場合、s はその cell 配列と同じ次元をもちます。また、2 つ以上の入力 value が非スカラー cell 配列である場合、それらはすべて同じ次元でなければなりません。

  value のいずれがスカラー cell 配列であるか、それ以外のデータ型の配列である場合、struct は s のすべての要素に対して関連フィールド内の value の内容を挿入します。たとえば、s = struct('x',{'a','b'},'y','c') は s(1).x = 'a'、s(2).x = 'b'、s(1).y = 'c'、および s(2).y = 'c' を返します。

• 入力 value のいずれかが空の cell 配列 {} である場合、出力 s は空 (0 行 0 列) の構造体です。空のフィールドを 1 つ指定して、その他のフィールドの値を維持するには、代わりに value の入力に [] を使用します。

s = struct([]) は、フィールドなしの空 (0 行 0 列) の構造体を作成します。

s = struct(obj) は、obj のプロパティに対応するフィールド名と値をもつスカラー構造体を作成します。関数 struct は、obj を変換するのではなく、新しい構造体として s を作成します。この構造体はクラス情報を保持せず、プライベート プロパティ、保護プロパティおよび非表示プロパティは s 内のパブリック フィールドになります。この構文を使用すると、関数 struct が警告を発行します。

入力引数

field — フィールド名

文字ベクトル | string スカラー

フィールド名。文字ベクトルまたは string スカラーとして指定します。

value — 値

配列

値。任意の配列タイプとして指定します。入力 value のいずれかが非スカラー cell 配列の場合、すべての非スカラー cell 配列入力は同じ次元でなければなりません。

入力 value のいずれかが空の cell 配列 {} である場合、出力は空の構造体配列です。単一の空のフィールドを指定するには、[] を使用します。

obj — オブジェクト

オブジェクト

関数 struct は、obj のプロパティを新しいスカラー構造体のフィールドにコピーします。

関数 struct は、ほとんどの基本データ型から構造体を作成しません。たとえば、obj に double データ型または char データ型がある場合、struct でエラー メッセージが発行されます。ただし、struct は、table または timetable のプロパティを構造体として返します。基本データ型の一覧は、MATLAB の基本クラスを参照してください。

例

関連するデータ変数を構造体に格納

関連するデータを構造体のフィールドに格納します。フィールドには、データの内容を表し、人間が読み取ることのできる名前を設定できます。

ドット表記を使ってフィールドを追加することで、構造体を作成します。フィールドには正弦波の x 値と y 値、およびデータを説明するテキストが格納されます。

data.x = linspace(0,2*pi);
data.y = sin(data.x);
data.title = 'y = sin(x)'

data = struct with fields:
        x: [0 0.0635 0.1269 0.1904 0.2539 0.3173 0.3808 0.4443 0.5077 0.5712 0.6347 0.6981 0.7616 0.8251 0.8885 0.9520 1.0155 1.0789 1.1424 1.2059 1.2693 1.3328 1.3963 1.4597 1.5232 1.5867 1.6501 1.7136 1.7771 1.8405 1.9040 1.9675 ... ] (1x100 double)
        y: [0 0.0634 0.1266 0.1893 0.2511 0.3120 0.3717 0.4298 0.4862 0.5406 0.5929 0.6428 0.6901 0.7346 0.7761 0.8146 0.8497 0.8815 0.9096 0.9341 0.9549 0.9718 0.9848 0.9938 0.9989 0.9999 0.9969 0.9898 0.9788 0.9638 0.9450 0.9224 ... ] (1x100 double)
    title: 'y = sin(x)'

正弦波をプロットします。フィールド名によって x 値と y 値の配列を参照することができます。その後、タイトルを追加します。

plot(data.x,data.y)
title(data.title)

1 つのフィールドをもつ構造体

1 つのフィールドをもつ非スカラー構造体を作成します。

field = 'f';
value = {'some text';
         [10, 20, 30];
         magic(5)};
s = struct(field,value)

s=3×1 struct array with fields:
    f

各要素の内容を表示します。

s.f

ans = 
'some text'

ans = 1×3

    10    20    30

ans = 5×5

    17    24     1     8    15
    23     5     7    14    16
     4     6    13    20    22
    10    12    19    21     3
    11    18    25     2     9

非スカラー構造体のフィールド (s.f など) にアクセスすると、MATLAB® はコンマ区切りのリストを返します。この場合、s.f は s(1).f, s(2).f, s(3).f と等価です。

複数のフィールドをもつ構造体

複数のフィールドをもつ非スカラー構造体を作成します。

field1 = 'f1';  value1 = zeros(1,10);
field2 = 'f2';  value2 = {'a', 'b'};
field3 = 'f3';  value3 = {pi, pi.^2};
field4 = 'f4';  value4 = {'fourth'};

s = struct(field1,value1,field2,value2,field3,value3,field4,value4)

s=1×2 struct array with fields:
    f1
    f2
    f3
    f4

value2 および value3 の cell 配列が 1 行 2 列の場合、s も 1 行 2 列になります。value1 は cell 配列でなく数値配列であるため、s(1).f1 と s(2).f1 の両方が同じコンテンツをもちます。同様に、value4 の cell 配列は 1 つの要素をもつため、s(1).f4 と s(2).f4 は同じコンテンツをもちます。

s(1)

ans = struct with fields:
    f1: [0 0 0 0 0 0 0 0 0 0]
    f2: 'a'
    f3: 3.1416
    f4: 'fourth'

s(2)

ans = struct with fields:
    f1: [0 0 0 0 0 0 0 0 0 0]
    f2: 'b'
    f3: 9.8696
    f4: 'fourth'

空のフィールドをもつ構造体

空のフィールドを 1 つもつ構造体を作成します。空のフィールドの値を指定するには [] を使用します。

s = struct('f1','a','f2',[])

s = struct with fields:
    f1: 'a'
    f2: []

cell 配列をもつフィールド

cell 配列を含むフィールドをもつ構造体を作成します。

field = 'mycell';
value = {{'a','b','c'}};
s = struct(field,value)

s = struct with fields:
    mycell: {'a'  'b'  'c'}

空の構造体

複数のフィールドをもつ空の構造体を作成します。

s = struct('a',{},'b',{},'c',{})

s = 

  0x0 empty struct array with fields:

    a
    b
    c

空の構造体のフィールドに値を割り当てます。

s(1).a = 'a'

s = struct with fields:
    a: 'a'
    b: []

    c: []

入れ子にされた構造体

入れ子にされた構造体を作成します。ここで、a は別の構造体を含むフィールドをもつ構造体です。

a.b = struct('c',{},'d',{})

a = struct with fields:
    b: [0x0 struct]

a.b のフィールドの名前を表示します。

fieldnames(a.b)

ans = 2x1 cell
    {'c'}
    {'d'}

拡張機能

C/C++ コード生成

MATLAB® Coder™ を使用して C および C++ コードを生成します。

使用上の注意および制限:

• value 引数が cell 配列の場合、すべての要素は同じ型でなければなりません。

• 構造体配列のフィールド名は同じ長さでなければなりません。たとえば、'my_int' と 'my_double' は長さが異なるため、次のコードはエラーになります。

  param1.name = 'my_int';
  param1.value = int32(1);
  param2.name = 'my_double';
  param2.value = 2.0;
  params = [param1, param2];

スレッドベースの環境

MATLAB® の backgroundPool を使用してバックグラウンドでコードを実行するか、Parallel Computing Toolbox™ の ThreadPool を使用してコードを高速化します。

この関数はスレッドベースの環境を完全にサポートしています。詳細については、スレッドベースの環境での MATLAB 関数の実行を参照してください。

バージョン履歴

R2006a より前に導入

R2023b: 構造体フィールド内の配列の内容の一部およびサイズとデータ型の表示

R2021b から R2023b までは、MATLAB^® は、構造体フィールド内の配列の内容が表示に収まる場合は内容全体を表示しました。配列が収まらない場合は、MATLAB は表示できるだけの配列を表示しました。

R2023b 以降では、フィールド内の配列の内容全体が表示に収まらない場合は、MATLAB は表示できるだけの配列および配列のサイズとデータ型を表示します。たとえば、R2023b 以降では、MATLAB は、100 件の double 値の配列を含む 2 つのフィールドの場合、その内容の一部およびフィールドのサイズとデータ型を表示します。

data.x = linspace(0,2*pi);
data.y = sin(data.x);
data

data = 

  struct with fields:

    x: [0 0.0635 0.1269 0.1904 0.2539 0.3173 0.3808 … ] (1×100 double)
    y: [0 0.0634 0.1266 0.1893 0.2511 0.3120 0.3717 … ] (1×100 double)

長い名前を含む列挙メンバーなど、配列の 1 番目の要素自体が大きすぎて表示できない場合、MATLAB は配列のサイズとデータ型のみを表示します。

関数 disp は同じ動作となります。

R2021b: サイズとデータ型ではなく構造体フィールド内の配列の内容の一部の表示

R2021b より前は、MATLAB は、構造体フィールド内の配列の内容が表示に収まる場合は内容全体を表示しました。配列が収まらない場合、MATLAB は配列のサイズとデータ型を表示しました。

R2021b 以降では、配列の内容全体が表示に収まらない場合、MATLAB は、サイズとデータ型ではなく、表示で許容されるだけの配列を表示します。たとえば、R2021b 以降では、MATLAB は、100 件の double 値の配列を含む 2 つの構造体フィールドの場合、その内容の一部を表示します。

data.x = linspace(0,2*pi);
data.y = sin(data.x);
data

data = 

  struct with fields:

     x: [0 0.0635 0.1269 0.1904 0.2539 0.3173 0.3808 0.4443 0.5077 … ]
     y: [0 0.0634 0.1266 0.1893 0.2511 0.3120 0.3717 0.4298 0.4862 … ]

長い名前を含む列挙メンバーなど、配列の 1 番目の要素自体が大きすぎて表示できない場合、MATLAB は配列のサイズとデータ型のみを表示します。

関数 disp は同じ動作となります。

R2019a: 構造体配列の拡張が一般的な配列の拡張と一致

R2019a 以降、拡張した構造体配列の次元は、ドット表記を使用して 1 つのフィールドに 1 つの値を代入した場合、および構造体全体を配列に代入した場合のどちらも同じになります。以前は、すべての次元に対してインデックスを指定しない場合、出力の次元が異なっていました。ドット表記を使用したフィールドへの代入が、構造体を代入した場合の以前の動作と合致するようになりました。つまり、一般的な配列の拡張と一致するようになりました。以下に例を示します。

• S が 1 x 2 x 3 x 4 である場合、S(5,2)=struct('a',3) と S(5,2).a=3 はいずれも S を 5 x 2 x 3 x 4 に拡張します。以前の S(5,2).a=3 の結果は 5 行 24 列の配列でした。

• S が 0 行 5 列または 5 行 0 列の場合、S(3)=struct('a',2) と S(3).a=2 はどちらも S を 1 行 3 列に拡張します。以前の S(3).a=1 の結果は、S が 0 行 5 列の場合に 1 行 5 列の配列、S が 5 行 0 列の場合に 3 行 1 列の配列でした。

• S が 0 x 2 x 3 の場合、どの次元を拡張するかがあいまいであるため、S(3) = struct('a',2) と S(3).a=2 はエラーになります。以前の S(3).a=2 の結果は 1 行 6 列の配列でした。

• S が 1 x 1 x 3 で 2 つのフィールドをもつ場合、S(5)=struct('a',7,'b',[]) と S(5).a=7 はどちらも S を 1 x 1 x 5 に拡張します。以前は、S(5).a=7 の結果は 1 行 5 列の配列となっていました。

• S が 0 行 1 列で 2 つのフィールドをもつ場合、S(5)=struct('a',7,'b',[]) と S(5).a=7 はどちらも S を 5 行 1 列に拡張します。以前は、S(5).a=7 の結果は 1 行 5 列の配列となっていました。

参考

isfield | table | isstruct | fieldnames | orderfields | rmfield | substruct | cell2struct | struct2cell | struct2table | table2struct | namelengthmax

トピック

• 構造体配列
• 入れ子にされた構造体内のデータへのアクセス
• 変数からフィールド名を生成