max

配列の最大要素

構文

M = max(A)

M = max(A,[],"all")

M = max(A,[],dim)

M = max(A,[],vecdim)

M = max(A,[],___,missingflag)

[M,I] = max(___)

[M,I] = max(A,[],___,"linear")

C = max(A,B)

C = max(A,B,missingflag)

___ = max(___,"ComparisonMethod",method)

説明

M = max(A) は、配列の最大要素を返します。

• A がベクトルの場合、max(A) は A の最大値を返します。

• A が行列の場合、max(A) は A の各列の最大値を含む行ベクトルになります。

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

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

M = max(A,[],"all") は、A のすべての要素の最大値を検索します。

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

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

M = max(A,[],___,missingflag) は、前述のすべての構文で A の欠損値を省略するか含めるかを指定します。たとえば、max(A,[],"includemissing") は最大値の計算時にすべての欠損値を含めます。既定では、max は欠損値を省略します。

また、[M,I] = max(___) は、A の最大値の最初の出現箇所に対応する操作次元へのインデックスも返します。

[M,I] = max(A,[],___,"linear") は A の最大値に対応する A への線形インデックスも返します。

C = max(A,B) は、A または B から得た最大要素からなる配列を返します。

C = max(A,B,missingflag) は、欠損値を処理する方法も指定します。

___ = max(___,"ComparisonMethod",method) は、前述のいずれかの構文で要素を比較する方法をオプションで指定します。たとえば、ベクトル A = [-1 2 -9] について、構文 max(A,[],"ComparisonMethod","abs") とすると、A の要素の絶対値が比較されて最大値 -9 が返されます。

例

ベクトルの最大要素

ベクトルを作成してその最大要素を計算します。

A = [23 42 37 18 52];
M = max(A)

M = 
52

複素数の最大要素

複素数ベクトルを作成してその最大要素、つまり最大の大きさをもつ要素を計算します。

A = [-2+2i 4+i -1-3i];
max(A)

ans = 
4.0000 + 1.0000i

行列の各列の最大要素

行列を作成し、その各列にある最大要素を計算します。

A = [2 8 4; 7 3 9]

A = 2×3

     2     8     4
     7     3     9

M = max(A)

M = 1×3

     7     8     9

行列の各行の最大要素

行列を作成し、その各行にある最大要素を計算します。

A = [1.7 1.2 1.5; 1.3 1.6 1.99]

A = 2×3

    1.7000    1.2000    1.5000
    1.3000    1.6000    1.9900

M = max(A,[],2)

M = 2×1

    1.7000
    1.9900

配列ページの最大値

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

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

M1 = 
M1(:,:,1) =

     4


M1(:,:,2) =

    13


M1(:,:,3) =

     8

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

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

M2 = 
13

Mall = max(A,[],"all")

Mall = 
13

欠損値を含めた最大要素

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 になります。

M = max(A,[],"includemissing")

M = 1×4

       NaN    0.3400       NaN    0.1900

最大要素のインデックス

行列 A を作成し、各列の最大要素と、それらの要素が現れる A の行インデックスを計算します。

A = [1 9 -2; 8 4 -5]

A = 2×3

     1     9    -2
     8     4    -5

[M,I] = max(A)

M = 1×3

     8     9    -2

I = 1×3

     2     1     1

線形インデックスを返す

行列 A を作成して行列 M で各行の最大値を返します。"linear" オプションを使用して、M = A(I) となる線形インデックス I も返します。

A = [1 2 3; 4 5 6]

A = 2×3

     1     2     3
     4     5     6

[M,I] = max(A,[],2,"linear")

M = 2×1

     3
     6

I = 2×1

     5
     6

maxvals = A(I)

maxvals = 2×1

     3
     6

最大要素の比較

行列を作成し、その各要素とスカラー値を比較して大きい方の値を返します。

A = [1 7 3; 6 2 9]

A = 2×3

     1     7     3
     6     2     9

B = 5;
C = max(A,B)

C = 2×3

     5     7     5
     6     5     9

入力引数

A — 入力配列

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

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

• A が複素数の場合、max(A) は、最大の大きさをもつ複素数を返します。大きさが等しい場合、max(A) は最大の大きさと最大の位相角をもつ値を返します。

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

• A が 0 行 0 列の空の配列の場合、max(A) も同じく空です。

A が categorical 型の場合、順序配列でなければなりません。

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

dim — 演算の対象の次元

正の整数スカラー

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

次元 dim は、長さが 1 に縮小した次元を示します。size(M,dim) は 1 ですが、size(A,dim) が 0 でない限り、他のすべての次元のサイズは変化しません。size(A,dim) が 0 である場合、max(A,dim) は A と同じサイズの空の配列を返します。

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

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

  

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

  

vecdim — 次元のベクトル

正の整数のベクトル

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

2×3×3 の入力配列 A を考えます。max(A,[],[1 2]) は、1×1×3 の配列を返します。この配列の要素は、A のページごとに計算された最大値です。

B — 追加の入力配列

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

追加の入力配列。スカラー、ベクトル、行列、多次元配列、table または timetable として指定します。入力 A と B は、同じサイズであるか、互換性のあるサイズでなければなりません (たとえば、A が M 行 N 列の行列で、B がスカラーまたは 1 行 N 列の行ベクトル)。詳細については、基本的な演算で互換性のある配列サイズを参照してください。

• A と B は、両方が配列である場合、一方が double 型でないかぎり、同じデータ型でなければなりません。どちらかが double 型の場合、もう一方の配列のデータ型は single、duration または任意の整数型になります。

