mean

配列の平均値

構文

M = mean(A)

M = mean(A,"all")

M = mean(A,dim)

M = mean(A,vecdim)

M = mean(___,outtype)

M = mean(___,missingflag)

M = mean(___,Weights=W)

説明

M = mean(A) は、サイズが 1 に等しくない最初の配列の次元に沿った A の要素の平均値を返します。

• A がベクトルの場合、mean(A) は要素の平均値を返します。

• A が行列の場合、mean(A) は各列の平均値を含む行ベクトルを返します。

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

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

M = mean(A,"all") は、A のすべての要素の平均値を返します。

M = mean(A,dim) は、次元 dim に沿って平均値を返します。たとえば、A が行列の場合、mean(A,2) は各行の平均値をもつ列ベクトルを返します。

M = mean(A,vecdim) は、ベクトル vecdim で指定した次元に基づいて平均値を返します。たとえば、A が行列の場合、行列内の各要素は次元 1 と次元 2 で定義された配列スライスに含まれるため、mean(A,[1 2]) は A のすべての要素の平均値を返します。

M = mean(___,outtype) は前述の構文のいずれかで指定されたデータ型の平均値を返します。outtype は "default"、"double" または "native" になります。

M = mean(___,missingflag) は、A の欠損値を含めるか省略するかを指定します。たとえば、mean(A,"omitmissing") は平均値の計算時にすべての欠損値を無視します。既定では、mean は欠損値を含めます。

M = mean(___,Weights=W) は、重み付けスキーム W を指定し、加重平均を返します。 (R2024a 以降)

例

行列の列の平均値

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

A = [0 1 1; 2 3 2; 1 3 2; 4 2 2]

A = 4×3

     0     1     1
     2     3     2
     1     3     2
     4     2     2

M = mean(A)

M = 1×3

    1.7500    2.2500    1.7500

行列の行の平均値

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

A = [0 1 1; 2 3 2; 3 0 1; 1 2 3]

A = 4×3

     0     1     1
     2     3     2
     3     0     1
     1     2     3

M = mean(A,2)

M = 4×1

    0.6667
    2.3333
    1.3333
    2.0000

3 次元配列の平均値

1 ～ 10 の整数値の 4×2×3 の配列を作成し、2 番目の次元に沿って平均値を計算します。

rng('default')
A = randi(10,[4,2,3]);
M = mean(A,2)

M = 
M(:,:,1) =

    8.0000
    5.5000
    2.5000
    8.0000


M(:,:,2) =

   10.0000
    7.5000
    5.5000
    6.0000


M(:,:,3) =

    6.0000
    5.5000
    8.5000
   10.0000

配列ページの平均値

3 次元配列を作成し、データの各ページ (行と列) ごとの平均値を計算します。

A(:,:,1) = [2 4; -2 1];
A(:,:,2) = [9 13; -5 7];
A(:,:,3) = [4 4; 8 -3];
M1 = mean(A,[1 2])

M1 = 
M1(:,:,1) =

    1.2500


M1(:,:,2) =

     6


M1(:,:,3) =

    3.2500

配列のすべての次元の平均値を計算するには、ベクトルの次元引数で各次元を指定するか、"all" オプションを使用します。

M2 = mean(A,[1 2 3])

M2 = 
3.5000

Mall = mean(A,"all")

Mall = 
3.5000

単精度配列の平均値

1 の単精度ベクトルを作成し、その単精度平均値を計算します。

A = single(ones(10,1));
M = mean(A,"native")

M = single

1

結果も単精度になります。

class(M)

ans = 
'single'

欠損値を除外した平均値

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 値が含まれている行列の列では、mean は NaN 以外の要素で計算します。すべて NaN 値の行列の列では、平均値は NaN です。

M = mean(A,"omitnan")

M = 1×4

    1.7700    0.1675       NaN   -1.3800

加重平均

R2024a 以降

行列を作成し、W で指定される重み付けスキームに従って行列の加重平均を計算します。関数 mean は、A の各列に重み付けスキームを適用します。

A = [1 1; 7 9; 1 9; 1 9; 6 2];
W = [1 2 1 2 3]';
M = mean(A,Weights=W)

M = 1×2

    4.0000    5.7778

入力引数

A — 入力データ

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

入力データ。ベクトル、行列、多次元配列、table または timetable として指定します。

• A がスカラーの場合、mean(A) は A を返します。

