var

分散

構文

V = var(A)

V = var(A,w)

V = var(A,w,"all")

V = var(A,w,dim)

V = var(A,w,vecdim)

V = var(___,nanflag)

[V,M] = var(___)

説明

V = var(A) は、サイズが 1 に等しくない最初の配列の次元に沿った A の要素の分散を返します。既定では、分散は N-1 で正規化されます。N は観測値の数です。

• A が観測値のベクトルである場合、V はスカラーです。

• A が、列に確率変数をもち、行に観測値をもつ行列である場合、V は各列に対応する分散を含む行ベクトルになります。

• A が多次元配列の場合、var(A) は、サイズが 1 でない最初の配列次元に沿って演算します。要素はベクトルとして扱われます。この次元における V のサイズは 1 になりますが、他のすべての次元のサイズは A と同じです。

• A がスカラーの場合、V は 0 です。

• A が 0 行 0 列の空の配列である場合、V は NaN です。

• A が table または timetable の場合、var(A) は、各変数の分散を含む 1 行の table を返します。 (R2023a 以降)

V = var(A,w) は、重み付けスキームを指定します。w = 0 (既定) の場合、分散は N-1 で正規化されます。N は観測値の数です。w = 1 の場合、分散は観測値の数で正規化されます。w は、非負の要素を含む重みベクトルにすることもできます。この場合、w の長さは var を実行する次元の長さと等しくなければなりません。

V = var(A,w,"all") は、w が 0 または 1 の場合に A のすべての要素の分散を返します。

V = var(A,w,dim) は、次元 dim に沿った分散を返します。操作する次元を指定しながら既定の正規化を維持する場合、2 番目の引数に w = 0 を設定します。

V = var(A,w,vecdim) は、w が 0 または 1 の場合に、ベクトル vecdim で指定した次元での分散を返します。たとえば、A が行列の場合、行列内の各要素は次元 1 と次元 2 で定義された配列スライスに含まれるため、var(A,0,[1 2]) は A のすべての要素の分散を返します。

V = var(___,nanflag) は、前述のすべての構文で A の NaN 値を含めるか省略するかを指定します。たとえば、var(A,"omitnan") は分散の計算時に NaN 値を無視します。既定では、var は NaN 値を含めます。

[V,M] = var(___) は、分散の計算に使用される A の要素の平均値も返します。V が重み付け分散の場合、M は加重平均です。

例

行列の分散

行列を作成してその分散を計算します。

A = [4 -7 3; 1 4 -2; 10 7 9];
var(A)

ans = 1×3

   21.0000   54.3333   30.3333

配列の分散

3 次元配列を作成してその分散を計算します。

A(:,:,1) = [1 3; 8 4];
A(:,:,2) = [3 -4; 1 2];
var(A)

ans = 
ans(:,:,1) =

   24.5000    0.5000


ans(:,:,2) =

     2    18

分散の重みベクトルの指定

行列を作成し、重みベクトル w に従ってその分散を計算します。

A = [5 -4 6; 2 3 9; -1 1 2];
w = [0.5 0.25 0.25];
var(A,w)

ans = 1×3

    6.1875    9.5000    6.1875

分散の次元の指定

行列を作成し、最初の次元に沿ってその分散を計算します。

A = [4 -2 1; 9 5 7];
var(A,0,1)

ans = 1×3

   12.5000   24.5000   18.0000

2 番目の次元に沿って A の分散を計算します。

var(A,0,2)

ans = 2×1

     9
     4

配列ページの分散

3 次元配列を作成し、データの各ページ (行および列) での分散を計算します。

A(:,:,1) = [2 4; -2 1];
A(:,:,2) = [9 13; -5 7];
A(:,:,3) = [4 4; 8 -3];
V = var(A,0,[1 2])

V = 
V(:,:,1) =

    6.2500


V(:,:,2) =

    60


V(:,:,3) =

   20.9167

欠損値を除外した分散

NaN 値を含む行列を作成します。

A = [1.77 -0.005 NaN -2.95; NaN 0.34 NaN 0.19]

A = 2×4

    1.7700   -0.0050       NaN   -2.9500
       NaN    0.3400       NaN    0.1900

NaN 値を除外して行列の分散を計算します。NaN 値が含まれている行列の列では、var は NaN 以外の要素で計算します。すべて NaN 値の行列の列では、分散は NaN です。

V = var(A,"omitnan")

V = 1×4

         0    0.0595       NaN    4.9298

分散と平均

行列を作成して各列の分散と平均を計算します。

A = [4 -7 3; 1 4 -2; 10 7 9];
[V,M] = var(A)

V = 1×3

   21.0000   54.3333   30.3333

M = 1×3

    5.0000    1.3333    3.3333

行列を作成し、重みベクトル w に基づいて各列の重み付け分散と加重平均を計算します。

A = [5 -4 6; 2 3 9; -1 1 2];
w = [0.5 0.25 0.25];
[V,M] = var(A,w)

