Main Content

このページの内容は最新ではありません。最新版の英語を参照するには、ここをクリックします。

varfun

関数をテーブル変数または timetable 変数に適用

ページ内をすべて折りたたむ

構文

B = varfun(func,A)
B = varfun(func,A,Name,Value)

説明

例

B = varfun(func,A) は、関数 func を table または timetable A の各変数に個別に適用し、結果を table または timetable B で返します。

関数 func は入力引数 を 1 つ取り、この関数が呼び出されるたびに、同じ行数の配列を返さなければなりません。出力引数 B{:,i} の i 番目の値は func(A{:,i}) と等しくなります。

例

B = varfun(func,A,Name,Value) は、1 つ以上の引数 Name,Value で指定された追加のオプションを使用して、関数 func を table または timetable A の各変数に個別に適用します。

たとえば、名前と値の引数 "GroupingVariables" を使用して、table 変数内のデータのグループに対して計算を実行できます。データのグループに対する計算の詳細については、データ グループに対する計算を参照してください。

例

すべて折りたたむ

ライブ スクリプトを開く

要素単位関数を table の変数に適用します。

数値変数を含む table を作成します。

A = table([10.71;-2.05;-0.35;-0.82;1.57],[9.23;3.12;-1.18;0.23;16.41])
A=5×2 table
    Var1     Var2 
    _____    _____

    10.71     9.23
    -2.05     3.12
    -0.35    -1.18
    -0.82     0.23
     1.57    16.41

関数 round を使用して、A の数値を丸めます。varfun への入力引数として関数を指定するには、@ 記号を使用します。出力 table B の変数には、関数と A の変数名に基づいて名前が付けられます。

B = varfun(@round,A)
B=5×2 table
    round_Var1    round_Var2
    __________    __________

        11             9    
        -2             3    
         0            -1    
        -1             0    
         2            16
ライブ スクリプトを開く

最初の次元に沿って table 変数を削減する sum や max などの関数を適用できます。たとえば、varfun を使用して table 内の各変数の平均を計算します。

数値変数を含む table を作成します。

A = table([0.71;-2.05;-0.35;-0.82;1.57],[0.23;0.12;-0.18;0.23;0.41])
A=5×2 table
    Var1     Var2 
    _____    _____

     0.71     0.23
    -2.05     0.12
    -0.35    -0.18
    -0.82     0.23
     1.57     0.41

func を関数 mean として指定します。func を関数ハンドルとして指定するには、@ 記号を使用します。

func = @mean
func = function_handle with value:
    @mean

テーブル A のすべての変数に関数を適用します。

B = varfun(func,A)
B=1×2 table
    mean_Var1    mean_Var2
    _________    _________

     -0.188        0.162

B は、各変数からの平均値を含む table です。

varfun が table ではなく数値ベクトルを返すようにするには、"OutputFormat" を "uniform" として指定します。"uniform" 出力形式を使用するには、func は常にスカラーを返す必要があります。

B = varfun(func,A,"OutputFormat","uniform")
B = 1×2

   -0.1880    0.1620
ライブ スクリプトを開く

データを含む数値変数、およびグループ化変数である非数値変数をもつ table を作成します。次に、数値変数内の各グループに対して計算を実行します。

関数 readtable を使用して、CSV (コンマ区切り値) ファイル testScores.csv から table へデータを読み取ります。このサンプル ファイルには、2 つの異なる学校に通う生徒 10 人のテストの得点が含まれています。出力 table には、数値データをもつ変数とテキスト データをもつ他の変数が含まれます。これらの変数の 1 つ School は、固定されたセットの値、つまりカテゴリをもっています。これらのカテゴリは、この table 内の 2 つの生徒グループを表します。School を categorical 変数に変換します。

scores = readtable("testScores.csv","TextType","string");
scores.School = categorical(scores.School)
scores=10×5 table
     LastName       School      Test1    Test2    Test3
    __________    __________    _____    _____    _____

    "Jeong"       XYZ School     90       87       93  
    "Collins"     XYZ School     87       85       83  
    "Torres"      XYZ School     86       85       88  
    "Phillips"    ABC School     75       80       72  
    "Ling"        ABC School     89       86       87  
    "Ramirez"     ABC School     96       92       98  
    "Lee"         XYZ School     78       75       77  
    "Walker"      ABC School     91       94       92  
    "Garcia"      ABC School     86       83       85  
    "Chang"       XYZ School     79       76       82

各テストの平均点を学校別に計算します。変数 Test1、Test2、および Test3 は、データを含む数値変数です。変数 School はグループ化変数です。グループ化変数を指定すると、その一意の値により、データ変数内の対応する値が属するグループが指定されます。

