引数の定義

可変個の入力または出力の受け入れ、有効な値の確認

MATLAB^® は型なし言語のため、ほとんどの関数には引数の宣言や引数の検証は必要ありません。ただし、関数が広く利用され、入力の型やサイズなどの側面を検証して、コードが想定どおりに動作することを確認する必要がある場合、arguments ブロックを定義できます (R2019b 以降)。詳細については、関数の引数の検証を参照してください。

さらに、関数が受け取る入力または出力の数、入力変数の名前などをチェックできます。

関数

すべて展開する

引数の宣言および検証

引数ブロック

arguments 関数の引数の検証を宣言 (R2019b 以降)

数値の検証

`mustBePositive`	値が正であることを検証
`mustBeNonpositive`	値が非正であることを検証
`mustBeNonnegative`	値が非負であることを検証
`mustBeNegative`	値が負であることを検証
`mustBeFinite`	値が有限であることを検証
`mustBeNonNan`	値が NaN でないことを検証
`mustBeNonzero`	値が非ゼロであることを検証
`mustBeNonsparse`	値が非スパースであることを検証
`mustBeReal`	値が実数であることを検証
`mustBeInteger`	値が整数であることを検証
`mustBeNonmissing`	値が欠落していないことを検証 (R2020b 以降)

比較

`mustBeGreaterThan`	値が別の値より大きいことを検証
`mustBeLessThan`	値が別の値より小さいことを検証
`mustBeGreaterThanOrEqual`	値が別の値以上であることを検証
`mustBeLessThanOrEqual`	値が別の値以下であることを検証

データ型

`mustBeA`	値が指定したクラスのいずれかで取得された値であることを検証 (R2020b 以降)
`mustBeNumeric`	値が数値であることを検証
`mustBeNumericOrLogical`	値が数値または logical であることを検証
`mustBeFloat`	値が浮動小数点配列であることを検証 (R2020b 以降)
`mustBeText`	値が string 配列、文字ベクトル、または文字ベクトルの cell 配列であることを検証 (R2020b 以降)
`mustBeTextScalar`	値が単一のテキストであることを検証 (R2020b 以降)
`mustBeNonzeroLengthText`	値が非ゼロ長のテキストであることを検証 (R2020b 以降)
`mustBeUnderlyingType`	値に基となる型が指定されていることを検証 (R2020b 以降)

サイズ

`mustBeNonempty`	値が空でないことを検証
`mustBeScalarOrEmpty`	値がスカラーまたは空であることを検証 (R2020b 以降)
`mustBeVector`	値がベクトルであることを検証 (R2020b 以降)

範囲および集合メンバー

`mustBeInRange`	値が指定した範囲にあることを検証 (R2020b 以降)
`mustBeMember`	値が指定集合のメンバーであることを検証

名前

`mustBeFile`	パスがファイルを参照していることを検証 (R2020b 以降)
`mustBeFolder`	入力パスがフォルダーを参照していることを検証 (R2020b 以降)
`mustBeValidVariableName`	入力名が有効な変数名であることを検証 (R2020b 以降)

名前と値の引数の構造体

namedargs2cell 名前と値のペアを含む構造体の cell 配列への変換 (R2019b 以降)

可変長引数のリスト

入力

`varargin`	可変長の入力引数のリスト
`nargin`	関数の入力引数の数
`narginchk`	有効な入力引数の数のチェック

出力

`varargout`	可変長の出力引数の一覧
`nargout`	関数の出力引数の数
`nargoutchk`	有効な出力引数の数のチェック

追加のチェック

`validateattributes`	配列の有効性をチェック
`validatestring`	テキストの有効性をチェック
`validatecolor`	カラー値の検証 (R2020b 以降)
`inputname`	関数入力の変数名
`mfilename`	現在実行中のコードのファイル名
`inputParser`	関数の入力パーサー

トピック

引数の検証

関数の引数の検証

引数のクラスとサイズを宣言し、引数値に制限を適用する。
引数の検証関数

検証関数を使用して、引数の特定の要件を検証する。特定の引数の要件をチェックするための独自の関数を作成する。
- Use Validation Functions to Avoid Unwanted Class and Size Conversions
- 引数の検証時の関数 nargin の使用
validateattributes での関数入力のチェック
この例では、関数 validateattributes を使用して、関数への入力が一連の必要条件に従っているかどうかを確認する方法を示します。
関数入力の解析

必須の入力とオプションの入力を定義して、入力パーサーを使ってオプションの入力に既定値を代入し、カスタム関数へのすべての入力を検証します。
- 入力パーサーの検証関数

引数の数

可変長の入力のサポート
varargin を使って可変長の入力引数を受け入れる関数を定義します。varargin 引数は関数入力が含まれた cell 配列で、各入力は別々のセルに入っています。
可変長の出力のサポート
varargout を使って可変長の出力引数を返す関数を定義します。出力 varargout は関数出力が含まれた cell 配列で、各出力は別々のセルに入っています。
関数の引数の数の確認

nargin と nargout を使用して、関数が受け取る入出力引数の数を判定します。
- 関数の引数の個数の検証
- 入れ子関数での引数の数のチェック

パススルー入力

関数定義の入力の無視
事前定義された入力のセットを受け入れる関数が、その一部の入力のみを使用する場合、関数定義でチルダ (~) 演算子を使用して入力を無視します。