V = 1×3

    6.1875    9.5000    6.1875

M = 1×3

    2.7500   -1.0000    5.7500

入力引数

A — 入力配列

ベクトル | 行列 | 多次元配列 | table | timetable

入力配列。ベクトル、行列、多次元配列、table または timetable として指定します。A がスカラーの場合、var(A) は 0 を返します。A が 0 行 0 列の空の配列である場合、var(A) は NaN を返します。

データ型: single | double | table | timetable
複素数のサポート: あり

w — 重み

0 (既定値) | 1 | ベクトル

重み。次のいずれかとして指定します。

• 0 — N-1 で正規化されます。ここで、N は観測値の数です。観測値が 1 つだけの場合、重みは 1 になります。

• 1 — N で正規化されます。

• 分散が計算される A の次元に対応する、非負のスカラーの重みで構成されるベクトル。

データ型: single | double

dim — 演算の対象の次元

正の整数スカラー

演算の対象の次元。正の整数のスカラーとして指定します。次元を指定しない場合、既定値はサイズが 1 でない最初の配列次元です。

次元 dim は、長さが 1 に縮小した次元を示します。size(V,dim) は 1 ですが、他のすべての次元のサイズは変化しません。

m 行 n 列の入力行列 A を考えます。

• var(A,0,1) は、A の各列における要素の分散を計算し、1 行 n 列の行ベクトルを返します。

  

• var(A,0,2) は、A の各行における要素の分散を計算し、m 行 1 列の列ベクトルを返します。

  

dim が ndims(A) よりも大きい場合、var(A) は A と同じサイズのゼロの配列を返します。

vecdim — 次元のベクトル

正の整数のベクトル

次元のベクトル。正の整数のベクトルとして指定します。各要素は入力配列の次元を表します。指定された操作次元の出力の長さは 1 で、その他は同じままです。

2×3×3 の入力配列 A を考えます。この場合、var(A,0,[1 2]) は 1×1×3 の配列を返し、その要素は A の各ページについて計算された分散となります。

nanflag — 欠損値の条件

"includemissing" (既定値) | "includenan" | "omitmissing" | "omitnan"

欠損値の条件。次の値のいずれかとして指定します。

• "includemissing" または "includenan" — 分散の計算時に A の NaN 値を含めます。操作次元内のいずれかの要素が NaN の場合、V の対応する要素は NaN です。"includemissing" と "includenan" の動作は同じです。

• "omitmissing" または "omitnan" — A および w の NaN 値を無視し、点の数を減らして分散を計算します。操作次元内のすべての要素が NaN の場合、V の対応する要素は NaN です。"omitmissing" と "omitnan" の動作は同じです。

出力引数

V — 分散

スカラー | ベクトル | 行列 | 多次元配列 | table

分散。スカラー、ベクトル、行列、多次元配列、または table として返されます。

• A が観測値のベクトルである場合、V はスカラーです。

• A が、列に確率変数をもち、行に観測値をもつ行列である場合、V は各列に対応する分散を含む行ベクトルになります。

• A が多次元配列の場合、var(A) は、サイズが 1 でない最初の配列次元に沿って演算します。要素はベクトルとして扱われます。この次元における V のサイズは 1 になりますが、他のすべての次元のサイズは A と同じです。

• A がスカラーの場合、V は 0 です。

• A が 0 行 0 列の空の配列である場合、V は NaN です。

• A が table または timetable の場合、V は 1 行の table です。A の変数に単位が含まれている場合、V の変数にはその単位は含まれません。 (R2023a 以降)

M — 平均

スカラー | ベクトル | 行列 | 多次元配列 | table

平均。スカラー、ベクトル、行列、多次元配列、または table として返されます。

• A が観測値のベクトルである場合、M はスカラーです。

• A が、列に確率変数をもち、行に観測値をもつ行列である場合、M は各列に対応する平均を含む行ベクトルになります。

• A が多次元配列の場合、var(A) は、サイズが 1 でない最初の配列次元に沿って演算します。要素はベクトルとして扱われます。この次元における M のサイズは 1 になりますが、他のすべての次元のサイズは A と同じです。

• A がスカラーの場合、M は A と等しくなります。

• A が 0 行 0 列の空の配列である場合、M は NaN です。

• A が table または timetable の場合、M は 1 行の table です。A の変数に単位が含まれている場合、M の変数には同じ単位が含まれます。 (R2023a 以降)

V が重み付け分散の場合、M は加重平均です。

詳細

分散

N 個のスカラー観測値からなる確率変数ベクトル A の分散は、次のように定義されます。

$$V=\frac{1}{N-1}{\displaystyle \sum _{i=1}^N|A_i-\mu {|}^2}$$

ここで、μ は A の平均です。

$$\mu =\frac{1}{N}{\displaystyle \sum _{i=1}^N{A}_i}.$$

一部の分散の定義では、N - 1 の代わりに N の正規化係数が使用されます。重み 1 を指定することにより、正規化係数 N を使用して、この平均回りのサンプルの 2 次モーメントを生成できます。

