Main Content

このページの内容は最新ではありません。最新版の英語を参照するには、ここをクリックします。

引数の定義

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

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

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

関数

すべて展開する

Arguments ブロック

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

数値の検証

mustBePositive値が正であることを検証
mustBeNonpositive値が非正であることを検証
mustBeNonnegative値が非負であることを検証
mustBeNegative値が負であることを検証
mustBeFinite値が有限であることを検証
mustBeNonNan値が NaN でないことを検証
mustBeNonzero値が非ゼロであることを検証
mustBeNonsparse値が非スパースであることを検証
mustBeSparseValidate that value is sparse (R2023b 以降)
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関数の入力パーサー

トピック

引数の検証

引数の数

パススルー入力

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