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

cummax

累積最大値

構文

M = cummax(A)

M = cummax(A,dim)

M = cummax(___,direction)

M = cummax(___,nanflag)

説明

M = cummax(A) は、A の要素の累積最大値を返します。既定では、cummax(A) はサイズが 1 でない最初の配列次元に沿って演算を行います。

• A がベクトルの場合、cummax(A) は、A の累積最大値が格納された同じサイズのベクトルを返します。

• A が行列の場合、cummax(A) は、A の各列の累積最大値が格納された同じサイズの行列を返します。

• A が多次元配列の場合、cummax(A) は、A のサイズが 1 でない最初の配列次元に沿って累積最大値が格納された同じサイズの配列を返します。

M = cummax(A,dim) は、次元 dim に沿って累積最大値を返します。たとえば A が行列の場合、cummax(A,2) は A の行に沿って累積最大値を返します。

M = cummax(___,direction) は、前述の任意の構文を使用して、オプションで方向を指定します。A の指定は必須です。dim はオプションで指定できます。たとえば cummax(A,2,'reverse') は、A の 2 番目の次元の末尾から先頭の方向に演算を行い、A の累積最大値を返します。

M = cummax(___,nanflag) は、前述の任意の構文について NaN 値を計算に含めるか省略するかを指定します。cummax(A,'includenan') ではすべての NaN 値が計算に含められ、cummax(A,'omitnan') ではこれらが無視されます。

例

ベクトルの値の累積最大値

ランダムな整数から成る 1 行 10 列のベクトルの累積最大値を求めます。

v = randi(10,1,10)

v = 1×10

     9    10     2    10     7     1     3     6    10    10

M = cummax(v)

M = 1×10

     9    10    10    10    10    10    10    10    10    10

行列の列の値の累積最大値

3 行 3 列の行列の列の累積最大値を求めます。

A = [3 5 2; 1 6 3; 7 8 1]

A = 3×3

     3     5     2
     1     6     3
     7     8     1

M = cummax(A)

M = 3×3

     3     5     2
     3     6     3
     7     8     3

行列の行の値の累積最大値

3 行 3 列の行列の行の累積最大値を求めます。

A = [3 5 2; 1 6 3; 7 8 1]

A = 3×3

     3     5     2
     1     6     3
     7     8     1

M = cummax(A,2)

M = 3×3

     3     5     5
     1     6     6
     7     8     8

配列の値の逆方向の累積最大値

2 x 2 x 3 の配列で 3 番目の次元の累積最大値を計算します。direction を 'reverse' に指定して、3 番目の次元の末尾から先頭の方向に演算を行います。

A = cat(3,[1 2; 3 4],[9 10; 11 12],[5 6; 7 8])

A = 
A(:,:,1) =

     1     2
     3     4


A(:,:,2) =

     9    10
    11    12


A(:,:,3) =

     5     6
     7     8

M = cummax(A,3,'reverse')

M = 
M(:,:,1) =

     9    10
    11    12


M(:,:,2) =

     9    10
    11    12


M(:,:,3) =

     5     6
     7     8

NaN 値を含むベクトル

NaN 値を含むベクトルを作成し、累積最大値を計算します。既定では、cummax は NaN 値を無視します。

A = [3 5 NaN 9 0 NaN];
M = cummax(A)

M = 1×6

     3     5     5     9     9     9

NaN 値を計算に含めた場合、A 内の最初の NaN 値が検出されるとすぐに、累積最大値は NaN になります。

M = cummax(A,'includenan')

M = 1×6

     3     5   NaN   NaN   NaN   NaN

入力引数

A — 入力配列

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

入力配列。ベクトル、行列または多次元配列として指定します。要素が複素数の場合、cummax はそれらの大きさを比較します。大きさが等しければ、cummax はさらに位相角を比較します。

データ型: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | logical | duration
複素数のサポート: あり

dim — 演算の対象の次元

正の整数スカラー

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

2 次元の入力配列 A について考えます。

• cummax(A,1) は、A の列の連続する要素について演算を行い、各列の累積最大値を含む A と同じサイズの配列を返します。

  

• cummax(A,2) は、A の行の連続する要素について演算を行い、各行の累積最大値を含む A と同じサイズの配列を返します。

  

dim が ndims(A) より大きい場合、cummax は A を返します。

direction — 累積の方向

'forward' (既定値) | 'reverse'

累積の方向。'forward' (既定値) または 'reverse' として指定します。

• 'forward' は、アクティブな次元の 1 から end の方向に演算を行います。

• 'reverse' は、アクティブな次元の end から 1 の方向に演算を行います。

データ型: char

nanflag — NaN の条件

'omitnan' (既定値) | 'includenan'

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

• 'omitnan' — 入力にあるすべての NaN 値を無視します。入力の先頭に連続した NaN 値がある場合、cummax は出力の対応する要素に NaN を返します。たとえば、cummax([NaN 7 13 6],'omitnan') は行ベクトル [NaN 7 13 13] を返します。

• 'includenan' — 累積最大値の計算時に入力の NaN 値を含み、結果として NaN 値が出力されます。

データ型: char

出力引数

M — 累積最大値

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

累積最大値。ベクトル、行列または多次元配列として返されます。M のサイズとデータ型は A と同じになります。

ヒント

• 多くの累積関数では、'reverse' オプションを使用することで、入力配列の反転や鏡映を行わなくても、逆方向の計算を簡単に実行できます。

拡張機能

tall 配列

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

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

'reverse' 方向はサポートされていません。

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

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

GPU 配列

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

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

• nanflag 引数はサポートされていません。

詳細については、GPU での MATLAB 関数の実行 (Parallel Computing Toolbox)を参照してください。

分散配列

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

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

• nanflag 引数はサポートされていません。

詳細については、分散配列を使用した MATLAB 関数の実行 (Parallel Computing Toolbox)を参照してください。

参考

cummin | cumprod | cumsum | max | min | movmax

R2014b で導入