分散の正規化係数に関係なく、平均は正規化係数 N をもつと仮定されます。

重み付け分散

N 個のスカラーの観測値からなる有限長ベクトル A と重み付けスキーム w では、重み付け分散は次のように定義されます。

$$V_w=\frac{{\displaystyle \sum _{i=1}^N{w}_i|A_i-{\mu }_w{|}^2}}{{\displaystyle \sum _{i=1}^N{w}_i}}$$

ここで、μ_w は A の加重平均です。

加重平均

N 個のスカラーの観測値からなる有限長ベクトル A と重み付けスキーム w に対し、加重平均は次のように定義されます。

$${\mu }_w=\frac{{\displaystyle \sum _{i=1}^N{w}_i{A}_i}}{{\displaystyle \sum _{i=1}^N{w}_i}}$$

拡張機能

tall 配列

メモリの許容量を超えるような多数の行を含む配列を計算します。

この関数は tall 配列を制限付きでサポートしています。

• 重み付けスキームをベクトルにすることはできません。

詳細については、メモリに収まらないデータの tall 配列を参照してください。

C/C++ コード生成

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

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

• 出力引数 M はコード生成でサポートされていません。

• 引数 dim、vecdim、および nanflag を使用する場合、それらの引数はコード生成時に定数でなければなりません。

• 入力引数 A では、次のようになります。

  • 次元を指定しない場合、コード ジェネレーターは、可変サイズであるかサイズが 1 と等しくない入力配列の最初の次元に沿って演算を行います。この次元がコード生成時に可変サイズで実行時に 1 になる場合、ランタイム エラーが発生することがあります。このエラーを回避するには、次元を指定します。

  • 入力配列のすべての次元がコード生成時に可変サイズである場合、この配列が実行時に空になることはありません。

GPU コード生成

GPU Coder™ を使用して NVIDIA® GPU のための CUDA® コードを生成します。

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

• 指定する場合、dim は定数でなければなりません。

• GPU コード生成は以下の構文をサポートします。

  • V = var(A)

  • V = var(A,w)

  • V = var(A,w,"all")

  • V = var(A,w,dim)

  • V = var(A,w,vecdim)

  • V = var(__,nanflag)

スレッドベースの環境

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

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

GPU 配列

Parallel Computing Toolbox™ を使用してグラフィックス処理装置 (GPU) 上で実行することにより、コードを高速化します。

var 関数は、GPU 配列を完全にサポートします。GPU 上で関数を実行するには、入力データを gpuArray (Parallel Computing Toolbox) として指定します。詳細については、GPU での MATLAB 関数の実行 (Parallel Computing Toolbox)を参照してください。

分散配列

Parallel Computing Toolbox™ を使用して、クラスターの結合メモリ上で大きなアレイを分割します。

この関数は分散配列を完全にサポートしています。詳細については、分散配列を使用した MATLAB 関数の実行 (Parallel Computing Toolbox)を参照してください。

バージョン履歴

R2006a より前に導入

R2023a: table および timetable で直接計算を実行

関数 var は、table または timetable 内のすべての変数に対して、それらの変数にアクセスするためのインデックス付けを行うことなく計算できます。すべての変数のデータ型で計算がサポートされている必要があります。詳細については、table および timetable での直接計算を参照してください。

R2023a: 欠損値の条件の指定

"includemissing" オプションまたは "omitmissing" オプションを使用して、分散の計算時に入力配列の欠損値を含めるか省略します。これらのオプションの動作はそれぞれ、"includenan" オプションおよび "omitnan" オプションと同じです。

R2023a: グループ サイズが小さい場合のパフォーマンスが向上

関数 var で、操作次元が指定されていないときに実数ベクトルに対して計算する際のパフォーマンスが向上しています。この関数での既定の操作次元の判別が、R2023a では R2022b より高速化しています。

たとえば、以下のコードでは、既定のベクトル次元に沿って分散を計算します。このコードは、以前のリリースよりパフォーマンスが約 1.6 倍高速化しました。

function timingVar
A = rand(10,1);
for i = 1:8e5
    var(A);
end
end

おおよその実行時間は以下のとおりです。

R2022b: 1.29 秒

R2023a: 0.79 秒

このコードの時間測定では、Windows^® 10、Intel^® Xeon^® CPU E5-1650 v4 (3.60 GHz) 搭載のテスト システムで、関数 timeit を使用しました。

timeit(@timingVar)

R2022a: 平均または加重平均を返す

関数 var は、2 番目の出力引数 M を使用することで、分散の計算に使用される入力要素の平均値も返せるようになりました。重み付けスキームが指定された場合、var は加重平均を返します。

R2018b: 複数の次元での演算

入力配列の複数の次元を一度に演算します。操作次元のベクトルを指定するか、"all" オプションを指定してすべての配列次元で演算を行います。

参考

corrcoef | cov | mean | std