Main Content

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

入力引数と出力引数

可変長引数リストのサポート、引数のチェック、検証についての引数の宣言

関数は、単一の関数シグネチャを使用して、可変数の入力と出力を受け入れることができます。MATLAB® には入力の数、型、サイズ、その他の要素をチェックするためにいくつかの手法が備わっており、関数が想定どおりに必ず実行され、入力が有効でない場合には有用なエラー メッセージが提示されるようにします。

関数

すべて展開する

nargin関数の入力引数の数
nargout関数の出力引数の数
varargin可変長の入力引数のリスト
varargout可変長の出力引数の一覧
narginchk有効な入力引数の数のチェック
nargoutchk有効な出力引数の数のチェック
validateattributes配列の有効性をチェック
validatestringテキストの有効性をチェック
inputParser関数の入力パーサー
inputname関数入力の変数名
mfilename現在実行中のコードのファイル名

引数ブロック

arguments関数の引数の検証を宣言
namedargs2cell名前と値のペアを含む構造体の cell 配列への変換

検証関数

mustBeFinite値が有限であることを検証し、そうでない場合はエラーを発行
mustBeGreaterThan値が別の値より大きいことを検証し、そうでない場合はエラーを発行
mustBeGreaterThanOrEqual値が別の値以上であることを検証し、そうでない場合はエラーを発行
mustBeInteger値が整数であることを検証し、そうでない場合はエラーを発行
mustBeLessThan値が別の値より小さいことを検証し、そうでない場合はエラーを発行
mustBeLessThanOrEqual値が別の値以下であることを検証し、そうでない場合はエラーを発行
mustBeMember値が指定集合のメンバーであることを検証
mustBeNegative値が負であることを検証し、そうでない場合はエラーを発行
mustBeNonempty値が空でないことを検証し、そうでない場合はエラーを発行
mustBeNonNan値が NaN でないことを検証
mustBeNonnegative値が非負であることを検証し、そうでない場合はエラーを発行
mustBeNonpositive値が非正であることを検証し、そうでない場合はエラーを発行
mustBeNonsparse値が非スパースであることを検証し、そうでない場合はエラーを発行
mustBeNonzero値が非ゼロであることを検証し、そうでない場合はエラーを発行
mustBeNumeric値が数値であることを検証し、そうでない場合はエラーを発行
mustBeNumericOrLogical値が数値または logical であることを検証し、そうでない場合はエラーを発行
mustBePositive値が正であることを検証し、そうでない場合はエラーを発行
mustBeReal値が実数であることを検証し、そうでない場合はエラーを発行

トピック

引数の数のチェック

関数の引数の数の確認

narginnargout を使用して、関数が受け取る入出力引数の数を判定します。

可変長の入力のサポート

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

可変長の出力のサポート

varargout を使って可変長の出力引数を返す関数を定義します。出力 varargout は関数出力が含まれた cell 配列で、各出力は別々のセルに入っています。

関数の引数の個数の検証

カスタム関数が受け取っている入出力引数の個数が有効かどうかをチェックします。MATLAB では一部の引数のチェックが自動的に行われます。それ以外の場合は narginchk または nargoutchk を使用することができます。

入れ子関数での引数チェック

vararginvarargoutnargin および nargout を入れ子関数と共に使用する場合、特別な考慮事項があります。

関数入力の無視

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

関数出力の無視

この例では、関数から特定の出力を要求する方法を示します。

入力引数の解析

関数入力の解析

入力引数の有効性をチェックするための手法を選択する。

関数の引数の検証

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

validateattributes での関数入力のチェック

この例では、関数 validateattributes を使用して、関数への入力が一連の必要条件に従っているかどうかを確認する方法を示します。

関数入力の解析

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