11.9.1 Validating the number of Arguments

Last-modified: 2025-03-22 (土) 21:25:51

11.9.1 引数の数の検証

Octave では、関数定義の先頭に次の慣用句が頻繁に見られます。

if (nargin < min_#_inputs || nargin > max_#_inputs)
 print_usage ();
endif

入力数が間違っている場合は関数の実行を停止し、関数を呼び出す正しい方法に関するメッセージを出力します。

同様のエラー チェックはnarginchkおよび によって提供されますnargoutchk。

: narginchk (minargs, maxargs)

入力引数の数が正しいかどうかを確認します。

呼び出し関数の引数の数がminargsとmaxargs の範囲外の場合はエラー メッセージを生成します。それ以外の場合は何もしません。

minargsとmaxargs は両方ともスカラー数値である必要があります。ゼロ、無限大、および負の値はすべて許可され、minargsと maxargs は同じでもかまいません。

この関数はnargin呼び出し元で評価されることに注意してください。

See also: nargoutchk, error, nargout, nargin.

: nargoutchk (minargs, maxargs)

: msgstr = nargoutchk (minargs, maxargs, nargs)

: msgstr = nargoutchk (minargs, maxargs, nargs, "string")

: msgstruct = nargoutchk (minargs, maxargs, nargs, "struct")

出力引数の数が正しいかどうかを確認します。

最初の形式では、引数の数がminargsとmaxargsの間にない場合はエラーを返します 。それ以外の場合は何もしません。この関数は呼び出し元の の値を評価するためnargout、その値は改ざんされていない必要があることに注意してください。

minargsとmaxargs は両方とも数値スカラーである必要があります。ゼロ、無限大、負の値はすべて有効であり、同じ値を持つことができます。

下位互換性のため、他の形式では、要求された出力数が無効な場合に適切なエラー メッセージ文字列 (または構造体) が返されます。

これは、関数に提供される出力引数の数が許容範囲内であるかどうかを確認するのに役立ちます。

See also: narginchk, error, nargout, nargin.