ドキュメンテーション

最新のリリースでは、このページがまだ翻訳されていません。 このページの最新版は英語でご覧になれます。

nansum

NaN 値を無視した総和

説明

y = nansum(X) は、すべての NaN 値を削除して計算された、X の要素の sum を返します。

  • X がベクトルである場合、nansum(X)X のすべての非 NaN 要素の合計です。

  • X が行列である場合、nansum(X)NaN 値を削除して計算された、列合計の行ベクトルです。

  • X が多次元配列である場合、nansumX の大きさが 1 でない最初の次元に作用します。この次元のサイズは 1 になりますが、他の次元のサイズはすべて変化しません。nansum はすべての NaN 値を削除します。

すべてが NaN 値である配列を nansum が扱う方法については、ヒントを参照してください。

y = nansum(X,'all') は、NaN 値を削除して計算された、X のすべての要素の合計を返します。

y = nansum(X,dim) は、NaN 値を削除して計算された、X の作用次元 dim に沿った合計を返します。

y = nansum(X,vecdim) は、ベクトル vecdim で指定された次元における合計を返します。合計は、NaN 値を削除した後で計算されます。たとえば X が行列である場合、次元 1 および 2 によって定義される配列スライスには行列のそれぞれの要素がすべて含まれるため、nansum(X,[1 2])X のすべての非 NaN 要素の合計になります。

すべて折りたたむ

欠損値が含まれている行列データの列の合計を求めます。

X = magic(3);
X([1 6:9]) = NaN
X = 3×3

   NaN     1   NaN
     3     5   NaN
     4   NaN   NaN

y = nansum(X)
y = 1×3

     7     6     0

欠損値を無視して、配列内のすべての値の合計を求めます。

欠損値が含まれている 2 x 4 x 3 の配列 X を作成します。

X = reshape(1:24,[2 4 3]);
X([5:6 20]) = NaN
X = 
X(:,:,1) =

     1     3   NaN     7
     2     4   NaN     8


X(:,:,2) =

     9    11    13    15
    10    12    14    16


X(:,:,3) =

    17    19    21    23
    18   NaN    22    24

X の要素の合計を求めます。

y = nansum(X,'all')
y = 269

2 番目の次元に沿って合計を計算するよう指定することにより、欠損値が含まれている行列データの行の合計を求めます。

X = magic(3);
X([1 6:9]) = NaN
X = 3×3

   NaN     1   NaN
     3     5   NaN
     4   NaN   NaN

y = nansum(X,2)
y = 3×1

     1
     8
     4

複数の次元における多次元配列の合計を求めます。

欠損値が含まれている 2 x 4 x 3 の配列 X を作成します。

X = reshape(1:24,[2 4 3]);
X([5:6 20]) = NaN
X = 
X(:,:,1) =

     1     3   NaN     7
     2     4   NaN     8


X(:,:,2) =

     9    11    13    15
    10    12    14    16


X(:,:,3) =

    17    19    21    23
    18   NaN    22    24

作用次元として 1 番目の次元と 2 番目の次元を指定して、X の各ページの合計を求めます。

ypage = nansum(X,[1 2])
ypage = 
ypage(:,:,1) =

    25


ypage(:,:,2) =

   100


ypage(:,:,3) =

   144

たとえば、ypage(1,1,1)X(:,:,1) の非 NaN 要素の合計です。

作用次元として 2 番目の次元と 3 番目の次元を指定して、各 X(i,:,:) スライスの要素の合計を求めます。

yrow = nansum(X,[2 3])
yrow = 2×1

   139
   130

たとえば、yrow(2)X(2,:,:) の非 NaN 要素の合計です。

入力引数

すべて折りたたむ

入力データ。スカラー、ベクトル、行列または多次元配列を指定します。

X が空の配列である場合、nansum(X)0 になります。

データ型: single | double

作用する対象となる次元。正の整数スカラーを指定します。値を指定しなかった場合、サイズが 1 ではない最初の配列次元が既定値になります。

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

2 次元配列 X について考えます。

  • dim が 1 に等しい場合、nansum(X,1) は各列の合計が格納されている行ベクトルを返します。

  • dim が 2 に等しい場合、nansum(X,2) は各行の合計が格納されている列ベクトルを返します。

dimndims(X) より大きい場合、または size(X,dim) が 1 である場合、nansum は欠損値を 0 に置き換えた X を返します。

データ型: single | double

次元のベクトル。正の整数ベクトルを指定します。vecdim の各要素は、入力配列 X の次元を表します。出力 y の指定された作用次元における長さは 1 です。他の次元の長さは、Xy で同じになります。

たとえば、X が 2 x 3 x 3 の配列である場合、nansum(X,[1 2]) は 1 x 1 x 3 の配列を返します。出力配列の各要素は、X の対応するページにおける要素の合計です。

データ型: single | double

出力引数

すべて折りたたむ

合計の値。スカラー、ベクトル、行列または多次元配列として返されます。

ヒント

  • すべてが NaN 値である配列の合計を nansum が計算する場合、NaN 値が削除されると配列が空になるので、残りの要素の合計は 0 になります。出力 0 は、NaN 値の和ではありません。

代替機能

nansum の代わりに、入力引数 nanflag の値として 'omitnan' を指定して MATLAB® 関数 sum を使用できます。

拡張機能

参考

|

R2006a より前に導入