ドキュメンテーション センター

  • 評価版
  • 製品アップデート

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

nargin

関数の入力引数の数

構文

nargin
nargin(fx)

説明

nargin は、現在実行中の関数の呼び出し時に渡された入力引数の数を返します。この nargin 構文は、関数の本体にだけ使用してください。

nargin(fx) は、関数 fx の定義ステートメント内に現れる入力引数の数を返します。この関数がその定義に varargin を含む場合は、nargin は入力数の負の数値を返します。たとえば、関数 foo が入力 ab、および varargin を宣言する場合、nargin('foo')-3 を返します。

入力引数

fx

関数ハンドルまたは関数の名前を指定する単一引用符内の文字列のいずれか。

すべて展開する

現在の関数への入力

最大 2 つの入力を受け取る addme.m という名前のファイルに関数を作成し、入力数を nargin で識別します。

function c = addme(a,b)

switch nargin
    case 2
        c = a + b;
    case 1
        c = a + a;
    otherwise
        c = 0;
end

関数に定義された入力

関数が受け取れる入力数を決定します。

上記の例で作成された関数 addme は、その宣言ステートメントに 2 つの入力をもっています (ab)。

fx = 'addme';
nargin(fx)
ans =
     2

varargin 入力をもつ関数

varargin を使用する関数が受け取れる入力数を決定します。

mynewplot.m というファイルに、varargin を使用して任意数の追加のプロット入力と、数値入力 x および y を受け取る関数を定義します。

function mynewplot(x,y,varargin)
   figure
   plot(x,y,varargin{:})
   title('My New Plot')

コマンド ラインで、newplot が受け取れる入力数をクエリします。

fx = 'mynewplot';
nargin(fx)
ans =
    -3

マイナス記号は、3 番目の入力が varargin であることを示します。関数 mynewplot は、不確定数の追加入力引数を受け取ることができます。

参考

| | | | |

この情報は役に立ちましたか?