• A が 0 行 0 列の空の行列である場合、mean(A) は NaN を返します。

データ型: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | logical | datetime | duration | table | timetable

dim — 演算の対象の次元

正の整数スカラー

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

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

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

• mean(A,1) は、A の各列における要素の平均値を計算し、1 行 n 列の行ベクトルを返します。

  

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

  

mean は、dim が ndims(A) より大きいか、size(A,dim) が 1 である場合に A を返します。

vecdim — 次元のベクトル

正の整数のベクトル

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

2×3×3 の入力データ A を考えます。mean(A,[1 2]) は 1×1×3 の配列を返します。この配列の要素は、A の各ページの平均値です。

outtype — 出力データ型

"default" (既定値) | "double" | "native"

出力データ型。次の表の値のいずれかとして指定します。これらのオプションにより、演算の実行に使用されるデータ型も指定されます。

outtype	出力データ型
"default"	double。ただし、入力データ型が single、duration、datetime、table、または timetable の場合は出力が "native" になります。
"double"	double。ただし、データ入力型が duration、datetime、table、または timetable の場合、"double" はサポートされません。
"native"	次の場合を除き、入力と同じデータ型です。 入力データ型が double の場合、出力は logical になります。 入力データ型が char の場合、"native" はサポートされません。 入力データ型が table の場合、出力は timetable になります。

missingflag — 欠損値の条件

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

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

値	入力データ型	説明
"includemissing"	サポートされているすべてのデータ型	平均値の計算時に A の欠損値を含めます。操作次元のいずれかの要素がない場合、M の対応する要素がありません。
"includenan"	double, single, duration
"includenat"	datetime
"omitmissing"	サポートされているすべてのデータ型	A の欠損値を無視し、点の数を減らして平均値を計算します。操作次元のすべての要素がない場合、M の対応する要素がありません。
"omitnan"	double, single, duration
"omitnat"	datetime

W — 重み付けスキーム

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

R2024a 以降

重み付けスキーム。ベクトル、行列、または多次元配列として指定します。W の要素は非負でなければなりません。

重み付けスキームを指定すると、mean は加重平均を返します。これは、入力データの値の重要度がそれぞれ異なる場合や入力データに歪みがある場合に便利です。

W がベクトルの場合、操作次元と同じ長さでなければなりません。それ以外の場合、W は入力データと同じサイズでなければなりません。

入力データ A が table または timetable の場合、W はベクトルでなければなりません。

この引数は、vecdim または "all" を指定する場合は指定できません。

データ型: double | single

詳細

平均

N 個のスカラーの観測値からなる有限長ベクトル A の平均は、次のように定義されます。

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

加重平均

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

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

拡張機能

tall 配列

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

mean 関数は tall 配列をサポートしていますが、以下の使用上の注意および制限があります。

• 整数型に対しては "native" 出力データ型オプションはサポートされません。

• 名前と値の引数 Weights はサポートされていません。

詳細については、tall 配列を参照してください。

C/C++ コード生成

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

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

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

• 整数データ型に対しては、コード生成で "native" 出力データ型オプションはサポートされません。

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

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

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

GPU コード生成

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

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

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

• outtype オプションと missingflag オプションは定数の文字ベクトルまたは string でなければなりません。

• 整数型は "native" 出力データ型オプションをサポートしません。

• 名前と値の引数 Weights はサポートされていません。

スレッドベースの環境

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

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

GPU 配列

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

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

分散配列

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

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

バージョン履歴

R2006a より前に導入

R2024b: datetime データ型の加重平均の計算

datetime データ型の入力データの加重平均を計算できます。R2024b より前では、このデータ型の非加重平均のみを計算できました。

R2024a: 加重平均の計算

Weights パラメーターを重み付けスキームとして指定して加重平均を計算します。数値、logical、および duration データ型の入力データの加重平均を計算できます。

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

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

R2023a: 欠損値の条件の指定

"includemissing" オプションまたは "omitmissing" オプションを使用して、平均値の計算時に入力データのすべての欠損値を含めるか省略します。以前は、"includenan"、"omitnan"、"includenat"、および "omitnat" により、入力データのデータ型に固有の欠損値条件を指定していました。

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

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

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

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

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

R2022b: 0.91 秒

R2023a: 0.41 秒

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

timeit(@timingMean)

R2018b: 複数の次元での演算

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

参考

関数

• median | mode | std | var | sum