vars = ["Test1","Test2","Test3"];
meanScoresBySchool = varfun(@mean, ...
                            scores, ...
                            "InputVariables",vars, ...
                            "GroupingVariables","School")
meanScoresBySchool=2×5 table
      School      GroupCount    mean_Test1    mean_Test2    mean_Test3
    __________    __________    __________    __________    __________

    ABC School        5            87.4            87          86.8   
    XYZ School        5              84          81.6          84.6

出力 meanScoresBySchool には、そのグループに含まれる入力 table scores からのエントリ数を示す GroupCount という変数も含まれています。

ライブ スクリプトを開く

サンプル データを含む timetable を作成します。行時間は重複することがあるため、timetable の行時間でもグループを定義できます。

Timestamps = datetime(2023,1,1)+days([0 1 1 2 3 3])';
A = timetable(Timestamps, ...
              [0.71;-2.05;-0.35;-0.82;1.57;0.09], ...
              [0.23;0.12;-0.18;0.23;0.41;0.02], ...
              'VariableNames',["x","y"])
A=6×2 timetable
    Timestamps       x        y  
    ___________    _____    _____

    01-Jan-2023     0.71     0.23
    02-Jan-2023    -2.05     0.12
    02-Jan-2023    -0.35    -0.18
    03-Jan-2023    -0.82     0.23
    04-Jan-2023     1.57     0.41
    04-Jan-2023     0.09     0.02

timetable 内の変数の平均値を計算します。行時間のベクトルをグループ化変数として指定します。入力 A が timetable であるため、出力 B は timetable です。行時間のベクトルをグループ化変数として指定すると、いずれの変数も別のグループ化変数として指定できません。

B = varfun(@mean,A,"GroupingVariables","Timestamps")
B=4×3 timetable
    Timestamps     GroupCount    mean_x    mean_y
    ___________    __________    ______    ______

    01-Jan-2023        1          0.71      0.23 
    02-Jan-2023        2          -1.2     -0.03 
    03-Jan-2023        1         -0.82      0.23 
    04-Jan-2023        2          0.83     0.215

入力引数

すべて折りたたむ

関数。関数ハンドルとして指定します。既存の関数のハンドルを指定するか、ファイルで関数を定義するか、無名関数として指定できます。func が複数の関数ファイルに対応している場合 (つまり、func がオーバーロードされた関数セットを表す場合)、MATLAB® は入力引数のクラスに基づいて呼び出す関数を決定します。

関数 func が入力引数を 1 つ取り、この関数が呼び出されるたびに異なる行数の配列を返す場合、名前と値の引数 "OutputFormat","cell" を使用します。それ以外の場合、func は、同じ行数の配列を返さなければなりません。

例: func = @sum; は、入力の和を計算します。

例: func = @(x) x.^2; は、入力の各要素の二乗を計算します。

入力テーブル。table または timetable として指定します。

名前と値の引数

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

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

例: InputVariables=["Var2","Var3"] は、A の Var2 および Var3 という名前の変数のみを func への入力として使用します。

func に渡す A の変数を選択する指定子。"InputVariables" と、正の整数、正の整数のベクトル、string 配列、文字ベクトル、文字ベクトルの cell 配列、pattern スカラー、logical ベクトル、または関数ハンドルとして指定します。

"InputVariables" を関数ハンドルとして指定する場合、この関数ハンドルは logical スカラーを返さなければならず、varfun は関数が 1 (true) を返した A 内の変数のみを渡します。

グループ化変数にする A の変数を選択する指定子。"GroupingVariables" と、正の整数、正の整数のベクトル、string 配列、文字ベクトル、文字ベクトルの cell 配列、pattern スカラー、または logical ベクトルとして指定します。

グループ化変数の一意の値によってグループを指定します。A 内の行は、グループ化変数の値が同じであれば、同じグループに属します。varfun は、変数全体ではなく、A の残りの各変数内の行のグループごとに func を適用します。グループ化変数を使用した計算の詳細については、データ グループに対する計算を参照してください。

グループ化変数は、表にリストされているデータ型のいずれかにすることができます。

グループを指定する値

グループ化変数のデータ型

数字

数値または logical ベクトル

テキスト

string 配列または文字ベクトルの cell 配列

日付と時刻

datetime、duration または calendarDuration ベクトル

カテゴリ

categorical ベクトル

ビン

ビン化された値のベクトル。数値、datetime または duration 値の連続分布をビン化することによって作成される

