web-dev-qa-db-ja.com

Matlabで関数パラメータのデフォルト値を設定するにはどうすればよいですか？

Matlabでデフォルトの引数を持つことは可能ですか？たとえば、ここに：

function wave(a, b, n, k, T, f, flag, fTrue=inline('0'))

真の解決策を波動関数のオプション引数にしたいと思います。可能であれば、誰でもこれを行う適切な方法を実証できますか？現在、私は上記に投稿したものを試していますが、私は得る：

??? Error: File: wave.m Line: 1 Column: 37
The expression to the left of the equals sign is not a valid target for an assignment.
matlabargumentsdefault
118
Scott

あなたが試みたようにこれを行う直接的な方法はありません。

通常のアプローチは、「可変引数」を使用して、引数の数をチェックすることです。何かのようなもの：

function f(arg1, arg2, arg3)

  if nargin < 3
    arg3 =   'some default'
  end

end

isemptyなどを使用してできるいくつかの手の込んだものがあります。これらの種類をバンドルしたいくつかのパッケージについては、Matlab centralをご覧ください。

varargin、nargchkなどを見ることができます。これらは、この種の便利な機能です。可変引数を使用すると、可変引数の最終引数を残すことができますが、これにより、一部またはすべてのデフォルト値の問題を回避できません。

145
simon

inputParser オブジェクトを使用して、デフォルトオプションの設定を処理しました。 Matlabは質問で指定したpythonのような形式を受け入れませんが、次のような関数を呼び出すことができるはずです。

wave(a,b,n,k,T,f,flag,'fTrue',inline('0'))

次のようにwave関数を定義した後：

function wave(a,b,n,k,T,f,flag,varargin)

i_p = inputParser;
i_p.FunctionName = 'WAVE';

i_p.addRequired('a',@isnumeric);
i_p.addRequired('b',@isnumeric);
i_p.addRequired('n',@isnumeric);
i_p.addRequired('k',@isnumeric);
i_p.addRequired('T',@isnumeric);
i_p.addRequired('f',@isnumeric);
i_p.addRequired('flag',@isnumeric); 
i_p.addOptional('ftrue',inline('0'),1);    

i_p.parse(a,b,n,k,T,f,flag,varargin{:});

これで、関数に渡された値はi_p.Resultsを介して利用できます。また、ftrueに渡されたパラメーターが実際にinline関数であることを検証する方法がわからなかったため、バリデーターを空白のままにしました。

57
Matt

もう少しハックの少ない方法は

function output = fun(input)
   if ~exist('input','var'), input='BlahBlahBlah'; end
   ...
end
18
Peter

はい、あなたが書いたようにできることは本当に素晴らしいことかもしれません。しかし、MATLABでは不可能です。引数のデフォルトを許可する私のユーティリティの多くは、次のように最初に明示的なチェックを使用して記述される傾向があります。

if (nargin<3) or isempty(myParameterName)
  MyParameterName = defaultValue;
elseif (.... tests for non-validity of the value actually provided ...)
  error('The sky is falling!')
end

わかりましたので、一般的に、より良い、より説明的なエラーメッセージを適用します。空の変数のチェックにより、ユーザーはデフォルトの値をとる変数のプレースホルダーとして、空の括弧のペア[]を渡すことができます。ただし、作成者はその空の引数をデフォルト値に置き換えるコードを提供する必要があります。

多くのパラメーターがあり、すべてにデフォルト引数がある、より洗練されたユーティリティーは、多くの場合、デフォルト引数にプロパティー/値ペアのインターフェースを使用します。この基本的なパラダイムは、matlabのハンドルグラフィックスツールやoptimset、odesetなどで見られます。

これらのプロパティ/値のペアを操作する手段として、完全に可変数の引数を関数に入力する方法として、vararginについて学ぶ必要があります。このようなプロパティ/値のペアを操作するユーティリティ parse_pv_pairs.m を作成（および投稿）しました。プロパティ/値のペアをmatlab構造に変換するのに役立ちます。また、各パラメーターのデフォルト値を指定することもできます。扱いにくいパラメーターのリストを構造に変換することは、MATLABでパラメーターを渡す非常に良い方法です。

10
user85109

これは、「try」を使用して関数にデフォルト値を設定する私の簡単な方法です。

function z = myfun (a,varargin)

%% Default values
b = 1;
c = 1;
d = 1;
e = 1;

try 
    b = varargin{1};
    c = varargin{2};
    d = varargin{3};
    e = varargin{4};
end