• A と B が順序 categorical 配列である場合は、これらは同じ順序の同じカテゴリ セットでなければなりません。

• A または B のいずれかが table または timetable の場合、もう一方の入力は配列、table、または timetable にすることができます。

B が categorical 型の場合、順序配列でなければなりません。

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

missingflag — 欠損値の条件

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

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

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

method — 比較方法

"auto" (既定値) | "real" | "abs"

数値入力の比較方法。次の値のいずれかとして指定します。

• "auto" — 数値入力配列 A の要素を、A が実数の場合は real(A)、A が複素数の場合は abs(A) により比較します。

• "real" — 数値入力配列 A の要素を、A が実数でも複素数でも real(A) により比較します。A の要素の実数部が等しい場合、imag(A) を使用して同順位のものを並べ替えます。

• "abs" — 数値入力配列 A の要素を、A が実数でも複素数でも abs(A) により比較します。A の要素の大きさが等しい場合、区間 (-π,π] で angle(A) を使用して同順位のものを並べ替えます。

出力引数

M — 最大値

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

最大値。スカラー、ベクトル、行列、多次元配列、または table として返されます。size(M,dim) は 1 ですが、size(A,dim) が 0 でない限り、他のすべての次元のサイズは A の対応する次元のサイズと一致します。size(A,dim) が 0 である場合、M は A と同じサイズの空の配列です。

I — インデックス

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

インデックス。スカラー、ベクトル、行列、多次元配列、または table として返されます。I は最初の出力と同じサイズになります。

"linear" が指定されていない場合、I は操作次元へのインデックスです。"linear" が指定されている場合、I には最大値に対応する A の線形インデックスが含まれます。

最大要素が複数回発生する場合、I には最初に発生した値に対するインデックスが含まれます。

C — A または B の最大要素

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

A または B の最大要素。スカラー、ベクトル、行列、多次元配列、table、または timetable として返されます。C のサイズは A と B の次元の暗黙的な拡張によって決定されます。詳細については、基本的な演算で互換性のある配列サイズを参照してください。

C のデータ型は、A および B のデータ型によって次のように異なります。

• A と B のデータ型が同じ場合、C のデータ型は A および B と同じです。

• A または B のいずれかが single の場合、C は single になる。

• A と B の一方が整数データ型で、もう一方が double 型のスカラーである場合、C は整数データ型になります。

• A または B のいずれかが table または timetable の場合、C は table または timetable です。

拡張機能

tall 配列

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

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

• インデックス出力は tall table 入力ではサポートされていません。

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

C/C++ コード生成

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

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

• 実行時に 2 番目の引数として空の配列を使用するには、コード生成時に固定サイズの 0 行 0 列の配列を指定する必要があります。

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

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

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

  • 生成コードにおいて、入力配列はその全要素の虚数部の値がゼロであっても複素数のままになります。この状況では、生成コードで出力される結果が MATLAB で出力される結果と異なることがあります。ゼロ値の虚数部をもつ複素数データのコード生成 (MATLAB Coder)を参照してください。

GPU コード生成

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

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

• 実行時に 2 番目の引数として空の配列を使用するには、コード生成時に固定サイズの 0 行 0 列の配列を指定する必要があります。

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

• dim 引数を指定しない場合、コード ジェネレーターは、可変サイズであるかサイズが 1 と等しくない A の最初の次元に沿って演算を行います。

• A が複素数で、A のすべての要素の虚数部の値がゼロである場合、MATLAB^® は max(A) を呼び出す前に A を real(A) に変換することがあります。この場合、MATLAB は要素を real(A) によって比較しますが、生成されるコードでは要素が abs(A) によって比較されます。生成されるコードを MATLAB と一致させるには、max(real(A)) または max(A,'ComparisonMethod','real') を使用します。ゼロ値の虚数部をもつ複素数データのコード生成 (MATLAB Coder)を参照してください。

HDL コード生成

HDL Coder™ を使用して FPGA 設計および ASIC 設計のための VHDL、Verilog および SystemVerilog のコードを生成します。

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

• 3-D 行列以上の入力はサポートされていません。

• 複素数データ型を含む入力はサポートされていません。

• 入力行列または入力ベクトルは等しいサイズでなければなりません。

スレッドベースの環境

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

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

GPU 配列

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

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

分散配列

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

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

• インデックス出力は分散 table 入力ではサポートされていません。

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

バージョン履歴

R2006a より前に導入

R2024b: 2 番目の入力配列を文字配列として指定することはサポートされない

2 番目の入力配列を文字配列として指定すると、エラーが返されます。この変更により、欠損値の条件など、文字ベクトルとして指定できるその他の引数との混同が最小限に抑えられます。以前の機能を維持するには、2 番目の入力配列を double に変換できます (たとえば、max(A,double(B),"includenan"))。

R2023b: 2 番目の入力配列を文字配列として指定することはサポートされなくなる

2 番目の入力配列を文字配列として指定すると警告が出され、将来のリリースではエラーが生成される予定です。この変更により、欠損値の条件など、文字ベクトルとして指定できるその他の引数との混同が最小限に抑えられます。以前の機能を維持するには、2 番目の入力配列を double に変換できます (たとえば、max(A,double(B),"includenan"))。

R2023a: 欠損値の条件の指定

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

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

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

R2021b: 比較方法の指定

ComparisonMethod パラメーターを使用して、実数値または絶対値により入力の最大値を判定する方法を指定します。

R2018b: 複数の次元での演算

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

参考

関数

• maxk | bounds | min | mean | median | sort | islocalmax | clip

トピック

• 配列インデックス付け