いずれかのグループ化変数に NaN または欠損値 (NaT、未定義の categorical 値、欠損 string など) が含まれている場合、それに対応する行はどのグループにも属さず、出力から除外されます。

行ラベルはグループ化変数にすることができます。行ラベルのみ、A 内の 1 つ以上の変数、または行ラベルと変数を同じグループにすることができます。

  • A が table の場合、ラベルは行名です。

  • A が timetable の場合、ラベルは行時間です。

出力 B には、入力 A の行のグループごとに 1 つの行があります。B が table または timetable の場合、B は以下をもちます。

  • func が適用された入力 table 変数に対応する変数。

  • グループ化変数に対応する変数。

  • 新しい変数 GroupCount。その値は、各グループ内の入力 A の行数です。

メモ: B が timetable の場合、B は以下ももちます。

  • 行時間。A の各行グループの最初の行時間が、B の対応する行時間です。B を行時間のない table として返すには、"OutputFormat" を "table" として指定します。

B の形式。"OutputFormat" と、"auto"、"table"、"timetable"、"uniform"、または "cell" の値として指定します。

"auto" (既定) (R2023a 以降)

varfun は、入力 A のデータ型に一致するデータ型をもつ出力を返します。

"table"

varfun は A の各変数 (または "InputVariables" で指定した各変数) に 1 つの変数を含む table を返します。グループ化された計算の場合、B にはグループ化変数および新しい変数 GroupCount も含まれます。

"table" では、A の異なる変数に対して、異なるサイズまたはデータ型の値を返す関数を使用できます。ただし、グループ化解除された計算の場合、func は呼び出されるたびに同じ行数の配列を返さなければなりません。グループ化された計算の場合、func は指定されたグループに対して呼び出されるたびに、同じ行数の値を返さなければなりません。

A が table の場合、これは既定の出力形式です。

"timetable"

varfun は A の各変数 (または "InputVariables" で指定した各変数) に 1 つの変数を含む timetable を返します。グループ化された計算の場合、B にはグループ化変数および新しい変数 GroupCount も含まれます。

varfun は、A の行時間から B の行時間を作成します。B に割り当てられた行時間が func を使用して実行される計算のコンテキストにおいて意味を成さない場合、出力形式を "OutputFormat","table" として指定します。

A が timetable の場合、これが既定の出力形式です。

"uniform"

varfun は、出力値をベクトルに連結します。func は、呼び出されるたびに同じデータ型をもつスカラーを返さなければなりません。

"cell"

varfun は出力を cell 配列として返します。"cell" では、異なるサイズまたはデータ型の値を返す関数を使用できます。

func が失敗した場合に呼び出す関数。"ErrorHandler" と関数ハンドルとして指定します。この関数を定義して、エラーを再スローするか、関数 func に対して有効な出力を返すようにします。

MATLAB は、以下の 2 つの入力引数を使用して、指定されたエラー処理関数を呼び出します。

  • 構造体には以下のフィールドがあります。

    identifier

    エラー識別子。

    message

    エラー メッセージ テキスト。

    index

    エラーが発生した変数のインデックス。

    name

    エラーが発生した変数の名前。

  • エラー発生時の関数 func への入力引数の集合。

以下に例を示します。

function [A, B] = errorFunc(S, varargin)
warning(S.identifier, S.message)
A = NaN; B = NaN;

出力引数

すべて折りたたむ

出力値。table、timetable、cell 配列、またはベクトルとして返されます。

B が table または timetable の場合、説明、変数の単位、変数名、行名などのメタデータを格納できます。詳細については、table または timetable のプロパティの節を参照してください。

詳細

すべて折りたたむ

データ グループに対する計算

データ解析では、データ グループに対して計算を実行するのが一般的です。このような計算では、1 つ以上のデータ変数をデータ グループに分割し、各グループに対して計算を実行し、結果を 1 つ以上の出力変数に結合します。1 つ以上の "グループ化変数" を使用してグループを指定できます。グループ化変数の一意の値は、データ変数の対応する値が属するグループを定義します。

たとえばこの図は、6 行 1 列の数値ベクトルを 2 つのデータ グループに分け、各グループの平均を計算し、その出力を 2 行 1 列の数値ベクトルにまとめる単純なグループ化計算を示しています。6 行 1 列のグループ化変数には、AB と XYZ の 2 つの一意の値があります。

Calculation that splits a data variable based on a grouping variable, performs calculations on individual groups of data by applying the same function, and then concatenates the outputs of those function calls

数値、テキスト、日時、カテゴリ、またはビンをもつグループ化変数を指定できます。

拡張機能

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

バージョン履歴

R2013b で導入

すべて展開する

参考

| | | | | | | |

トピック