%% Calculation
z = a * b * c * d * e ;
end

よろしく！

5
Jonay Cruz

parseArgs 関数が非常に役立つことがわかりました。

3
Mr Fooz

ある時点でmatlabから削除される可能性がありますが、使用できる「ハック」もあります。関数evalは、最初にエラーが発生した場合に2番目の引数が実行される2つの引数を実際に受け入れます。

したがって、使用することができます

function output = fun(input)
   eval('input;', 'input = 1;');
   ...
end

引数のデフォルトとして値1を使用する

3
vuakko

Matlabの開発者の一人であるLorenが誰も指摘していない このブログ投稿 を混同しています。このアプローチはvararginに基づいており、複雑で複雑なif-then-elseまたはswitchのケースをすべて回避します。 少数のデフォルト値がある場合、効果はdramaticです。リンクされたブログの例を次に示します。

function y = somefun2Alt(a,b,varargin)
% Some function that requires 2 inputs and has some optional inputs.

% only want 3 optional inputs at most
numvarargs = length(varargin);
if numvarargs > 3
    error('myfuns:somefun2Alt:TooManyInputs', ...
        'requires at most 3 optional inputs');
end

% set defaults for optional inputs
optargs = {eps 17 @magic};

% now put these defaults into the valuesToUse cell array, 
% and overwrite the ones specified in varargin.
optargs(1:numvarargs) = varargin;
% or ...
% [optargs{1:numvarargs}] = varargin{:};

% Place optional args in memorable variable names
[tol, mynum, func] = optargs{:};

それでもまだわからない場合は、ローレンによるブログ投稿全体を読んでみてください。フォローアップ ブログ投稿 を書きました。これはmissing位置のデフォルト値を扱います。私はあなたが次のようなものを書くことができることを意味します：

somefun2Alt(a, b, '', 42)

epsパラメーターのデフォルトのtol値はそのままです（もちろん、funcの@magicコールバック）。ローレンのコードでは、これをわずかながらトリッキーな修正で許可しています。

最後に、このアプローチのいくつかの利点：

  1. 多くのデフォルトを使用しても、ボイラープレートコードは大きくなりません（新しいデフォルト値ごとに長くなるif-then-elseアプローチのファミリとは対照的）
  2. デフォルトはすべて1か所にあります。それらのいずれかを変更する必要がある場合は、1つの場所だけを見る必要があります。

言わせておくと、デメリットもあります。 Matlabシェルで関数を入力してそのパラメーターを忘れると、役に立たないvararginがヒントとして表示されます。それに対処するために、意味のある使用法を書くことをお勧めします。

3
alisianoi

私はこの問題に対処するための非常に気の利いた方法を見つけたと信じています（コードの折り返しを除いて）3行のコードのみを使用します。以下は、私が書いている関数から直接持ち上がったものであり、望みどおりに動作するようです：

defaults = {50/6,3,true,false,[375,20,50,0]}; %set all defaults
defaults(1:nargin-numberForcedParameters) = varargin; %overload with function input
[sigma,shifts,applyDifference,loop,weights] = ...
     defaults{:}; %unfold the cell struct

私はそれを共有すると思いました。

3
Bonnevie

ASSIGNIN （ b ）と EVALIN による この回答 に気付いた後、最終的に非常に単純な呼び出し構造を取得する関数：

setParameterDefault('fTrue', inline('0'));

リストは次のとおりです。

function setParameterDefault(pname, defval)
% setParameterDefault(pname, defval)
% Author: Tobias Kienzler (https://stackoverflow.com/users/321973)
% sets the parameter NAMED pname to the value defval if it is undefined or
% empty

if ~isParameterDefined('pname')
    error('paramDef:noPname', 'No parameter name defined!');
elseif ~isvarname(pname)
    error('paramDef:pnameNotChar', 'pname is not a valid varname!');
elseif ~isParameterDefined('defval')
    error('paramDef:noDefval', ['No default value for ' pname ' defined!']);
end;

% isParameterNotDefined copy&pasted since evalin can't handle caller's
% caller...
if ~evalin('caller',  ['exist(''' pname ''', ''var'') && ~isempty(' pname ')'])
    callername = evalin('caller', 'mfilename');
    warnMsg = ['Setting ' pname ' to default value'];
    if isscalar(defval) || ischar(defval) || isvector(defval)
        warnMsg = [warnMsg ' (' num2str(defval) ')'];
    end;
    warnMsg = [warnMsg '!'];
    warning([callername ':paramDef:assigning'], warnMsg);
    assignin('caller', pname, defval);
end

そして

function b = isParameterDefined(pname)
% b = isParameterDefined(pname)
% Author: Tobias Kienzler (https://stackoverflow.com/users/321973)
% returns true if a parameter NAMED pname exists in the caller's workspace
% and if it is not empty

b = evalin('caller',  ['exist(''' pname ''', ''var'') && ~isempty(' pname ')']) ;
2
Tobias Kienzler

これは、多かれ少なかれ Matlabマニュアル ;から解除されています。私は合格の経験しかありません...

function my_output = wave ( a, b, n, k, T, f, flag, varargin )
  optargin = numel(varargin);
  fTrue = inline('0');
  if optargin > 0
    fTrue = varargin{1};
  end
  % code ...
end
1
kyle

Matlabはこのためのメカニズムを提供していませんが、inputParserまたは「if nargin <1 ...」シーケンスよりも簡潔なユーザーランドコードで構築できます。

function varargout = getargs(args, defaults)
%GETARGS Parse function arguments, with defaults
%
% args is varargin from the caller. By convention, a [] means "use default".
% defaults (optional) is a cell vector of corresponding default values

if nargin < 2;  defaults = {}; end

varargout = cell(1, nargout);
for i = 1:nargout
    if numel(args) >= i && ~isequal(args{i}, [])
        varargout{i} = args{i};
    elseif numel(defaults) >= i
        varargout{i} = defaults{i};
    end
end

その後、次のように関数で呼び出すことができます。

function y = foo(varargin)
%FOO 
%
% y = foo(a, b, c, d, e, f, g)

[a, b,  c,       d, e, f, g] = getargs(varargin,...
{1, 14, 'dfltc'});

書式設定は、パラメータ名からデフォルト値まで読み取ることができる規則です。オプションのパラメーター型の指定（エラー検出または暗黙的な変換用）および引数カウント範囲でgetargs（）を拡張できます。

このアプローチには2つの欠点があります。まず、処理速度が遅いため、ループで呼び出される関数には使用したくないでしょう。第二に、Matlabの関数ヘルプ-コマンドラインのオートコンプリートのヒント-は、varargin関数では機能しません。しかし、それはかなり便利です。

1
Andrew Janke

matlabでparseparamsコマンドを使用したい場合があります。使用法は次のようになります。

function output = wave(varargin);
% comments, etc
[reg, props] = parseparams(varargin);
ctrls = cell2struct(props(2:2:end),props(1:2:end),2);  %yes this is ugly!
a = reg{1};
b = reg{2};
%etc
fTrue = ctrl.fTrue;
0
shabbychef
function f(arg1, arg2, varargin)

arg3 = default3;
arg4 = default4;
% etc.

for ii = 1:length(varargin)/2
  if ~exist(varargin{2*ii-1})
    error(['unknown parameter: ' varargin{2*ii-1}]);
  end;
  eval([varargin{2*ii-1} '=' varargin{2*ii}]);
end;

例えばf(2,4,'c',3)は、パラメーターcを3にします。

0
Tobias Kienzler

オクターブを使用する場合、このようにすることができます-しかし、悲しいことに、matlabはこの可能性をサポートしていません

function hello (who = "World")
  printf ("Hello, %s!\n", who);
endfunction

（ doc から取得）

0
wuschLOR

私はこれをいくらかオブジェクト指向の方法で行うのが好きです。 wave（）を呼び出す前に、いくつかの引数を構造体内に保存します。パラメーターと呼ばれるもの：

parameters.flag =42;
parameters.fTrue =1;
wave(a,b,n,k,T,f,parameters);

次に、波動関数内で、構造体パラメーターに 'flag'というフィールドが含まれているかどうかを確認し、含まれている場合はその値が空でないかどうかを確認します。次に、前に定義したデフォルト値、またはパラメータ構造体の引数として指定された値をさらに割り当てます。

function output = wave(a,b,n,k,T,f,parameters)
  flagDefault=18;
  fTrueDefault=0;
  if (isfield(parameters,'flag') == 0 || isempty(parameters.flag)),flag=flagDefault;else flag=parameters.flag; end
  if (isfield(parameter,'fTrue') == 0 || isempty(parameters.fTrue)),fTrue=fTrueDefault;else fTrue=parameters.fTrue; end
  ...
end

これにより、指定された引数の順序に依存しないため、多数の引数の処理が容易になります。そうは言っても、後で引数を追加する必要がある場合にも役立ちます。これは、関数のシグネチャを変更する必要がないためです。

0
CheshireCat